@tryghost/mg-beehiiv

Migrate beehiiv csv Export

Converts a beehiiv csv export and generates a zip 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-beehiiv --save

or

yarn add @tryghost/mg-beehiiv

Usage

To run basic beehiiv migration, the required command is this:

migrate beehiiv --posts /path/to/posts.csv --url https://example.com

A more complex command for a beehiiv migration looks like this:

migrate beehiiv --posts /path/to/posts.csv --url https://example.com --default_author_name 'Author Name' --subscribeLink '/join'

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

• --posts (required)
  • Path to a zip file
  • string - default: null
• --url (required)
  • Site URL
  • string - default: null
• --defaultAuthorName
  • The name to use where no author is specified. Names with spaces should be quoted.
  • string - default: null
• -s --scrape
  • Configure scraping tasks
  • string - default: all
  • Choices: all, img, web, media, files, none
• --subscribeLink
  • Provide a path that existing /subscribe anchors will link to e.g. /join-us or #/portal/signup (# characters need to be escaped with a \)
  • string - default: #/portal/signup
• --fallBackHTMLCard
  • Fall back to convert to HTMLCard, if standard Mobiledoc convert fails
  • bool - default: true
• --cache
  • Persist local cache after migration is complete (Only if --zip is true)
  • bool - default: true
• -V --verbose
  • Show verbose output
  • bool - default: false
• --zip
  • Create a zip file
  • bool - default: true

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 beehiiv <commands>

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.