@tryghost/mg-mailchimp-members
v0.4.9
Published
Converts a Mailchimp members `csv` export and generates a `csv` file you can import into a Ghost installation.
Downloads
120
Maintainers
Keywords
Readme
Migrate Mailchimp Members csv
Export
Converts a Mailchimp members csv
export and generates a csv
file you can import into a Ghost installation.
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-mailchimp-members --save
or
yarn add @tryghost/mg-mailchimp-members
Usage
To run basic Mailchimp member migration, the required command is this:
migrate mailchimp-members --pathToCsv /path/to/members.csv
A more complex command for a Mailchimp member migration looks like this:
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)- Path to members CSV file
- array - default:
null
--addLabel
- Label to add to all members
- string - default:
null
--includeUnsubscribed
- Include unsubscribed members in the migration, but set to not receive emails
- bool - default:
false
--cache
- Persist local cache after migration is complete (Only if
--zip
istrue
) - bool - default:
true
- Persist local cache after migration is complete (Only if
-V
--verbose
- Show verbose output
- bool - default:
false
--zip
- Create a zip file
- bool - default:
false
Develop
This is a mono repository, managed with lerna.
Follow the instructions for the top-level repo.
git clone
this repo &cd
into it as usual- 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 mailchimp-members <commands>
Test
yarn lint
run just eslintyarn test
run lint and tests
Copyright & License
Copyright (c) 2013-2023 Ghost Foundation - Released under the MIT license.