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:
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 below. You can also see the commands list directly on GitHub.
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.
1npx calibre <subcommand>
1npm install calibre --save
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.
Add a Site for Calibre to monitor.
The URL of the Site.
Choose the location for the test.
The identifying slug of the Team.
Set the schedule for automated Snapshots. Available options: hourly, daily, every_x_hours.
Default: every_x_hours
Set the Snapshot interval. Provide UTC hour (between 0 and 23) for daily Snapshots and numeric hour interval for every_x_hours option (between 1 and 168 hours).
Default: 6
Outputs the results of the command in JSON format.
List all Sites you are tracking in Calibre.
Outputs the results of the command in JSON format.
Download the artifacts of a Snapshot to ./snapshot-artifacts/<id>. Includes: lighthouse.json, render progress screenshots, render progress MP4 video, HAR file (request log) and all other metrics and data available through the Calibre interface.
A unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.
The id of the Snapshot.
Outputs the results of the command in JSON format.
Get all metrics of a given Snapshot.
A unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.
The id of a Snapshot.
Outputs the results of the command in JSON format.
Outputs the results of the command in CSV format.
Get time-series metrics for a selected Site.
A unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.
A list of Page UUIDs to return metrics for. You can separate multiple Pages by a space or use multiple --pages flags.
A list of Test Profile UUIDs to return metrics for. You can separate multiple Test Profiles by a space or use multiple --profiles flags.
A list of metric UUIDs to return metrics for. You can separate multiple metrics by a space or use multiple --metrics flags.
Outputs the results of the command in JSON format.
Outputs the results of the command in CSV format.
The start date to retrieve data from in the Year-Month-Day format (default: 7 days ago).
The end date to retrieve data from in the Year-Month-Day format (default: today).
Get the last 30 days of metrics. Without this flag, CLI will use the to and from values.
List all deployments for a Site.
A unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.
The number of items to return (default: 25, maximum: 500).
Default: 25
The cursor to fetch records after
Outputs the results of the command in JSON format.
Create a deployment.
A unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.
The source control revision id of the code you are deploying. It could be a git hash or a tag name.
The base URL of the repository containing the source code being deployed (e.g. https://github.com/calibreapp/app).
The username of who deployed the code.
Outputs the results of the command in JSON format.
Delete a deploy from a selected Site.
A unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.
The UUID of the deploy.
Use this flag to confirm the deletion of the selected deploy.
Outputs the results of the command in JSON format.
List Pages for a selected Site.
A unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.
The number of items to return (default: 25, maximum: 500).
Default: 25
The cursor to fetch records after
Outputs the results of the command in JSON format.
Add a Page to an existing Site tracked by Calibre.
A unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.
The URL of the Page.
Outputs the results of the command in JSON format.
Update the name or URL of a Page.
The UUID of the Page.
Update the name of the Page.
Update the URL of the Page.
A unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.
Outputs the results of the command in JSON format.
Delete a Page from a selected Site.
A unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.
The UUID of the Page.
Use this flag to confirm the deletion of the selected Page.
Outputs the results of the command in JSON format.
List selected Snapshots for a Site.
A unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.
The number of items to return (default: 25, maximum: 500).
Default: 25
The cursor to fetch records after
Outputs the results of the command in JSON format.
Create a Snapshot.
A unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.
Set a reference to the Snapshot.
Outputs the results of the command in JSON format.
Delete a Snapshot from a selected Site.
A unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.
The id of the Snapshot.
Use this flag to confirm the deletion of the selected Snapshot.
Outputs the results of the command in JSON format.
List all Test Profiles for a Site.
A unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.
Outputs the results of the command in JSON format.
Add a Test Profile to a Site.
A unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.
Choose the emulated test device.
Default: Desktop
Choose the emulated network connection speed.
Turn JavaScript execution on or off.
Default:
Turn adblocking on or off.
Set cookies by specifying a path to a Netscape formatted cookie jar file.
Outputs the results of the command in JSON format.
Update Test Profile settings. Only changes specified attributes.
The UUID of the Test Profile.
Set the emulated device.
Set the emulated network connection speed.
A unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.
Outputs the results of the command in JSON format.
Turn JavaScript execution on or off
Default:
Turn adblocking on or off.
Set cookies by specifying a path to a Netscape formatted cookie jar file.
Delete a Test Profile from a Site.
A unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.
The UUID of the Test Profile.
Use this flag to confirm the deletion of the selected Test Profile.
Outputs the results of the command in JSON format.
Create a Pull Request Review of a preview deployment.
e.g. "My Pull Request"
A unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.
The base URL of the preview deployment (e.g.: https://my-pull-request-123.example.com).
The branch of the preview deployment. e.g.: "my-pull-request-123".
The source control revision of the deployed code. e.g.: 9c72279.
Path to a Calibre YAML config file.
Wait for pull request to be evaluated before returning.
Return a command failure if any existing budget is exceeded. (Requires --waitForResult to be set.)
Outputs the results of the command in JSON format.
Outputs the results of the command in Markdown format.
List Pull Request Reviews for a selected Site.
A unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.
Outputs the results of the command in JSON format.
See the results of a Pull Request Review.
A unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.
Outputs the results of the command in JSON format.
Outputs the results of the command in Markdown format.
List Teams based on API Token access. For Admin Tokens, this will list all teams or as specified based on your settings. For Personal Access Tokens, this will list Teams that you have access to.
Outputs the results of the command in JSON format.
Run a Single Page Test against any public URL.
Choose the emulated test device.
Choose the location for the test.
Choose the emulated network connection speed.
Test result JSON will be sent to this URL using HTTP POST.
Secret used to sign the webhook payload. Secret can be validated using `Calibre-HMAC-SHA256-Signature` HTTP header. See https://calibreapp.com/docs/integrations/webhooks#webhook-security-and-verification for more information.
Turn adblocking on or off.
Make the results of a test private (only accessible by members of your Calibre organisation).
Set a future UTC date time string (ISO8601). After this date, the test will be automatically deleted. (Min=24 hrs, Max=2 years) e.g.: 2025-12-31T23:59:59Z
Default: 2026-09-05T18:21:54.665Z
Set cookies by specifying a path to a Netscape formatted cookie jar file.
Set HTTP headers by providing a path to a JSON file or a valid JSON key-value pairs.
Outputs the results of the command in JSON format.
Outputs the results of the command in Markdown format.
Wait for the test to complete before showing the results (default: test result link is shown immediately).
Download the artifacts of a test to ./test-artifacts/<uuid>. Includes: lighthouse.json, render progress screenshots, render progress MP4 video, HAR file (request log) and all other metrics and data available through the Calibre interface.
Outputs the results of the command in JSON format.
List recent Single Page Tests (includes UUID, URL, device, connection, test location and status).
Outputs the results of the command in JSON format.
See the results of a Single Page Test (also as outputted by the test create command).
Outputs the results of the command in JSON format.
Outputs the results of the command in Markdown format.
List all available network connection speeds.
Outputs the results of the command in JSON format.
List all available test devices.
Outputs the results of the command in JSON format.
List all available test locations.
Outputs the results of the command in JSON format.
List all available web performance metrics.
Outputs the results of the command in JSON format.
Store your API Token to use the CLI (saved in ~/.config/configstore/calibre.json).
Remove the saved API Token used for CLI commands (from ~/.config/configstore/calibre.json).
Use the request command to make a request to the Calibre GraphQL API.
Pass a GraphQL query to execute.
Pass query variables as named arguments. e.g.: `calibre request --query "$(cat query.gql)" --foo="example" --bar="example"`
On this page