We designed the Command Line Interface (CLI) to be a helpful Calibre companion for performing simple tasks in your terminal. Check the code on GitHub or npm.
We recommend using the Node.js API for more complex tasks. However, the CLI is powerful and should not be underestimated for scripting requirements. Here are some examples to get you started:
- Automating Snapshots
- Automating Deployments
- Pull Request Reviews
- Retrieving Metrics
- Single Page Tests
- Managing Sites
For a comprehensive guide to individual features of the Command Line Interface, browse the CLI and API pages found in the left-hand side navigation or read through the complete list of commands below. You can also see the commands list directly on GitHub.
Installation#
CLI requires the latest LTS version of Node.js and is distributed exclusively using npm. You can use npx to run CLI without installing it.
npx calibre <subcommand>npm install calibre --saveStaying up to date#
CLI will notify you when new releases are available. We recommend always using the latest version to ensure access to the latest features, bug fixes and security patches.
Check all version numbers on the Calibre npm package page.
All commands#
For the complete list of CLI commands, see the CLI Commands reference on GitHub.