The Wayback Machine - https://web.archive.org/web/20220525052216/https://github.com/TryGhost/gctools
Skip to content
main
Switch branches/tags
10 branches 0 tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
.github/workflows
 
 
bin
 
 
commands
 
 
lib
 
 
prompts
 
 
tasks
 
 
test
 
 
.editorconfig
 
 
.eslintrc.js
 
 
.gitignore
 
 
LICENSE
 
 
README.md
 
 
package.json
 
 
renovate.json
 
 
yarn.lock
 
 
GCTools Install Usage Interactive Mode zip-split zip-create json-split fetch-images dedupe-members-csv random-posts delete-posts Add tags to posts Add public preview divider delete-tags delete-empty-tags find-replace change-author change-visibility delete-members Develop Copyright & License

README.md

GCTools

Command line utilities for working with Ghost content.

Install

  1. git clone this repo & cd into it as usual
  2. Run yarn to install top-level dependencies.
  3. To make gctools accessible globally, run yarn link

Usage

To see all available tools:

gctools

Interactive Mode

GCTools has an interactive mode which walks you through each tool, without needing to manually type multiple option flags.

gctools i

Available tools include:

  • Zip Split
  • Zip Create
  • JSON Split
  • Fetch Images
  • Deduplicate Members CSV
  • Add random posts
  • Delete posts
  • Add tags to posts
  • Add public preview divider
  • Delete tags
  • Delete empty tags
  • Find & Replace
  • Change Author
  • Change Visibility
  • Delete Members

Each of the tools also has a traditional CLI counterpart with more options, detailed below.

zip-split

Split a zip file into smaller zip files of a defined maximum size, while maintaining the directory structure.

# See all available options
gctools zip-split --help

# Split a zip file into as many files needed for them to all be 50mb or below
gctools zip-split /path/to/big-file.zip --M 50

zip-create

Split a large directory into smaller directories of a defined maximum size and zip each, while maintaining the directory structure.

# See all available options
gctools zip-create --help

# Split a large directory into as many files needed for them to all be 50mb or below
gctools zip-create /path/to/big-directory --M 50

json-split

Split a large JSON file into smaller JSON files of a defined maximum size, while retaining meta, tag, and author information.

# See all available options
gctools json-split --help

# Split a JSON file into as many files needed for them to hax a maximum of 50 posts per file
gctools json-split /path/to/big-file.json --M 50

fetch-images

Download all available images from a valid Ghost JSON file create a JSON file with updated image references

# See all available options
gctools fetch-images --help

# Fetch images from a valid Ghost JSON file, with `https://example.com` as the base URL
gctools fetch-images /path/to/file.json https://example.com

dedupe-members-csv

Create new CSV files that only contain new or updated members, by comparing the existing members with the output from the output from @tryghost/migrate.

# See all available options
gctools dedupe-members-csv --help

gctools dedupe-members-csv <existing-members> [new-free] [new-comp] [new-paid]

random-posts

Insert a number of posts with random content.

# See all available options
gctools random-posts --help

# Create and insert 10 random posts
gctools random-posts <apiURL> <adminAPIKey>

# Create and insert 3000 random draft posts with 2 tags visible to members only, written by a specific author
gctools random-posts <apiURL> <adminAPIKey> --count 3000 --tag '#random,New World' --status draft --visibility members --userEmail person@dummyemail.com

delete-posts

Delete all content or content with a specific set of filters, which can be combined.

# See all available options
gctools delete-posts --help

# Delete all posts (⛔️ dangerous!)
gctools delete-posts <apiURL> <adminAPIKey>

# Delete all posts with a specific tag
gctools delete-posts <apiURL> <adminAPIKey> --tag 'hash-testing'

# Delete all posts by a specific author
gctools delete-posts <apiURL> <adminAPIKey> --author 'sample-user'

# Delete all posts by a specific author with a specific tag
gctools delete-posts <apiURL> <adminAPIKey> --author 'sample-user' --tag '#testing'

Add tags to posts

Add a tag to specific posts with a specific set of filters

# Add a tag of 'Testing' to all posts
gctools add-tags <apiURL> <adminAPIKey> --new_tags 'Testing'

