@tryghost/mg-curated-members-csv v0.4.19

Curated Ghost CSV Converter

Converts the "Subscribers" CSV export from Curated to a CSV compatible with Ghost.

Install

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

npm install --global @tryghost/migrate

To use this package in your own project:

npm install @tryghost/mg-curated-members-csv --save

or

yarn add @tryghost/mg-curated-members-csv

Usage

To run a Curated CSV migration, the required command is:

migrate curated-members --pathToFile /path/to/emails.csv

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

• --pathToFile (required)
  • Path to the signups CSV file as generated by Curated
  • string - default: null
• -V --verbose
  • Show verbose output
  • bool - default: false
• -l --limit
  • Define the batch limit for import files
  • int - default: 5000
• --freeLabel
  • Provide a label for Curated free subscribers
  • string - default: curated-free
• --cache
  • Persist local cache after migration is complete (Only if --zip is true)
  • bool - default: true

A more complex migration command that accounts for Stripe data could look like this:

migrate curated-members emails.csv --freeLabel Newsletter --limit 1000

Develop

This is a mono repository, managed with lerna.

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:

yarn dev curated-members --pathToFile /path/to/emails.csv

Test

• yarn lint run just eslint
• yarn test run lint and tests

Copyright & License

Copyright (c) 2013-2023 Ghost Foundation - Released under the MIT license.