# @tryghost/mg-revue-api

> Export content from Revue using their API, and generate a `zip` file you can import into a Ghost installation.

Latest version **0.4.6** (published 2023-01-10) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @tryghost/mg-revue-api
pnpm add @tryghost/mg-revue-api
yarn add @tryghost/mg-revue-api
bun add @tryghost/mg-revue-api
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.4.6 |
| Published | 2023-01-10 |
| First published | 2020-08-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 5 |
| Unpacked size | 16.4 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 70 |
| Author | Ghost Foundation |
| Maintainers | jonhickman, lenabaidakova, kernalghost, hadret, minimaluminium, ronaldlangeveld, simonbackx, joeegrigg, sanne-san, djordjevlais, bobvaneck, zimoatghost, allouis, gargol, rishabhgrg, erisds, johnonolan, kevinansfield, cobbspur, aileencgn, jloh, daniellockyer, sam-lord, pauladamdavis |

## Links

- npm: https://www.npmjs.com/package/@tryghost/mg-revue-api
- Repository: https://github.com/TryGhost/migrate.git#main
- Homepage: https://github.com/TryGhost/migrate/tree/main#readme
- Issues: https://github.com/TryGhost/migrate/issues
- npm.io page: https://npm.io/package/@tryghost/mg-revue-api

## Dependencies (5)

- [got](https://npm.io/package/got.md) 11.8.6
- [uuid](https://npm.io/package/uuid.md) 9.0.0
- [cheerio](https://npm.io/package/cheerio.md) 0.22.0
- [@tryghost/errors](https://npm.io/package/@tryghost/errors.md) 1.2.20
- [@tryghost/string](https://npm.io/package/@tryghost/string.md) ^0.2.0

## Recent versions

- 0.4.6 (latest) — 2023-01-10
- 0.4.5 — 2023-01-03
- 0.4.4 — 2022-12-11
- 0.4.3 — 2022-12-09
- 0.4.2 — 2022-11-15
- 0.4.1 — 2022-11-10
- 0.4.0 — 2022-11-08
- 0.3.5 — 2022-11-08
- 0.3.4 — 2022-11-02
- 0.3.3 — 2022-10-26
- 0.3.2 — 2022-10-17
- 0.3.1 — 2022-10-15
- 0.3.0 — 2022-10-11
- 0.2.24 — 2022-09-15
- 0.2.23 — 2022-08-17
- … 23 more at https://npm.io/package/@tryghost/mg-revue-api/versions

## README

# Migrate Revue Api

Export content from Revue using their API, and generate a `zip` file you can import into a Ghost installation.

The token can be found on the [integrations page](https://www.getrevue.co/app/integrations) when logged in.


## Install

To install the CLI, which is required for the Usage commands below:

```sh
npm install --global @tryghost/migrate
```

To use this package in your own project:

`npm install @tryghost/mg-revue-api --save`

or

`yarn add @tryghost/mg-revue-api`


## Usage


To run a Ghost API migration, the required command is:

```sh
migrate revue --apiToken <API token>
```

It's possible to pass more options, in order to achieve a better migration file for Ghost:

- **`--apiToken`**
    - string - default: `null`
    - Revue API Token
- **`-V` `--verbose`**
    - bool - default: `false`
    - Show verbose output
- **`--zip`**
    - bool - default: `true`
    - Create a zip file
- **`-s` `--scrape`** 
    - Configure scraping tasks
    - string - default: `all` 
    - Choices: `all`, `img`, `web`, `media`, `files`, `none`
- **`--sizeLimit`**
    - number - default: `false`
    - Media files larger than this size (defined in MB [i.e. `5`]) will be flagged as oversize
- **`--addPrimaryTag`**
    - string - default: `null`
    - Provide a tag name which should be added to every post as primary tag
- **`-e` `--email`**
    - string - default: `null`
    - Provide an email for users e.g. test@example.com to create a general author for the posts
- **`--createAuthors`**
    - bool - default: `true`
    - Create authors based on data from Revue
- **`-I` `--info`**
    - bool - default: `false`
    - Show initalisation info only
- **`--fallBackHTMLCard`**
    - bool - default: `false`
    - Fall back to convert to HTMLCard, if standard Mobiledoc convert fails
- **`--cache`** 
    - Persist local cache after migration is complete (Only if `--zip` is `true`)
    - bool - default: `true`

A more complex migration command could look like this:

```sh
migrate revue --apiToken <API token> --email test@example.com --addPrimaryTag News
```

This will get all posts, apply the tag 'News', and all posts will be by author test@example.com


## Develop

This is a mono repository, managed with [lerna](https://lerna.js.org).

Follow the instructions for the top-level repo.
1. `git clone` this repo & `cd` into it as usual
2. Run `yarn` to install top-level dependencies.


## Run

To run a local development copy, `cd` into this directory, and use `yarn dev` instead of `migrate` like so:

```sh
yarn dev revue <API token>
```


## Test

- `yarn lint` run just eslint
- `yarn test` run lint and tests


# Copyright & License

Copyright (c) 2013-2022 Ghost Foundation - Released under the [MIT license](LICENSE).

---
_Source: https://npm.io/package/@tryghost/mg-revue-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._