Ghost-CLI - A fully loaded tool for installation and configuration
The best way to install, manage, and update your site locally or when self-hosting Ghost. A full guide for our advanced CLI tool.
A fully loaded tool to help you get Ghost installed and configured and to make it super easy to keep your Ghost install up to date.
The main aim of the Ghost-CLI is to make it possible to install or update Ghost in a single command.
We understand that some users are going to want more flexibility, so the CLI has a whole host of flags and options that allow you to break the steps down and adjust what they do.
We hope you love using this new approach to tooling. If you have any suggestions or find bugs
Install & Update
Ghost-CLI is an npm module that can be installed via either npm or yarn.
# On a production server using a non-root user: sudo npm install -g ghost-cli@latest # or sudo yarn global add ghost-cli@latest
Locally, you likely don't need sudo. Using
@latest means this command with either install or update ghost-cli and you only have to remember the one command for both
There are some global flags you may find useful when using
# Output usage information for Ghost-CLI ghost --help, ghost -h, ghost help, ghost [command] --help # Enables the verbose logging output for debugging ghost --verbose, ghost -V # Print your CLI version and Ghost version ghost --version, ghost -v, ghost version # Run the command in a different directory ghost --dir path/to/directory # Runs command without asking for any input ghost --no-prompt # Runs command without using colours ghost --no-color
Each command is documented in detail on its own page.
You can always run
ghost --help or
ghost [command] --help to get more detail.
- ghost config
- ghost doctor
- ghost help
- ghost install
- ghost log
- ghost ls
- ghost setup
- ghost start
- ghost stop
- ghost restart
- ghost run
- ghost update
- ghost uninstall
The rest of this documentation walks you through the commands and utilities of
ghost-cli and can be referenced at any time when working with the tool. Navigate the left hand menu to find the information you're looking for. For more advanced CLI information, check out the knowledge base.