CLI Command Reference

On this page

calibre site#

calibre site create#

Add a Site for Calibre to monitor.

calibre site create <name> [options]
OptionDescriptionRequiredDefault
--urlThe URL of the Site.Yes
--locationChoose the location for the test.Yes
--teamThe identifying slug of the Team.
--scheduleSet the schedule for automated Snapshots. Available options: hourly, daily, every_x_hours.every_x_hours
--intervalSet 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).6
--jsonOutputs the results of the command in JSON format.

calibre site list#

List all Sites you are tracking in Calibre.

calibre site list
OptionDescriptionRequiredDefault
--jsonOutputs the results of the command in JSON format.

calibre site delete#

Delete a selected Site.

calibre site delete <slug> [options]
OptionDescriptionRequiredDefault
--confirmUse this flag to confirm the deletion of the selected Site.
--jsonOutputs the results of the command in JSON format.

calibre synthetic#

calibre synthetic pages#

List Pages for a selected Site.

calibre synthetic pages [options]
OptionDescriptionRequiredDefault
--siteA unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.Yes
--countThe number of items to return (default: 25, maximum: 500).25
--cursorThe cursor to fetch records after
--jsonOutputs the results of the command in JSON format.

calibre synthetic create-page#

Add a Page to an existing Site tracked by Calibre.

calibre synthetic create-page <name> [options]
OptionDescriptionRequiredDefault
--siteA unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.Yes
--urlThe URL of the Page.Yes
--jsonOutputs the results of the command in JSON format.

calibre synthetic update-page#

Update the name or URL of a Page.

calibre synthetic update-page [options]
OptionDescriptionRequiredDefault
--uuidThe UUID of the Page.Yes
--nameUpdate the name of the Page.
--urlUpdate the URL of the Page.
--siteA unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.Yes
--jsonOutputs the results of the command in JSON format.

calibre synthetic delete-page#

Delete a Page from a selected Site.

calibre synthetic delete-page [options]
OptionDescriptionRequiredDefault
--siteA unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.Yes
--uuidThe UUID of the Page.Yes
--confirmUse this flag to confirm the deletion of the selected Page.
--jsonOutputs the results of the command in JSON format.

calibre synthetic snapshots#

List selected Snapshots for a Site.

calibre synthetic snapshots [options]
OptionDescriptionRequiredDefault
--siteA unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.Yes
--countThe number of items to return (default: 25, maximum: 500).25
--cursorThe cursor to fetch records after
--jsonOutputs the results of the command in JSON format.

calibre synthetic create-snapshot#

Create a Snapshot.

calibre synthetic create-snapshot [options]
OptionDescriptionRequiredDefault
--siteA unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.Yes
--refSet a reference to the Snapshot.
--jsonOutputs the results of the command in JSON format.

calibre synthetic delete-snapshot#

Delete a Snapshot from a selected Site.

calibre synthetic delete-snapshot [options]
OptionDescriptionRequiredDefault
--siteA unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.Yes
--idThe id of the Snapshot.Yes
--confirmUse this flag to confirm the deletion of the selected Snapshot.
--jsonOutputs the results of the command in JSON format.

calibre synthetic download-artifacts#

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.

calibre synthetic download-artifacts [options]
OptionDescriptionRequiredDefault
--siteA unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.Yes
--idThe id of the Snapshot.Yes
--jsonOutputs the results of the command in JSON format.

calibre synthetic get-snapshot-metrics#

Get all metrics of a given Snapshot.

calibre synthetic get-snapshot-metrics [options]
OptionDescriptionRequiredDefault
--siteA unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.Yes
--snapshotThe id of a Snapshot.Yes
--jsonOutputs the results of the command in JSON format.
--csvOutputs the results of the command in CSV format.

calibre synthetic metrics#

Get time-series metrics for a selected Site.

calibre synthetic metrics [options]
OptionDescriptionRequiredDefault
--siteA unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.Yes
--pagesA list of Page UUIDs to return metrics for. You can separate multiple Pages by a space or use multiple --pages flags.
--profilesA list of Test Profile UUIDs to return metrics for. You can separate multiple Test Profiles by a space or use multiple --profiles flags.
--metricsA list of metric UUIDs to return metrics for. You can separate multiple metrics by a space or use multiple --metrics flags.
--jsonOutputs the results of the command in JSON format.
--csvOutputs the results of the command in CSV format.
--fromThe start date to retrieve data from in the Year-Month-Day format (default: 7 days ago).
--toThe end date to retrieve data from in the Year-Month-Day format (default: today).
--30-dayGet the last 30 days of metrics. Without this flag, CLI will use the to and from values.

calibre synthetic test-profiles#

List all Test Profiles for a Site.

calibre synthetic test-profiles [options]
OptionDescriptionRequiredDefault
--siteA unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.Yes
--jsonOutputs the results of the command in JSON format.

calibre synthetic create-test-profile#

Add a Test Profile to a Site.

