Command Line Client Commands


calibre site create <name> [options]

Add a Site for Calibre to monitor.

Flags

--url
required

The URL of the Site.

--location
required

Choose the location for the test.

--team

The identifying slug of the Team.

--schedule

Set the schedule for automated Snapshots. Available options: hourly, daily, every_x_hours.

Default: every_x_hours

--interval

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

--json

Outputs the results of the command in JSON format.

calibre site list

List all Sites you are tracking in Calibre.

Flags

--json

Outputs the results of the command in JSON format.

calibre site download-snapshot-artifacts [options]

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.

Flags

--sitestring
required

A unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.

--id
required

The id of the Snapshot.

--json

Outputs the results of the command in JSON format.

calibre site get-snapshot-metrics [options]

Get all metrics of a given Snapshot.

Flags

--sitestring
required

A unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.

--snapshot
required

The id of a Snapshot.

--json

Outputs the results of the command in JSON format.

--csv

Outputs the results of the command in CSV format.

calibre site metrics [options]

Get time-series metrics for a selected Site.

Flags

--sitestring
required

A unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.

--pagesarray

A list of Page UUIDs to return metrics for. You can separate multiple Pages by a space or use multiple --pages flags.

--profilesarray

A list of Test Profile UUIDs to return metrics for. You can separate multiple Test Profiles by a space or use multiple --profiles flags.

--metricsarray

A list of metric UUIDs to return metrics for. You can separate multiple metrics by a space or use multiple --metrics flags.

--json

Outputs the results of the command in JSON format.

--csv

Outputs the results of the command in CSV format.

--from

The start date to retrieve data from in the Year-Month-Day format (default: 7 days ago).

--to

The end date to retrieve data from in the Year-Month-Day format (default: today).

--30-day

Get the last 30 days of metrics. Without this flag, CLI will use the to and from values.

calibre site deploys [options]

List all deployments for a Site.

Flags

--sitestring
required

A unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.

--count

The number of items to return (default: 25, maximum: 500).

Default: 25

--cursor

The cursor to fetch records after

--json

Outputs the results of the command in JSON format.

Flags

--sitestring
required

A unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.

--revision

The source control revision id of the code you are deploying. It could be a git hash or a tag name.

--repository

The base URL of the repository containing the source code being deployed (e.g. https://github.com/calibreapp/app).

--username

The username of who deployed the code.

--json

Outputs the results of the command in JSON format.

calibre site delete-deploy [options]

Delete a deploy from a selected Site.

Flags

--sitestring
required

A unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.

--uuid
required

The UUID of the deploy.

--confirm

Use this flag to confirm the deletion of the selected deploy.

--json

Outputs the results of the command in JSON format.

calibre site pages [options]

List Pages for a selected Site.

Flags

--sitestring
required

A unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.

--count

The number of items to return (default: 25, maximum: 500).

Default: 25

--cursor

The cursor to fetch records after

--json

Outputs the results of the command in JSON format.

calibre site create-page <name> [options]

Add a Page to an existing Site tracked by Calibre.

Flags

--sitestring
required

A unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.

--url
required

The name of the Page.

--json

Outputs the results of the command in JSON format.

calibre site update-page [options]

Update the name or URL of a Page.

Flags

--uuid
required

The UUID of the Page.

--name

Update the name of the Page.

--url

Update the URL of the Page.

--sitestring
required

A unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.

--json

Outputs the results of the command in JSON format.

calibre site delete-page [options]

Delete a Page from a selected Site.

Flags

--sitestring
required

A unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.

--uuid
required

The UUID of the Page.

--confirm

Use this flag to confirm the deletion of the selected Page.

--json

Outputs the results of the command in JSON format.

calibre site snapshots [options]

List selected Snapshots for a Site.

Flags

--sitestring
required

A unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.

--count

The number of items to return (default: 25, maximum: 500).

Default: 25

--cursor

The cursor to fetch records after

--json

Outputs the results of the command in JSON format.

Flags

--sitestring
required

A unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.

--ref

Set a reference to the Snapshot.

--json

Outputs the results of the command in JSON format.

calibre site delete-snapshot [options]

Delete a Snapshot from a selected Site.

Flags

--sitestring
required

A unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.

--id
required

The id of the Snapshot.

--confirm

Use this flag to confirm the deletion of the selected Snapshot.

--json

Outputs the results of the command in JSON format.

calibre site test-profiles [options]

List all Test Profiles for a Site.

Flags

--sitestring
required

A unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.

--json

Outputs the results of the command in JSON format.

Flags

--sitestring
required

A unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.

--device

Choose the emulated test device.

--connection

Choose the emulated network connection speed.

--javascriptboolean

Turn JavaScript execution on or off.

Default:

--adblockerboolean

Turn adblocking on or off.

--cookie-jar

Set cookies by specifying a path to a Netscape formatted cookie jar file.

--json

Outputs the results of the command in JSON format.

calibre site update-test-profile [options]

Update Test Profile settings. Only changes specified attributes.

Flags

--uuid
required

The UUID of the Test Profile.

--device

Set the emulated device.

--connection

Set the emulated network connection speed.

--sitestring
required

A unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.

--json

Outputs the results of the command in JSON format.

--javascriptboolean

Turn JavaScript execution on or off

Default:

--adblockerboolean

Turn adblocking on or off.

--cookie-jar

Set cookies by specifying a path to a Netscape formatted cookie jar file.

calibre site delete-test-profile [options]

Delete a Test Profile from a Site.

Flags

--sitestring
required

A unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command.

--uuid
required

The UUID of the Test Profile.

--confirm

Use this flag to confirm the deletion of the selected Test Profile.

--json

Outputs the results of the command in JSON format.

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.

Flags

--json

Outputs the results of the command in JSON format.

calibre test create <url> [options]

Run a Single Page Test against any public URL.

Flags

--device

Choose the emulated test device.

--location
required

Choose the location for the test.

--connection

Choose the emulated network connection speed.

--adblockerboolean

Turn adblocking on or off.

--privateboolean

Make the results of a test private (only accessible by members of your Calibre organisation).

--cookie-jar

Set cookies by specifying a path to a Netscape formatted cookie jar file.

--headers

Set HTTP headers by providing a path to a JSON file or a valid JSON key-value pairs.

--json

Outputs the results of the command in JSON format.

--waitForTestboolean

Wait for the test to complete before showing the results (default: test result link is shown immediately).

calibre test download-artifacts <uuid>

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.

Flags

--json

Outputs the results of the command in JSON format.

calibre test list

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

Flags

--json

Outputs the results of the command in JSON format.

calibre test show <uuid>

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

Flags

--json

Outputs the results of the command in JSON format.

calibre connection-list

List all available network connection speeds.

Flags

--json

Outputs the results of the command in JSON format.

calibre device-list

List all available test devices.

Flags

--json

Outputs the results of the command in JSON format.

calibre location-list

List all available test locations.

Flags

--json

Outputs the results of the command in JSON format.

calibre metric-list

List all available web performance metrics.

Flags

--json

Outputs the results of the command in JSON format.

calibre token set <token>

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

Flags

calibre token remove

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

Flags

calibre request

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

Flags

--querystring
required

Pass a GraphQL query to execute.

--variables

Pass query variables as named arguments.