diff --git a/cli/checkly-login.mdx b/cli/account/checkly-login.mdx similarity index 99% rename from cli/checkly-login.mdx rename to cli/account/checkly-login.mdx index 1a46d804..65f56929 100644 --- a/cli/checkly-login.mdx +++ b/cli/account/checkly-login.mdx @@ -2,6 +2,7 @@ title: checkly login description: 'Sign up for a new Checkly account or log in to your existing account.' sidebarTitle: 'checkly login' +slug: cli/checkly-login --- The `checkly login` command authenticates with Checkly by signing up for a new account or logging in to your existing account. diff --git a/cli/checkly-logout.mdx b/cli/account/checkly-logout.mdx similarity index 91% rename from cli/checkly-logout.mdx rename to cli/account/checkly-logout.mdx index 14c84cfe..fbbac8d4 100644 --- a/cli/checkly-logout.mdx +++ b/cli/account/checkly-logout.mdx @@ -2,6 +2,7 @@ title: checkly logout description: 'Log out of your Checkly account.' sidebarTitle: 'checkly logout' +slug: cli/checkly-logout --- The `checkly logout` command signs out of your current Checkly account and removes stored authentication tokens from your local machine. @@ -23,9 +24,9 @@ The basic command logs out of your current Checkly account and removes stored au npx checkly logout [options] ``` -| Option | Description | -|--------|-------------| -| `--force, -f` | Force mode. Skips the confirmation dialog. | +| Option | Required | Description | +|--------|----------|-------------| +| `--force, -f` | - | Force mode. Skips the confirmation dialog. | ## Command Options diff --git a/cli/checkly-runtimes.mdx b/cli/account/checkly-runtimes.mdx similarity index 99% rename from cli/checkly-runtimes.mdx rename to cli/account/checkly-runtimes.mdx index a318ebde..58395e73 100644 --- a/cli/checkly-runtimes.mdx +++ b/cli/account/checkly-runtimes.mdx @@ -2,6 +2,7 @@ title: checkly runtimes description: 'List all available runtimes and their dependencies.' sidebarTitle: 'checkly runtimes' +slug: cli/checkly-runtimes --- The `checkly runtimes` command displays all available runtime environments and their installed dependencies. This helps you understand what packages and versions are available for your checks in the Checkly cloud infrastructure. diff --git a/cli/checkly-switch.mdx b/cli/account/checkly-switch.mdx similarity index 93% rename from cli/checkly-switch.mdx rename to cli/account/checkly-switch.mdx index 56761501..370933b2 100644 --- a/cli/checkly-switch.mdx +++ b/cli/account/checkly-switch.mdx @@ -2,6 +2,7 @@ title: checkly switch description: 'Switch between multiple Checkly accounts.' sidebarTitle: 'checkly switch' +slug: cli/checkly-switch --- The `checkly switch` command switches between multiple Checkly accounts that you have access to with your current credentials. Useful when you need to manage monitoring across different organizations or environments. @@ -23,9 +24,9 @@ The basic command displays available accounts and provides an interactive select npx checkly switch [options] ``` -| Option | Description | -|--------|-------------| -| `--account-id, -a` | The id of the account you want to switch to. | +| Option | Required | Description | +|--------|----------|-------------| +| `--account-id, -a` | - | The id of the account you want to switch to. | ## Command Options diff --git a/cli/checkly-whoami.mdx b/cli/account/checkly-whoami.mdx similarity index 85% rename from cli/checkly-whoami.mdx rename to cli/account/checkly-whoami.mdx index 203ea691..cf767f89 100644 --- a/cli/checkly-whoami.mdx +++ b/cli/account/checkly-whoami.mdx @@ -2,6 +2,7 @@ title: checkly whoami description: 'Display current account and user information.' sidebarTitle: 'checkly whoami' +slug: cli/checkly-whoami --- The `checkly whoami` command displays detailed information about your current Checkly authentication, including the logged-in user account and active Checkly account details. @@ -41,3 +42,5 @@ environment variables to setup authentication. ## Related Commands - [`checkly login`](/cli/checkly-login) - Sign in to your Checkly account +- [`checkly logout`](/cli/checkly-logout) - Sign out of your Checkly account +- [`checkly switch`](/cli/checkly-switch) - Switch between multiple accounts diff --git a/cli/checkly-incidents.mdx b/cli/communicate/checkly-incidents.mdx similarity index 99% rename from cli/checkly-incidents.mdx rename to cli/communicate/checkly-incidents.mdx index e3cf1d60..5926c76e 100644 --- a/cli/checkly-incidents.mdx +++ b/cli/communicate/checkly-incidents.mdx @@ -2,6 +2,7 @@ title: checkly incidents description: 'Create, update, and resolve incidents on your status pages from the CLI.' sidebarTitle: 'checkly incidents' +slug: cli/checkly-incidents --- Available since CLI v7.5.0. @@ -362,7 +363,7 @@ npx checkly incidents resolve [options] | Argument | Description | |----------|-------------| -| `ID` | The ID of the incident to resolve. | +| `id` | The ID of the incident to resolve. | **Options:** diff --git a/cli/checkly-status-pages.mdx b/cli/communicate/checkly-status-pages.mdx similarity index 85% rename from cli/checkly-status-pages.mdx rename to cli/communicate/checkly-status-pages.mdx index c35927e7..6f1cb235 100644 --- a/cli/checkly-status-pages.mdx +++ b/cli/communicate/checkly-status-pages.mdx @@ -2,6 +2,7 @@ title: checkly status-pages description: 'List and inspect status pages in your Checkly account.' sidebarTitle: 'checkly status-pages' +slug: cli/checkly-status-pages --- Available since CLI v7.3.0. @@ -42,12 +43,12 @@ npx checkly status-pages list [options] **Options:** -| Option | Description | -|--------|-------------| -| `--limit, -l` | Number of status pages to return (1-100). Default: `25`. | -| `--cursor` | Cursor for next page (from previous output). | -| `--compact` | Show one row per status page instead of per service. | -| `--output, -o` | Output format: `table`, `json`, or `md`. Default: `table`. | +| Option | Required | Description | +|--------|----------|-------------| +| `--limit, -l` | - | Number of status pages to return (1-100). Default: `25`. | +| `--cursor` | - | Cursor for next page (from previous output). | +| `--compact` | - | Show one row per status page instead of per service. | +| `--output, -o` | - | Output format: `table`, `json`, or `md`. Default: `table`. | ### List Options @@ -131,13 +132,13 @@ npx checkly status-pages get [options] | Argument | Description | |----------|-------------| -| `ID` | The ID of the status page to retrieve. | +| `id` | The ID of the status page to retrieve. | **Options:** -| Option | Description | -|--------|-------------| -| `--output, -o` | Output format: `detail`, `json`, or `md`. Default: `detail`. | +| Option | Required | Description | +|--------|----------|-------------| +| `--output, -o` | - | Output format: `detail`, `json`, or `md`. Default: `detail`. | ### Get Options diff --git a/cli/checkly-env.mdx b/cli/configure/checkly-env.mdx similarity index 87% rename from cli/checkly-env.mdx rename to cli/configure/checkly-env.mdx index 1ab5856e..b922aa6f 100644 --- a/cli/checkly-env.mdx +++ b/cli/configure/checkly-env.mdx @@ -2,6 +2,7 @@ title: checkly env description: 'Manage the global variables of a Checkly account.' sidebarTitle: 'checkly env' +slug: cli/checkly-env --- import CliCommandPrerequisites from '/snippets/cli-command-prerequisites.mdx'; @@ -40,10 +41,10 @@ npx checkly env add [options] **Options:** -| Option | Description | -|--------|-------------| -| `--locked, -l` | Lock variable. | -| `--secret, -s` | Store as secret. | +| Option | Required | Description | +|--------|----------|-------------| +| `--locked, -l` | - | Lock variable. | +| `--secret, -s` | - | Store as secret. | **Examples:** @@ -70,10 +71,10 @@ npx checkly env update [options] **Options:** -| Option | Description | -|--------|-------------| -| `--locked, -l` | Lock variable. | -| `--secret, -s` | Store as secret. | +| Option | Required | Description | +|--------|----------|-------------| +| `--locked, -l` | - | Lock variable. | +| `--secret, -s` | - | Store as secret. | **Examples:** @@ -119,9 +120,9 @@ npx checkly env pull [filename] [options] **Options:** -| Option | Description | -|--------|-------------| -| `--force, -f` | Overwrite existing file without confirmation | +| Option | Required | Description | +|--------|----------|-------------| +| `--force, -f` | - | Overwrite existing file without confirmation | **Examples:** @@ -148,9 +149,9 @@ npx checkly env rm [options] **Options:** -| Option | Description | -|--------|-------------| -| `--force, -f` | Skip confirmation dialog | +| Option | Required | Description | +|--------|----------|-------------| +| `--force, -f` | - | Skip confirmation dialog | **Examples:** diff --git a/cli/checkly-import.mdx b/cli/configure/checkly-import.mdx similarity index 93% rename from cli/checkly-import.mdx rename to cli/configure/checkly-import.mdx index 5508a303..fbcf6442 100644 --- a/cli/checkly-import.mdx +++ b/cli/configure/checkly-import.mdx @@ -2,6 +2,7 @@ title: checkly import description: 'Import existing resources into your CLI-managed project.' sidebarTitle: 'checkly import' +slug: cli/checkly-import --- Available since CLI v5.4.0. @@ -48,10 +49,10 @@ npx checkly import check:2ce8... `npx checkly import` starts an interactive process that generates an import plan, applies it to create Check files, and commits the changes to mark resources as managed by your CLI project. -| Option | Description | -|--------|-------------| -| `--config, -c` | The Checkly CLI configuration file. If not passed, uses the `checkly.config.ts|js` file in the current directory. | -| `--root` | The root folder in which to write generated code files. | +| Option | Required | Description | +|--------|----------|-------------| +| `--config, -c` | - | The Checkly CLI configuration file. If not passed, uses the `checkly.config.ts|js` file in the current directory. | +| `--root` | - | The root folder in which to write generated code files. | ## Command Options diff --git a/cli/checkly-sync-playwright.mdx b/cli/configure/checkly-sync-playwright.mdx similarity index 99% rename from cli/checkly-sync-playwright.mdx rename to cli/configure/checkly-sync-playwright.mdx index 34d76121..7bb1308a 100644 --- a/cli/checkly-sync-playwright.mdx +++ b/cli/configure/checkly-sync-playwright.mdx @@ -2,6 +2,7 @@ title: checkly sync-playwright description: 'Synchronize Playwright configuration with Checkly settings.' sidebarTitle: 'checkly sync-playwright' +slug: cli/checkly-sync-playwright --- Available since CLI v4.6.0. diff --git a/cli/checkly-checks.mdx b/cli/monitoring/checkly-checks.mdx similarity index 84% rename from cli/checkly-checks.mdx rename to cli/monitoring/checkly-checks.mdx index ecb598d2..529902fb 100644 --- a/cli/checkly-checks.mdx +++ b/cli/monitoring/checkly-checks.mdx @@ -2,6 +2,7 @@ title: checkly checks description: 'List and inspect checks in your Checkly account.' sidebarTitle: 'checkly checks' +slug: cli/checkly-checks --- Available since CLI v7.3.0. @@ -42,15 +43,15 @@ npx checkly checks list [options] **Options:** -| Option | Description | -|--------|-------------| -| `--limit, -l` | Number of checks to return (1-100). Default: `25`. | -| `--page, -p` | Page number. Default: `1`. | -| `--search, -s` | Filter checks by name (case-insensitive). | -| `--tag, -t` | Filter by tag. Can be specified multiple times. | -| `--type` | Filter by check type. | -| `--hide-id` | Hide check IDs in table output. | -| `--output, -o` | Output format: `table`, `json`, or `md`. Default: `table`. | +| Option | Required | Description | +|--------|----------|-------------| +| `--limit, -l` | - | Number of checks to return (1-100). Default: `25`. | +| `--page, -p` | - | Page number. Default: `1`. | +| `--search, -s` | - | Filter checks by name (case-insensitive). | +| `--tag, -t` | - | Filter by tag. Can be specified multiple times. | +| `--type` | - | Filter by check type. | +| `--hide-id` | - | Hide check IDs in table output. | +| `--output, -o` | - | Output format: `table`, `json`, or `md`. Default: `table`. | ### List Options @@ -177,17 +178,17 @@ npx checkly checks get [options] | Argument | Description | |----------|-------------| -| `ID` | The ID of the check to retrieve. | +| `id` | The ID of the check to retrieve. | **Options:** -| Option | Description | -|--------|-------------| -| `--result, -r` | Show details for a specific result ID. | -| `--error-group, -e` | Show full details for a specific error group ID. | -| `--results-limit` | Number of recent results to show. Default: `10`. | -| `--results-cursor` | Cursor for results pagination (from previous output). | -| `--output, -o` | Output format: `detail`, `json`, or `md`. Default: `detail`. | +| Option | Required | Description | +|--------|----------|-------------| +| `--result, -r` | - | Show details for a specific result ID. | +| `--error-group, -e` | - | Show full details for a specific error group ID. | +| `--results-limit` | - | Number of recent results to show. Default: `10`. | +| `--results-cursor` | - | Cursor for results pagination (from previous output). | +| `--output, -o` | - | Output format: `detail`, `json`, or `md`. Default: `detail`. | ### Get Options diff --git a/cli/checkly-deploy.mdx b/cli/monitoring/checkly-deploy.mdx similarity index 82% rename from cli/checkly-deploy.mdx rename to cli/monitoring/checkly-deploy.mdx index eae5de32..2191546f 100644 --- a/cli/checkly-deploy.mdx +++ b/cli/monitoring/checkly-deploy.mdx @@ -2,6 +2,7 @@ title: checkly deploy description: 'Deploy checks and resources to your Checkly account.' sidebarTitle: 'checkly deploy' +slug: cli/checkly-deploy --- import CliCommandPrerequisites from '/snippets/cli-command-prerequisites.mdx'; @@ -19,15 +20,15 @@ The basic command deploys all resources to your Checkly account, synchronizing y npx checkly deploy [options] ``` -| Option | Description | -|--------|-------------| -| `--config, -c` | The Checkly CLI configuration file. If not passed, uses the `checkly.config.ts\|js` file in the current directory. | -| `--force, -f` | Force mode. Skips the confirmation dialog. | -| `--debug-bundle` | Generate a JSON file containing the data sent to our servers when you deploy. **Note**: This flag is in beta. The bundle’s structure is not considered a stable format and may change without notice. It’s intended for one-off troubleshooting, and note it may contain secrets before sharing. | -| `--output, -o` | Show the changes made after the deploy command. | -| `--preview, -p` | Show a preview of the changes made by the deploy command. | -| `--[no-]schedule-on-deploy` | Enables automatic check scheduling after a deploy. | -| `--[no-]verify-runtime-dependencies` | Return an error if checks import dependencies that are not supported by the selected runtime. | +| Option | Required | Description | +|--------|----------|-------------| +| `--config, -c` | - | The Checkly CLI configuration file. If not passed, uses the `checkly.config.ts\|js` file in the current directory. | +| `--force, -f` | - | Force mode. Skips the confirmation dialog. | +| `--debug-bundle` | - | Generate a JSON file containing the data sent to our servers when you deploy. **Note**: This flag is in beta. The bundle’s structure is not considered a stable format and may change without notice. It’s intended for one-off troubleshooting, and note it may contain secrets before sharing. | +| `--output, -o` | - | Show the changes made after the deploy command. | +| `--preview, -p` | - | Show a preview of the changes made by the deploy command. | +| `--[no-]schedule-on-deploy` | - | Enables automatic check scheduling after a deploy. | +| `--[no-]verify-runtime-dependencies` | - | Return an error if checks import dependencies that are not supported by the selected runtime. | ## Command Options diff --git a/cli/checkly-destroy.mdx b/cli/monitoring/checkly-destroy.mdx similarity index 88% rename from cli/checkly-destroy.mdx rename to cli/monitoring/checkly-destroy.mdx index b1183296..c91a1cbe 100644 --- a/cli/checkly-destroy.mdx +++ b/cli/monitoring/checkly-destroy.mdx @@ -2,6 +2,7 @@ title: checkly destroy description: 'Destroy all project resources from your Checkly account.' sidebarTitle: 'checkly destroy' +slug: cli/checkly-destroy --- import CliCommandPrerequisites from '/snippets/cli-command-prerequisites.mdx'; @@ -22,10 +23,10 @@ The basic command destroys all project resources with a confirmation prompt. npx checkly destroy [options] ``` -| Option | Description | -|--------|-------------| -| `--config, -c` | The Checkly CLI configuration file. If not passed, uses the `checkly.config.ts\|js` file in the current directory. | -| `--force, -f` | Force mode. Skips the confirmation dialog. | +| Option | Required | Description | +|--------|----------|-------------| +| `--config, -c` | - | The Checkly CLI configuration file. If not passed, uses the `checkly.config.ts\|js` file in the current directory. | +| `--force, -f` | - | Force mode. Skips the confirmation dialog. | ## Command Options diff --git a/cli/checkly-trigger.mdx b/cli/monitoring/checkly-trigger.mdx similarity index 83% rename from cli/checkly-trigger.mdx rename to cli/monitoring/checkly-trigger.mdx index 53b4c2c2..a7d49bcb 100644 --- a/cli/checkly-trigger.mdx +++ b/cli/monitoring/checkly-trigger.mdx @@ -2,6 +2,7 @@ title: checkly trigger description: 'Trigger checks already in your Checkly account.' sidebarTitle: 'checkly trigger' +slug: cli/checkly-trigger --- import CliCommandPrerequisites from '/snippets/cli-command-prerequisites.mdx'; @@ -18,25 +19,25 @@ The basic command triggers all checks in your account that are already deployed. npx checkly trigger [options] ``` -| Option | Description | -|--------|-------------| -| `--config, -c` | The Checkly CLI configuration file. If not passed, uses the `checkly.config.ts\|js` file in the current directory. | -| `--env, -e` | Env vars to be passed to the check run. Default: empty. Multiple values can be passed. | -| `--env-file` | dotenv file path to be passed. For example `--env-file="./.env"` | -| `--fail-on-no-matching` | Exit with a failing status code when there are no matching tests. | -| `--location, -l` | The location to run the checks at. | -| `--private-location` | The private location to run checks at. | -| `--record` | Record check results in Checkly as a test session with full logs, traces and videos. | -| `--reporter, -r` | A list of custom reporters for the test output. | -| `--retries` | How many times to retry a check run. | -| `--tags, -t` | Filter the checks to be run using a comma separated list of tags. | -| `--test-session-name, -n` | A name to use when storing results in Checkly with `--record`. | -| `--timeout` | A timeout (in seconds) to wait for checks to complete. | -| `--verbose, -v` | Always show the full logs of the checks. | +| Option | Required | Description | +|--------|----------|-------------| +| `--config, -c` | - | The Checkly CLI configuration file. If not passed, uses the `checkly.config.ts\|js` file in the current directory. | +| `--env, -e` | - | Env vars to be passed to the check run. Default: empty. Multiple values can be passed. | +| `--env-file` | - | dotenv file path to be passed. For example `--env-file="./.env"` | +| `--fail-on-no-matching` | - | Exit with a failing status code when there are no matching tests. | +| `--location, -l` | - | The location to run the checks at. | +| `--private-location` | - | The private location to run checks at. | +| `--record` | - | Record check results in Checkly as a test session with full logs, traces and videos. | +| `--reporter, -r` | - | A list of custom reporters for the test output. | +| `--retries` | - | How many times to retry a check run. | +| `--tags, -t` | - | Filter the checks to be run using a comma separated list of tags. | +| `--test-session-name, -n` | - | A name to use when storing results in Checkly with `--record`. | +| `--timeout` | - | A timeout (in seconds) to wait for checks to complete. | +| `--verbose, -v` | - | Always show the full logs of the checks. | ## Command Options - + Specify a configuration file to use instead of the `checkly.config.ts` or `checkly.config.js` in the current directory. @@ -49,7 +50,7 @@ npx checkly trigger -c="./checkly.staging.config.ts" - + [Environment variables](/cli/environment-variables) to be passed to the check run. Multiple values can be passed and passed variables overwrite any existing variables stored in your Checkly account. @@ -99,7 +100,7 @@ The dotenv file should contain KEY=value pairs, one per line. - + The location to run the checks at. **Usage:** @@ -138,7 +139,7 @@ npx checkly trigger --private-location"vpc-location" --config="internal.config.j Private locations must be configured in your Checkly account before use. - + Filter checks using tags. Checks run if they contain all specified tags in a single --tags flag. Multiple --tags flags create OR conditions. **Usage:** @@ -165,7 +166,7 @@ npx checkly trigger --tags="production,webapp" --tags="production,backend" Tags are comma-separated within a single flag for AND logic, multiple flags for OR logic. - + A name to use when storing results in Checkly with `--record`. @@ -177,7 +178,7 @@ npx checkly trigger --record --test-session-name="Custom session name" - + Custom reporters for test output formatting. @@ -210,7 +211,7 @@ npx checkly trigger --reporter json > results.json Available options: `list`, `dot`, `ci`, `github`, `json`. Each provides different output formatting. - + Always show the full logs of the checks. diff --git a/cli/checkly-pw-test.mdx b/cli/testing/checkly-pw-test.mdx similarity index 87% rename from cli/checkly-pw-test.mdx rename to cli/testing/checkly-pw-test.mdx index 6d65b999..7775553b 100644 --- a/cli/checkly-pw-test.mdx +++ b/cli/testing/checkly-pw-test.mdx @@ -2,6 +2,7 @@ title: checkly pw-test description: 'Run Playwright tests with Checkly monitoring features' sidebarTitle: 'checkly pw-test' +slug: cli/checkly-pw-test --- Available since CLI v6.1.0. @@ -32,32 +33,32 @@ npx checkly pw-test [checkly options] -- [playwright options] Define `checkly pw-test` specific options before the `--` separator: -| Option | Description | -|--------|-------------| -| `--config` | The Checkly CLI configuration file. If not passed, uses the `checkly.config.ts\|js` file in the current directory. | -| `--create-check` | Create a Checkly check from the Playwright test. | -| `--env, -e` | Env vars to be passed to the test run. Default: [] | -| `--env-file` | dotenv file path to be passed. For example `--env-file="./.env"` | -| `--installCommand` | Override the command used to install dependencies before running tests. | -| `--location, -l` | The location to run the checks at. | -| `--private-location` | The private location to run checks at. | -| `--[no-]record` | Record test results in Checkly as a test session with full logs, traces and videos. | -| `--reporter` | A list of custom reporters for the test output. | -| `--stream-logs` | Stream logs from the test run to the console. | -| `--test-session-name` | A name to use when storing results in Checkly | -| `--timeout` | A timeout (in seconds) to wait for checks to complete. | -| `--verbose` | Always show the full logs of the checks. | +| Option | Required | Description | +|--------|----------|-------------| +| `--config` | - | The Checkly CLI configuration file. If not passed, uses the `checkly.config.ts\|js` file in the current directory. | +| `--create-check` | - | Create a Checkly check from the Playwright test. | +| `--env, -e` | - | Env vars to be passed to the test run. Default: [] | +| `--env-file` | - | dotenv file path to be passed. For example `--env-file="./.env"` | +| `--installCommand` | - | Override the command used to install dependencies before running tests. | +| `--location, -l` | - | The location to run the checks at. | +| `--private-location` | - | The private location to run checks at. | +| `--[no-]record` | - | Record test results in Checkly as a test session with full logs, traces and videos. | +| `--reporter` | - | A list of custom reporters for the test output. | +| `--stream-logs` | - | Stream logs from the test run to the console. | +| `--test-session-name` | - | A name to use when storing results in Checkly | +| `--timeout` | - | A timeout (in seconds) to wait for checks to complete. | +| `--verbose` | - | Always show the full logs of the checks. | Define Playwright test runner flags after the `--` separator: -| Option | Description | -|------|-------------| -| `--project` | Select Playwright projects | -| `--grep` | Filter tests by pattern | -| `--grep-invert` | Exclude tests by pattern | +| Option | Required | Description | +|------|----------|-------------| +| `--project` | - | Select Playwright projects | +| `--grep` | - | Filter tests by pattern | +| `--grep-invert` | - | Exclude tests by pattern | The `--reporter` and `--headed` options are not supported. Find more Playwright options in the [Playwright test runner docs](https://playwright.dev/docs/test-cli). @@ -123,7 +124,7 @@ const config = defineConfig({ - + Pass environment variables to the test run. Can be specified multiple times to set multiple variables. diff --git a/cli/checkly-test.mdx b/cli/testing/checkly-test.mdx similarity index 78% rename from cli/checkly-test.mdx rename to cli/testing/checkly-test.mdx index e41a1c39..fba77c48 100644 --- a/cli/checkly-test.mdx +++ b/cli/testing/checkly-test.mdx @@ -2,6 +2,7 @@ title: checkly test description: 'Run checks in your project using the Checkly CLI.' sidebarTitle: 'checkly test' +slug: cli/checkly-test --- import CliCommandPrerequisites from '/snippets/cli-command-prerequisites.mdx'; @@ -18,28 +19,28 @@ The basic command runs all checks in your project as a test run without deployin npx checkly test [arguments] [options] ``` -| Option | Description | -|--------|-------------| -| `--config, -c` | The Checkly CLI configuration file. If not passed, uses the `checkly.config.ts\|js` file in the current directory. | -| `--env, -e` | Env vars to be passed to the test run. Can be used multiple times. | -| `--env-file` | dotenv file path to be passed. For example `--env-file="./.env"` | -| `--grep, -g` | Only run checks where the check name matches a regular expression. Default: `.*` | -| `--list` | List all checks but don't run them. | -| `--location, -l` | The location to run the checks at. | -| `--private-location` | The private location to run checks at. | -| `--record` | Record test results in Checkly as a test session with full logs, traces and videos. | -| `--reporter, -r` | A list of custom reporters for the test output. | -| `--retries` | How many times to retry a failing test run. | -| `--tags, -t` | Filter the checks to be run using a comma separated list of tags. | -| `--test-session-name, -n` | A name to use when storing results in Checkly with `--record`. | -| `--timeout` | A timeout (in seconds) to wait for checks to complete. | -| `--update-snapshots, -u` | Update any snapshots using the actual result of this test run. | -| `--verbose, -v` | Always show the full logs of the checks. | -| `--[no-]verify-runtime-dependencies` | Return an error if checks import dependencies that are not supported by the selected runtime. | +| Option | Required | Description | +|--------|----------|-------------| +| `--config, -c` | - | The Checkly CLI configuration file. If not passed, uses the `checkly.config.ts\|js` file in the current directory. | +| `--env, -e` | - | Env vars to be passed to the test run. Can be used multiple times. | +| `--env-file` | - | dotenv file path to be passed. For example `--env-file="./.env"` | +| `--grep, -g` | - | Only run checks where the check name matches a regular expression. Default: `.*` | +| `--list` | - | List all checks but don't run them. | +| `--location, -l` | - | The location to run the checks at. | +| `--private-location` | - | The private location to run checks at. | +| `--record` | - | Record test results in Checkly as a test session with full logs, traces and videos. | +| `--reporter, -r` | - | A list of custom reporters for the test output. | +| `--retries` | - | How many times to retry a failing test run. | +| `--tags, -t` | - | Filter the checks to be run using a comma separated list of tags. | +| `--test-session-name, -n` | - | A name to use when storing results in Checkly with `--record`. | +| `--timeout` | - | A timeout (in seconds) to wait for checks to complete. | +| `--update-snapshots, -u` | - | Update any snapshots using the actual result of this test run. | +| `--verbose, -v` | - | Always show the full logs of the checks. | +| `--[no-]verify-runtime-dependencies` | - | Return an error if checks import dependencies that are not supported by the selected runtime. | ## Command Options - + The Checkly CLI configuration file. If not passed, uses the `checkly.config.ts|js` file in the current directory. @@ -52,7 +53,7 @@ npx checkly test -c="./checkly.staging.config.ts" - + [Environment variables](/cli/environment-variables) to be passed to the test run. Can be used multiple times. @@ -87,7 +88,7 @@ npx checkly test --env-file="./config/.env.production" - + Only run checks where the check name matches a regular expression. Default: `.*` @@ -100,7 +101,7 @@ npx checkly test -g="^production-.*" - + The location to run the checks at. @@ -138,7 +139,7 @@ npx checkly test --private-location="office-network" --config="./checkly.office. - + Filter the checks to be run using a comma separated list of tags. Checks will only be run if they contain all of the specified tags. Multiple `--tags` flags can be passed, in which case checks will be run if they match any of the `--tags` filters. @@ -184,7 +185,7 @@ npx checkly test --list --tags="production" - + A list of custom reporters for the test output. Options: `list|dot|ci|github|json` @@ -254,7 +255,7 @@ npx checkly test --retries 3 - + A name to use when storing results in Checkly with `--record`. @@ -279,7 +280,7 @@ npx checkly test --timeout=300 - + Update any snapshots using the actual result of this test run. @@ -294,7 +295,7 @@ npx checkly test -u - + Always show the full logs of the checks. diff --git a/constructs/overview.mdx b/constructs/overview.mdx index b52c22f8..95dcb637 100644 --- a/constructs/overview.mdx +++ b/constructs/overview.mdx @@ -150,7 +150,7 @@ If multiple projects are using the same project `logicalId`, deploying one proje The project `logicalId` can be configured in the project's [global configuration](/constructs/project). -When changing the logical ID of a project you will keep all resources on your Checkly account, unless you run [`npx checkly destroy`](/cli/checkly-destroy/) to remove the old project. +When changing the logical ID of a project you will keep all resources on your Checkly account, unless you run [`npx checkly destroy`](/cli/checkly-destroy) to remove the old project. ## Programming with Constructs diff --git a/docs.json b/docs.json index 428afa15..78f84ac6 100644 --- a/docs.json +++ b/docs.json @@ -533,23 +533,48 @@ { "group": "CLI Commands", "pages": [ - "cli/checkly-checks", - "cli/checkly-deploy", - "cli/checkly-destroy", - "cli/checkly-env", - "cli/checkly-import", - "cli/checkly-incidents", - "cli/checkly-login", - "cli/checkly-logout", - "cli/checkly-pw-test", - "cli/checkly-runtimes", "cli/checkly-skills", - "cli/checkly-status-pages", - "cli/checkly-switch", - "cli/checkly-sync-playwright", - "cli/checkly-test", - "cli/checkly-trigger", - "cli/checkly-whoami" + { + "group": "Account", + "pages": [ + "cli/checkly-login", + "cli/checkly-logout", + "cli/checkly-switch", + "cli/checkly-whoami", + "cli/checkly-runtimes" + ] + }, + { + "group": "Configure", + "pages": [ + "cli/checkly-env", + "cli/checkly-import", + "cli/checkly-sync-playwright" + ] + }, + { + "group": "Testing", + "pages": [ + "cli/checkly-test", + "cli/checkly-pw-test" + ] + }, + { + "group": "Monitoring", + "pages": [ + "cli/checkly-deploy", + "cli/checkly-destroy", + "cli/checkly-trigger", + "cli/checkly-checks" + ] + }, + { + "group": "Communicate", + "pages": [ + "cli/checkly-incidents", + "cli/checkly-status-pages" + ] + } ] } ]