Command Line Client (CLI)


We designed the Command Line Client (CLI) to be a helpful Calibre companion for performing simple tasks in your terminal. See 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:

For a comprehensive guide to individual features of the Command Line Interface, browse the Automation pages found in the left-hand side navigation or read through the complete list of commands. You can also see the commands list directly on GitHub.

Installation

CLI is distributed exclusively using NPM. Install it by running the following command:

1npm install -g calibre

Staying up to date

CLI uses an update-notifier to notify when new releases are available. You will see available update notifications when using CLI.

Alternate installation methods (deprecated)

Caution
As of version 5.0.0 onwards, standalone binary builds of the CLI are deprecated. You can still download the previous versions, but we recommend using npm to benefit from CLI improvements.

We provide a legacy binary build of CLI useful for CI/CD pipelines, running in Docker or other environments when you don’t have a Node runtime available. Binary builds bundle Node.js, so there is no need for a JavaScript runtime on the target system.

Latest binary release

1https://download.calibreapp.com/cli/latest/mac.tar.bz2
1https://download.calibreapp.com/cli/latest/windows.zip
1https://download.calibreapp.com/cli/latest/linux.tar.bz2

Older binary releases

We recommend staying up to date where possible but understand that you may want to pin to a version for automation. For example, a URL for the 4.2.0 release would be:

1https://download.calibreapp.com/cli/4.2.0/mac.tar.bz2
1https://download.calibreapp.com/cli/4.2.0/windows.zip
1https://download.calibreapp.com/cli/4.2.0/linux.tar.bz2

See all version numbers on the Calibre NPM package page.