calibre synthetic create-test-profile <name> [options]
OptionDescriptionRequiredDefault
--siteA unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.Yes
--deviceChoose the emulated test device.Desktop
--connectionChoose the emulated network connection speed.
--javascriptTurn JavaScript execution on or off.true
--cookie-jarSet cookies by specifying a path to a Netscape formatted cookie jar file.
--jsonOutputs the results of the command in JSON format.

calibre synthetic update-test-profile#

Update Test Profile settings. Only changes specified attributes.

calibre synthetic update-test-profile [options]
OptionDescriptionRequiredDefault
--uuidThe UUID of the Test Profile.Yes
--deviceSet the emulated device.
--connectionSet the emulated network connection speed.
--siteA unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.Yes
--jsonOutputs the results of the command in JSON format.
--javascriptTurn JavaScript execution on or offtrue
--cookie-jarSet cookies by specifying a path to a Netscape formatted cookie jar file.

calibre synthetic delete-test-profile#

Delete a Test Profile from a Site.

calibre synthetic delete-test-profile [options]
OptionDescriptionRequiredDefault
--siteA unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.Yes
--uuidThe UUID of the Test Profile.Yes
--confirmUse this flag to confirm the deletion of the selected Test Profile.
--jsonOutputs the results of the command in JSON format.

calibre synthetic pull-request-reviews#

List Pull Request Reviews for a selected Site.

calibre synthetic pull-request-reviews [options]
OptionDescriptionRequiredDefault
--siteA unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.Yes
--jsonOutputs the results of the command in JSON format.

calibre synthetic create-pull-request-review#

Create a Pull Request Review of a preview deployment.

