Converts a beehiiv 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:
npm install --global @tryghost/migrate
To use this package in your own project:
npm install @tryghost/mg-beehiiv-members --save
or
yarn add @tryghost/mg-beehiiv-members
To run basic beehiiv member migration, the required command is this:
migrate beehiiv-members --pathToCsv /path/to/members.csv
A more complex command for a beehiiv member migration looks like this:
migrate beehiiv-members --pathToCsv /path/to/members.csv --verbose true
It's possible to pass more options, in order to achieve a better migration file for Ghost:
-
--pathToCsv
(required)- Path to members CSV file
- string - default:
null
-
--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
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.
To run a local development copy, cd
into this directory, and use yarn dev
instead of migrate
like so:
yarn dev beehiiv <commands>
-
yarn lint
run just eslint -
yarn test
run lint and tests
Copyright (c) 2013-2023 Ghost Foundation - Released under the MIT license.