Table of contents

Command Line Reference

Executes all the checks in the scope of your project on the Checkly cloud infrastructure. You can specify files to run by appending a pattern, e.g. npx checkly test home.spec.js api.

Dry run all checks in your repo:

npx checkly test

Dry run checks that have product and api in the file name

npx checkly test product api

Record a test session in Checkly with git branch info, full logging, videos and traces.

npx checkly test --record

Dry run all checks against a specific location:

npx checkly test --location eu-west-1

Dry run checks while passing a specific URL and a password. These variables are available on process.env

npx checkly test --env "ENVIRONMENT_URL=https://preview.acme.com" --env PASSWORD=doremiabc123

This is very powerful when combined with passing environment variables using one of the flags --env or --env-file as you can target staging, test and preview environment with specific URLs, credentials and other common variables that differ between environments.

• --config or -c: You can specify a particular configuration file, e.g. --config="./checkly.staging.config.ts"
• --env <key=value> or -e: Pass environment variables to the check execution runtime. Passed variables overwrite any existing variables stored in your Checkly account.
• --env-file: You can read variables from a .env file by passing the file path e.g. --env-file="./.env"
• --grep <pattern> or -g: Only run checks where the check name matches a regular expression.
• --list: Just list the checks in your project, but don’t run them.
• --location <location> or -l: Run checks against a specified location, e.g. eu-west-1. Defaults to us-east-1.
• --private-location <private location ID>: Run checks against the specified private location.
• --record: Record tests results in Checkly as a test session.
• --reporter or -r: One or more reporters for the test output. Options are: list|dot|ci|github|json. You can use multiple reporters by specifying the flag multiple times, e.g. --reporter=list --reporter=json.
• --tags or -t: Filter the checks using a comma separated list of tags. Checks will only be run if they contain all the specified tags. Multiple --tags flags can be passed, in which case checks will be run if they match any of the --tags filters, i.e. --tags production,webapp --tags staging,backend will run checks with tags (production AND webapp) OR (staging AND backend).
• --retries: How many times to retry a failing check run. 0 by default and maximum 3.
• --timeout: A fallback timeout (in seconds) to wait for checks to complete. 600 seconds by default.
• --update-snapshots or -u: Update the golden images / reference snapshots of your visual comparison and snapshot tests.
• --verbose or -v: Always show the full logs of the checks.

Deploys all your checks and associated resources like alert channels to your Checkly account.

Preview the differences between your actual configuration and your account

npx checkly deploy --preview

Deploy all resources to your Checkly account

npx checkly deploy

• --config or -c: You can specify a particular configuration file, e.g. --config="./checkly.staging.config.ts"
• --force or -f: Skips the confirmation dialog when deploying. Handy in CI environments.
• --preview or -p: Preview the differences between your actual configuration and your account.
• --output or -o: Show applied differences after deploying.
• --no-schedule-on-deploy: Do not run checks when deploying.

When you deploy a project, you can attach Git specific information so changes to any resources are displayed in the Checkly web UI wit the correct commit, owner etc.

Some of the above variables will be detected automatically detected from your local or CI environment on a best effort basis.

Destroy all project’s resources (checks, groups, alert channels, etc.) from your Checkly account.

• --config or -c: You can specify a particular configuration file, e.g. --config="./checkly.staging.config.ts"
• --force or -f: Skips the confirmation dialog when deploying. Handy in CI environments.

The trigger command is similar to the test command, but “triggers” checks already in your Checkly account. This works regardless of whether you created these checks via a Project with CLI constructs, via the UI or using Terraform.

Because trigger does not rely on any Project or as-code representation of your checks, the invocation is slightly different, as there are no files to reference for instance.

npx checkly trigger

Trigger checks tagged with “production” and “api” and pass in an ENVIRONMENT_URL.

npx checkly trigger --tags=production,api -e ENVIRONMENT_URL=https://staging.acme.com

Trigger all checks to run in location eu-west-1 and record a test session named “Adhoc test run”.

npx checkly trigger --record --test-session-name="Adhoc test run" --location=eu-west-1

• --config or -c: You can specify a particular configuration file, e.g. --config="./checkly.staging.config.ts"
• --env <key=value> or -e: Pass environment variables to the check execution runtime. Passed variables overwrite any existing variables stored in your Checkly account.
• --env-file: You can read variables from a .env file by passing the file path e.g. --env-file="./.env"
• --location <location> or -l: Run checks against a specified location, e.g. eu-west-1. Defaults to us-east-1.
• --private-location <private location ID>: Run checks against the specified private location.
• --record: Record tests results in Checkly as a test session.
• --reporter or -r: One or more reporters for the test output. Options are: list|dot|ci|github|json. You can use multiple reporters by specifying the flag multiple times, e.g. --reporter=list --reporter=json.
• --tags or -t: Filter the checks to be triggered using a comma separated list of tags. Checks will only be run if they contain all the specified tags. Multiple --tags flags can be passed, in which case checks will be run if they match any of the --tags filters, i.e. --tags production,webapp --tags staging,backend will run checks with tags (production AND webapp) OR (staging AND backend).
• --test-session-name A name to use when storing results in Checkly with --record.
• --retries: How many times to retry a failing check run. 0 by default and maximum 3.
• --timeout: A fallback timeout (in seconds) to wait for checks to complete. 600 seconds by default.
• --verbose or -v: Always show the full logs of the checks.

Sign up for a new Checkly account or log in to your existing Checkly account.

Logs you out of your Checkly account.

Prints the account and user you are currently logged in with.

Switch which account you are logged into based on the accounts you can access with your credentials.

List all available runtimes and their dependencies.

Manage the global variables of a Checkly account. You can list, add, remove, update and export environment variables.

Export global variables from your Checkly account to a local .env file or a different file of your choice. For secrets, only the key will be exported, not the value.

checkly env pull [FILENAME] [-f]

• FILENAME: You can specify a particular environment variable file, e.g. .env.local
• --force or -f: Skips the confirmation dialog when pulling environment variables to existing env file.

npx checkly env pull -f

Pull all global variables to the .env file and overwrite it if it already exists.

List global variables. This command does not list variables on group or check level. For secrets, only the key name will be shown, not its value.

checkly env ls

Add a global variable.

checkly env add [KEY] [VALUE] [-l | -s] 

• KEY: Environment variable key.
• VALUE: Environment variable value.
• --locked or -l: Indicate that the environment variable will be locked, making it private to all read only users.
• --secret or -s: Indicate that the environment variable will be created as a secret.

Update a global variable.

checkly env update [KEY] [VALUE] [-l | -s]

• KEY: Variable key.
• VALUE: Variable value.
• --locked or -l: Indicate that the variable will be locked, making it private to all read only users.
• --secret or -s: Indicate that the variable will be changed to a secret. Note that secrets cannot be changed to variables. When updating a secret always pass the -s flag.

Remove a global variable.

checkly env rm [KEY] [-f]

• KEY: Variable key.
• --force or -f: Skips the confirmation dialog when removing a variable.

Copy Playwright config into the Checkly config file.

npx checkly sync-playwright

Constructs Reference

Last updated on November 7, 2024. You can contribute to this documentation by editing this page on Github