calibre synthetic create-pull-request-review [options]
OptionDescriptionRequiredDefault
--titlee.g. "My Pull Request"Yes
--siteA unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.Yes
--urlThe base URL of the preview deployment (e.g.: https://my-pull-request-123.example.com).Yes
--branchThe branch of the preview deployment. e.g.: "my-pull-request-123".Yes
--shaThe source control revision of the deployed code. e.g.: 9c72279.Yes
--configPathPath to a Calibre YAML config file.
--waitForResultWait for pull request to be evaluated before returning.false
--failOnUnmetBudgetReturn a command failure if any existing budget is exceeded. (Requires --waitForResult to be set.)false
--jsonOutputs the results of the command in JSON format.
--markdownOutputs the results of the command in Markdown format.

calibre synthetic pull-request-review#

See the results of a Pull Request Review.

calibre synthetic pull-request-review <branch>
OptionDescriptionRequiredDefault
--siteA unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.Yes
--jsonOutputs the results of the command in JSON format.
--markdownOutputs the results of the command in Markdown format.

calibre synthetic connections#

List all available network connection speeds.

calibre synthetic connections
OptionDescriptionRequiredDefault
--jsonOutputs the results of the command in JSON format.

calibre synthetic devices#

List all available test devices.

calibre synthetic devices
OptionDescriptionRequiredDefault
--jsonOutputs the results of the command in JSON format.

calibre synthetic locations#

List all available test locations.

calibre synthetic locations
OptionDescriptionRequiredDefault
--jsonOutputs the results of the command in JSON format.

calibre deploy#

calibre deploy list#

List all deployments for a Site.

calibre deploy list [options]
OptionDescriptionRequiredDefault
--siteA unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.Yes
--countThe number of items to return (default: 25, maximum: 500).25
--cursorThe cursor to fetch records after
--jsonOutputs the results of the command in JSON format.

calibre deploy create#

Create a deployment.

calibre deploy create [options]
OptionDescriptionRequiredDefault
--siteA unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.Yes
--revisionThe source control revision id of the code you are deploying. It could be a git hash or a tag name.
--repositoryThe base URL of the repository containing the source code being deployed (e.g. https://github.com/calibreapp/app).
--usernameThe username of who deployed the code.
--jsonOutputs the results of the command in JSON format.

calibre deploy delete#

Delete a deploy from a selected Site.

calibre deploy delete [options]
OptionDescriptionRequiredDefault
--siteA unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.Yes
--uuidThe UUID of the deploy.Yes
--confirmUse this flag to confirm the deletion of the selected deploy.
--jsonOutputs the results of the command in JSON format.

calibre crux#

calibre crux summary#

Display Chrome UX Report (CrUX) origin-level performance data and Core Web Vitals assessment.

calibre crux summary [options]
OptionDescriptionRequiredDefault
--siteA unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.Yes
--jsonOutputs the results of the command in JSON format.
--formFactorFilter by device type.

calibre crux history#

Display Chrome UX Report (CrUX) historical trends for a site.

calibre crux history [options]
OptionDescriptionRequiredDefault
--siteA unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.Yes
--jsonOutputs the results of the command in JSON format.
--formFactorFilter by device type.
--timePeriodHistory time window.six-months
--limitNumber of history entries to display per metric.25

calibre crux urls#

List Chrome UX Report (CrUX) monitored URLs with their metrics and Core Web Vitals assessment.

calibre crux urls [options]
OptionDescriptionRequiredDefault
--siteA unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.Yes
--jsonOutputs the results of the command in JSON format.
--formFactorFilter by device type.

calibre crux url#

Display Chrome UX Report (CrUX) data for a specific monitored URL.

calibre crux url <uuid> [options]
OptionDescriptionRequiredDefault
--siteA unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.Yes
--jsonOutputs the results of the command in JSON format.
--formFactorFilter by device type.
--timePeriodHistory time window.six-months
--limitNumber of history entries to display per metric.25

calibre rum#

calibre rum summary#

Display Real User Metrics (RUM) dashboard — live visitors, aggregate web vitals, and UX ratings.

calibre rum summary [options]
OptionDescriptionRequiredDefault
--siteA unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.Yes
--jsonOutputs the results of the command in JSON format.
--durationNumber of days to aggregate.7
--dateBinTime granularity.day
--countryFilter by country code (e.g. AU).
--deviceFilter by device type.
--pathFilter by URL path.
--pageGroupingFilter by page grouping UUID.

calibre rum history#

Display Real User Metrics (RUM) historical trends.

calibre rum history [options]
OptionDescriptionRequiredDefault
--siteA unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.Yes
--jsonOutputs the results of the command in JSON format.
--durationNumber of days to aggregate.7
--dateBinTime granularity.day
--countryFilter by country code (e.g. AU).
--deviceFilter by device type.
--pathFilter by URL path.
--pageGroupingFilter by page grouping UUID.
--limitNumber of history entries to display.25

calibre rum pages#

Display Real User Metrics (RUM) page-level breakdown.

calibre rum pages [options]
OptionDescriptionRequiredDefault
--siteA unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.Yes
--jsonOutputs the results of the command in JSON format.
--durationNumber of days to aggregate.7
--dateBinTime granularity.day
--countryFilter by country code (e.g. AU).
--deviceFilter by device type.
--pathFilter by URL path.
--pageGroupingFilter by page grouping UUID.
--limitNumber of pages to display.25
--offsetNumber of pages to skip.0
--sortBySort pages by field.sessionCount

calibre rum config#

Display Real User Metrics (RUM) configuration for a site.

calibre rum config [options]
OptionDescriptionRequiredDefault
--siteA unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.Yes
--jsonOutputs the results of the command in JSON format.

calibre test#

calibre test create#

Run a Single Page Test against any public URL.

calibre test create <url> [options]
OptionDescriptionRequiredDefault
--deviceChoose the emulated test device.
--locationChoose the location for the test.Yes
--connectionChoose the emulated network connection speed.
--webhookUrlTest result JSON will be sent to this URL using HTTP POST.
--webhookSecretSecret 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.
--privateMake the results of a test private (only accessible by members of your Calibre organisation).false
--expiresAtSet 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:59ZDefault: Expires 1 year from creation date.
--cookie-jarSet cookies by specifying a path to a Netscape formatted cookie jar file.
--headersSet HTTP headers by providing a path to a JSON file or a valid JSON key-value pairs.
--blockedHostsBlock hosts by providing a comma-separated list, a path to a JSON file, or a valid JSON array. Supports wildcards (e.g., "*.example.com").
--jsonOutputs the results of the command in JSON format.
--markdownOutputs the results of the command in Markdown format.
--waitForTestWait for the test to complete before showing the results (default: test result link is shown immediately).false

calibre test download-artifacts#

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.

calibre test download-artifacts <uuid>
OptionDescriptionRequiredDefault
--jsonOutputs the results of the command in JSON format.

calibre test list#

List recent Single Page Tests (includes UUID, URL, device, connection, test location and status).

calibre test list
OptionDescriptionRequiredDefault
--jsonOutputs the results of the command in JSON format.

calibre test show#

See the results of a Single Page Test (also as outputted by the test create command).

calibre test show <uuid>
OptionDescriptionRequiredDefault
--jsonOutputs the results of the command in JSON format.
--markdownOutputs the results of the command in Markdown format.

calibre team#

calibre team list#

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.

calibre team list
OptionDescriptionRequiredDefault
--jsonOutputs the results of the command in JSON format.

calibre token#

calibre token set#

Store your API Token to use the CLI (saved in ~/.config/configstore/calibre.json).

calibre token set <token>

calibre token remove#

Remove the saved API Token used for CLI commands (from ~/.config/configstore/calibre.json).

calibre token remove

Reference commands#

calibre request#

Use the request command to make a request to the Calibre GraphQL API.

calibre request
OptionDescriptionRequiredDefault
--queryPass a GraphQL query to execute.Yes
--variablesPass query variables as named arguments. e.g.: calibre request --query "$(cat query.gql)" --foo="example" --bar="example"

calibre metric-list#

List available web performance metrics. Returns synthetic metrics by default.

calibre metric-list
OptionDescriptionRequiredDefault
--jsonOutputs the results of the command in JSON format.
--typeFilter metrics by data source.

calibre connection-list#

calibre connection-list
OptionDescriptionRequiredDefault
--jsonOutputs the results of the command in JSON format.

calibre device-list#

calibre device-list
OptionDescriptionRequiredDefault
--jsonOutputs the results of the command in JSON format.

calibre location-list#

calibre location-list
OptionDescriptionRequiredDefault
--jsonOutputs the results of the command in JSON format.