# Add a tag of 'Testing' to all public posts
gctools add-tags <apiURL> <adminAPIKey> --visibility public --new_tags 'Testing'

# Add a tag of 'Testing' to all members-only posts that also have a tag of 'hello'
gctools add-tags <apiURL> <adminAPIKey> --visibility public --tag 'hello' --new_tags 'Testing'

# Add a tag of 'Testing' to all members-only posts that also have a tag of 'hello', and are by written by 'harry'
gctools add-tags <apiURL> <adminAPIKey> --visibility public --tag 'hello' --author 'harry' --new_tags 'Testing'

Add public preview divider

Insert a public preview divider at a specific point, after the previewPosition number.

# Add a divider to all posts as position 2
gctools add-preview <apiURL> <adminAPIKey> --previewPosition 2

# Add a divider to all posts as position 2 for members-only posts
gctools add-preview <apiURL> <adminAPIKey> --visibility members --previewPosition 2

# Add a divider to all posts as position 2 for paid posts
gctools add-preview <apiURL> <adminAPIKey> --visibility paid --previewPosition 2

# Add a divider to all posts as position 2 for paid posts that also have a tag of `hello`
gctools add-preview <apiURL> <adminAPIKey> --visibility paid --tag hello --previewPosition 2

# Add a divider to all posts as position 2 for paid posts that also have a tag of `hello`, and are by written by `harry`
gctools add-preview <apiURL> <adminAPIKey> --visibility paid --tag hello --author harry --previewPosition 2

delete-tags

Delete tags, but not the content that uses that tag

# See all available options
gctools delete-tags --help

# Delete a specific tag or multiple tags
gctools delete-tags <apiURL> <adminAPIKey> --tag '#gctools, Test 1'

delete-empty-tags

Delete tags that have no associated posts

# See all available options
gctools delete-empty-tags --help

# Delete a specific tag or multiple tags
gctools delete-empty-tags <apiURL> <adminAPIKey>

find-replace

Find & replace strings of text within Ghost posts

# See all available options
gctools find-replace --help

# Replace a string but only in the `mobiledoc` and `title`
gctools find-replace <apiURL> <adminAPIKey> --find 'Old text' --replace 'New text' --where mobiledoc,title

# Replace a string in all available fields
gctools find-replace <apiURL> <adminAPIKey> --find 'Old text' --replace 'New text' --where all

Available where fields are:

  • all
  • mobiledoc (default)
  • title
  • slug
  • custom_excerpt
  • meta_title
  • meta_description
  • twitter_title
  • twitter_description
  • og_title
  • og_description

change-author

Change the author assigned to a post

# See all available options
gctools change-author --help

# Change the posts written by `richard` and assign to `michael`
gctools change-author <apiURL> <adminAPIKey> --author `richard` --new_author `michael`

change-visibility

Change the visibility of posts

# See all available options
gctools change-visibility --help

# Change the posts that are currently public to be members-only
gctools change-visibility <apiURL> <adminAPIKey> --visibility `public` --new_visibility `members`

# Change the posts that are currently members-only to be paid-members only
gctools change-visibility <apiURL> <adminAPIKey> --visibility `members` --new_visibility `paid`

# Change the posts tagged with 'news' to be paid-members only
gctools change-visibility <apiURL> <adminAPIKey> --tag `news` --new_visibility `paid`

# Change the posts tagged with 'news', and written by 'jane' to be paid-members only
gctools change-visibility <apiURL> <adminAPIKey> --tag `news` --author `jane` --new_visibility `paid`

delete-members

Delete all members

# See all available options
gctools delete-members --help

# Change the posts written by `richard` and assign to `michael`
gctools delete-members <apiURL> <adminAPIKey>

Develop

  • commands handles the traditional CLI input
  • tools handles the interactive CLI input
  • tasks is the tasks run by both the CLI and interactive tool

Copyright & License

Copyright (c) 2013-2022 Ghost Foundation - Released under the MIT license.

About

Command line utilities for working with Ghost content

Resources

Readme

License

MIT license

Stars

9 stars

Watchers

2 watching

Forks

1 fork

Releases

No releases published

Sponsor this project

  •  
Learn more about GitHub Sponsors

Packages

No packages published

Contributors 7

Languages