Converts a Mailchimp members `csv` export and generates a `csv` file you can import into a Ghost installation.
npm install @tryghost/mg-mailchimp-memberscsv ExportConverts a Mailchimp members csv export and generates a csv file you can import into a Ghost installation.
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-mailchimp-members --save
or
yarn add @tryghost/mg-mailchimp-members
To run basic Mailchimp member migration, the required command is this:
`sh`
migrate mailchimp-members --pathToCsv /path/to/members.csv
A more complex command for a Mailchimp member migration looks like this:
`sh`
migrate mailchimp-members --pathToCsv /path/to/members.csv, /path/to/another-members.csv --addLabel 'Migrated' --includeUnsubscribed false --verbose true
It's possible to pass more options, in order to achieve a better migration file for Ghost:
- --pathToZip (required)
- Path to members ZIP file
- string - default: null--pathToCsv
- (required)null
- Path to members CSV file
- array - default: --addLabel
- null
- Label to add to all members
- string - default: --includeUnsubscribed
- false
- Include unsubscribed members in the migration, but set to not receive emails
- bool - default: --cache
- --zip
- Persist local cache after migration is complete (Only if is true)true
- bool - default: -V
- --verbose false
- Show verbose output
- bool - default: --zip
- false
- Create a zip file
- bool - default:
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 usualyarn
2. Run to install top-level dependencies.
To run a local development copy, cd into this directory, and use yarn dev instead of migrate like so:
`sh`
yarn dev mailchimp-members
- yarn lint run just eslintyarn test` run lint and tests
-
Copyright (c) 2013-2026 Ghost Foundation - Released under the MIT license.