0.1.9 • Published 21 days ago

@tryghost/mg-beehiiv v0.1.9

Weekly downloads
-
License
MIT
Repository
github
Last release
21 days ago

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.

0.1.9

21 days ago

0.1.8

2 months ago

0.1.7

4 months ago

0.1.6

4 months ago

0.1.5

5 months ago

0.1.4

5 months ago

0.1.3

7 months ago

0.1.2

7 months ago

0.1.1

7 months ago

0.1.0

9 months ago