From 5441b23a4cf8161caa3cffdc0fc1fa48ce34d1ab Mon Sep 17 00:00:00 2001 From: Herve Labas Date: Thu, 5 Mar 2026 12:12:20 +0100 Subject: [PATCH 1/4] docs: reorganize CLI commands into categorical folders Move CLI command reference pages into semantic subfolders: - account/ - login, logout, switch, whoami, runtimes - configure/ - env, import, sync-playwright - testing/ - test, pw-test - monitoring/ - deploy, destroy, trigger, checks - communicate/ - incidents, status-pages checkly-skills stays at the CLI root as the cross-cutting entry point. All internal links and docs.json navigation updated accordingly. Co-Authored-By: Claude Opus 4.6 --- cli/{ => account}/checkly-login.mdx | 8 +-- cli/{ => account}/checkly-logout.mdx | 8 +-- cli/{ => account}/checkly-runtimes.mdx | 4 +- cli/{ => account}/checkly-switch.mdx | 4 +- cli/{ => account}/checkly-whoami.mdx | 2 +- cli/{ => communicate}/checkly-incidents.mdx | 6 +- .../checkly-status-pages.mdx | 4 +- cli/{ => configure}/checkly-env.mdx | 4 +- cli/{ => configure}/checkly-import.mdx | 4 +- .../checkly-sync-playwright.mdx | 4 +- cli/dependencies.mdx | 2 +- cli/environment-variables.mdx | 6 +- cli/{ => monitoring}/checkly-checks.mdx | 6 +- cli/{ => monitoring}/checkly-deploy.mdx | 4 +- cli/{ => monitoring}/checkly-destroy.mdx | 4 +- cli/{ => monitoring}/checkly-trigger.mdx | 6 +- cli/{ => testing}/checkly-pw-test.mdx | 4 +- cli/{ => testing}/checkly-test.mdx | 6 +- constructs/check-group-v2.mdx | 2 +- constructs/overview.mdx | 2 +- .../browser-checks/performance-metrics.mdx | 2 +- .../browser-checks/playwright-support.mdx | 2 +- detect/testing/overview.mdx | 2 +- docs.json | 57 +++++++++++++------ guides/playwright-testing-to-monitoring.mdx | 4 +- quickstarts/playwright-check.mdx | 2 +- 26 files changed, 92 insertions(+), 67 deletions(-) rename cli/{ => account}/checkly-login.mdx (91%) rename cli/{ => account}/checkly-logout.mdx (79%) rename cli/{ => account}/checkly-runtimes.mdx (94%) rename cli/{ => account}/checkly-switch.mdx (93%) rename cli/{ => account}/checkly-whoami.mdx (92%) rename cli/{ => communicate}/checkly-incidents.mdx (97%) rename cli/{ => communicate}/checkly-status-pages.mdx (95%) rename cli/{ => configure}/checkly-env.mdx (96%) rename cli/{ => configure}/checkly-import.mdx (96%) rename cli/{ => configure}/checkly-sync-playwright.mdx (95%) rename cli/{ => monitoring}/checkly-checks.mdx (95%) rename cli/{ => monitoring}/checkly-deploy.mdx (97%) rename cli/{ => monitoring}/checkly-destroy.mdx (93%) rename cli/{ => monitoring}/checkly-trigger.mdx (96%) rename cli/{ => testing}/checkly-pw-test.mdx (98%) rename cli/{ => testing}/checkly-test.mdx (97%) diff --git a/cli/checkly-login.mdx b/cli/account/checkly-login.mdx similarity index 91% rename from cli/checkly-login.mdx rename to cli/account/checkly-login.mdx index 1a46d804..c44af2b5 100644 --- a/cli/checkly-login.mdx +++ b/cli/account/checkly-login.mdx @@ -90,10 +90,10 @@ If the authentication browser window doesn't open: If you have access to multiple Checkly accounts, you'll be prompted to select which account to use as the active account for CLI operations. -You can also switch accounts later using [`checkly switch`](/cli/checkly-switch). +You can also switch accounts later using [`checkly switch`](/cli/account/checkly-switch). ## Related Commands -- [`checkly logout`](/cli/checkly-logout) - Sign out of your Checkly account -- [`checkly whoami`](/cli/checkly-whoami) - Display current account information -- [`checkly switch`](/cli/checkly-switch) - Switch between multiple accounts +- [`checkly logout`](/cli/account/checkly-logout) - Sign out of your Checkly account +- [`checkly whoami`](/cli/account/checkly-whoami) - Display current account information +- [`checkly switch`](/cli/account/checkly-switch) - Switch between multiple accounts diff --git a/cli/checkly-logout.mdx b/cli/account/checkly-logout.mdx similarity index 79% rename from cli/checkly-logout.mdx rename to cli/account/checkly-logout.mdx index 14c84cfe..6267c817 100644 --- a/cli/checkly-logout.mdx +++ b/cli/account/checkly-logout.mdx @@ -70,10 +70,10 @@ The command removes authentication tokens stored locally in: ## After Logout -Once logged out, you'll need to run [`checkly login`](/cli/checkly-login) before using other CLI commands that require authentication. +Once logged out, you'll need to run [`checkly login`](/cli/account/checkly-login) before using other CLI commands that require authentication. ## Related Commands -- [`checkly login`](/cli/checkly-login) - Authenticate with your Checkly account -- [`checkly whoami`](/cli/checkly-whoami) - Display current account information -- [`checkly switch`](/cli/checkly-switch) - Switch between multiple accounts +- [`checkly login`](/cli/account/checkly-login) - Authenticate with your Checkly account +- [`checkly whoami`](/cli/account/checkly-whoami) - Display current account information +- [`checkly switch`](/cli/account/checkly-switch) - Switch between multiple accounts diff --git a/cli/checkly-runtimes.mdx b/cli/account/checkly-runtimes.mdx similarity index 94% rename from cli/checkly-runtimes.mdx rename to cli/account/checkly-runtimes.mdx index a318ebde..add472ba 100644 --- a/cli/checkly-runtimes.mdx +++ b/cli/account/checkly-runtimes.mdx @@ -119,5 +119,5 @@ Check the [Checkly changelog](https://feedback.checklyhq.com/changelog) for runt ## Related Commands -- [`checkly test`](/cli/checkly-test) - Test checks with current runtime -- [`checkly deploy`](/cli/checkly-deploy) - Deploy checks to specified runtime +- [`checkly test`](/cli/testing/checkly-test) - Test checks with current runtime +- [`checkly deploy`](/cli/monitoring/checkly-deploy) - Deploy checks to specified runtime 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..40c5ced9 100644 --- a/cli/checkly-switch.mdx +++ b/cli/account/checkly-switch.mdx @@ -90,5 +90,5 @@ If an expected account doesn't appear: ## Related Commands -- [`checkly login`](/cli/checkly-login) - Sign in to your Checkly account -- [`checkly whoami`](/cli/checkly-whoami) - Display current account information +- [`checkly login`](/cli/account/checkly-login) - Sign in to your Checkly account +- [`checkly whoami`](/cli/account/checkly-whoami) - Display current account information diff --git a/cli/checkly-whoami.mdx b/cli/account/checkly-whoami.mdx similarity index 92% rename from cli/checkly-whoami.mdx rename to cli/account/checkly-whoami.mdx index 203ea691..7f4dabb6 100644 --- a/cli/checkly-whoami.mdx +++ b/cli/account/checkly-whoami.mdx @@ -40,4 +40,4 @@ environment variables to setup authentication. ## Related Commands -- [`checkly login`](/cli/checkly-login) - Sign in to your Checkly account +- [`checkly login`](/cli/account/checkly-login) - Sign in to your Checkly account diff --git a/cli/checkly-incidents.mdx b/cli/communicate/checkly-incidents.mdx similarity index 97% rename from cli/checkly-incidents.mdx rename to cli/communicate/checkly-incidents.mdx index e3cf1d60..95fd37b2 100644 --- a/cli/checkly-incidents.mdx +++ b/cli/communicate/checkly-incidents.mdx @@ -425,6 +425,6 @@ npx checkly incidents resolve --no-notify-subscribers ## Related Commands -- [`checkly status-pages`](/cli/checkly-status-pages) - List and inspect status pages -- [`checkly checks`](/cli/checkly-checks) - List and inspect checks -- [`checkly whoami`](/cli/checkly-whoami) - Display current account information +- [`checkly status-pages`](/cli/communicate/checkly-status-pages) - List and inspect status pages +- [`checkly checks`](/cli/monitoring/checkly-checks) - List and inspect checks +- [`checkly whoami`](/cli/account/checkly-whoami) - Display current account information diff --git a/cli/checkly-status-pages.mdx b/cli/communicate/checkly-status-pages.mdx similarity index 95% rename from cli/checkly-status-pages.mdx rename to cli/communicate/checkly-status-pages.mdx index c35927e7..18d41df9 100644 --- a/cli/checkly-status-pages.mdx +++ b/cli/communicate/checkly-status-pages.mdx @@ -166,5 +166,5 @@ npx checkly status-pages get 12345 --output=json ## Related Commands -- [`checkly checks`](/cli/checkly-checks) - List and inspect checks -- [`checkly whoami`](/cli/checkly-whoami) - Display current account information +- [`checkly checks`](/cli/monitoring/checkly-checks) - List and inspect checks +- [`checkly whoami`](/cli/account/checkly-whoami) - Display current account information diff --git a/cli/checkly-env.mdx b/cli/configure/checkly-env.mdx similarity index 96% rename from cli/checkly-env.mdx rename to cli/configure/checkly-env.mdx index 1ab5856e..c60162f4 100644 --- a/cli/checkly-env.mdx +++ b/cli/configure/checkly-env.mdx @@ -208,5 +208,5 @@ For check-specific or group-specific variables, use the web UI or configure them ## Related Commands -- [`checkly test`](/cli/checkly-test) - Test your setup before deployment -- [`checkly deploy`](/cli/checkly-deploy) - Deploy your Checkly configuration +- [`checkly test`](/cli/testing/checkly-test) - Test your setup before deployment +- [`checkly deploy`](/cli/monitoring/checkly-deploy) - Deploy your Checkly configuration diff --git a/cli/checkly-import.mdx b/cli/configure/checkly-import.mdx similarity index 96% rename from cli/checkly-import.mdx rename to cli/configure/checkly-import.mdx index 5508a303..f92a6db8 100644 --- a/cli/checkly-import.mdx +++ b/cli/configure/checkly-import.mdx @@ -162,5 +162,5 @@ npx checkly import cancel ## Related Commands -- [`checkly deploy`](/cli/checkly-deploy) - Deploy imported resources -- [`checkly test`](/cli/checkly-test) - Test imported checks locally +- [`checkly deploy`](/cli/monitoring/checkly-deploy) - Deploy imported resources +- [`checkly test`](/cli/testing/checkly-test) - Test imported checks locally diff --git a/cli/checkly-sync-playwright.mdx b/cli/configure/checkly-sync-playwright.mdx similarity index 95% rename from cli/checkly-sync-playwright.mdx rename to cli/configure/checkly-sync-playwright.mdx index 34d76121..9fc93dc0 100644 --- a/cli/checkly-sync-playwright.mdx +++ b/cli/configure/checkly-sync-playwright.mdx @@ -128,5 +128,5 @@ The following Playwright config values are supported and will be synced: ## Related Commands -- [`checkly test`](/cli/checkly-test) - Test with synchronized configuration -- [`checkly deploy`](/cli/checkly-deploy) - Deploy with updated settings +- [`checkly test`](/cli/testing/checkly-test) - Test with synchronized configuration +- [`checkly deploy`](/cli/monitoring/checkly-deploy) - Deploy with updated settings diff --git a/cli/dependencies.mdx b/cli/dependencies.mdx index 4a9ac2ab..e71dd818 100644 --- a/cli/dependencies.mdx +++ b/cli/dependencies.mdx @@ -91,7 +91,7 @@ new BrowserCheck('login-check', { }) ``` -After running [`npx checkly deploy`](/cli/checkly-deploy), you can see in the Web UI that the helper file `login-helper.ts` was also uploaded for this Check. +After running [`npx checkly deploy`](/cli/monitoring/checkly-deploy), you can see in the Web UI that the helper file `login-helper.ts` was also uploaded for this Check. ![login check with helper file in dependencies](/images/docs/images/cli/local-dependency.png) diff --git a/cli/environment-variables.mdx b/cli/environment-variables.mdx index b3719103..7bd97f1b 100644 --- a/cli/environment-variables.mdx +++ b/cli/environment-variables.mdx @@ -130,12 +130,12 @@ You can reference that file in the `test` as follows: npx checkly test --env-file="./.env" ``` -You can also pull in the variables from your account and store them in a file using [the `npx checkly env pull` command](/cli/checkly-env#pull). +You can also pull in the variables from your account and store them in a file using [the `npx checkly env pull` command](/cli/configure/checkly-env#pull). See the examples below. ### Managing Remote Environment Variables -Manage your remote environment variables with the CLI using the [`checkly env` command](/cli/checkly-env). You can list, add, update, remove +Manage your remote environment variables with the CLI using the [`checkly env` command](/cli/configure/checkly-env). You can list, add, update, remove and export your global variables. List all your stored variables and lock it. @@ -158,7 +158,7 @@ npx checkly env pull .env.prod Reference that file in your `test` command. -[See the full reference documentation for the `checkly env` command](/cli/checkly-env). +[See the full reference documentation for the `checkly env` command](/cli/configure/checkly-env). ## Securing Environment Variables diff --git a/cli/checkly-checks.mdx b/cli/monitoring/checkly-checks.mdx similarity index 95% rename from cli/checkly-checks.mdx rename to cli/monitoring/checkly-checks.mdx index ecb598d2..20126387 100644 --- a/cli/checkly-checks.mdx +++ b/cli/monitoring/checkly-checks.mdx @@ -275,6 +275,6 @@ npx checkly checks get 12345 --results-limit=25 ## Related Commands -- [`checkly status-pages`](/cli/checkly-status-pages) - List and inspect status pages -- [`checkly trigger`](/cli/checkly-trigger) - Trigger checks on-demand -- [`checkly whoami`](/cli/checkly-whoami) - Display current account information +- [`checkly status-pages`](/cli/communicate/checkly-status-pages) - List and inspect status pages +- [`checkly trigger`](/cli/monitoring/checkly-trigger) - Trigger checks on-demand +- [`checkly whoami`](/cli/account/checkly-whoami) - Display current account information diff --git a/cli/checkly-deploy.mdx b/cli/monitoring/checkly-deploy.mdx similarity index 97% rename from cli/checkly-deploy.mdx rename to cli/monitoring/checkly-deploy.mdx index eae5de32..60863323 100644 --- a/cli/checkly-deploy.mdx +++ b/cli/monitoring/checkly-deploy.mdx @@ -180,5 +180,5 @@ The Checkly CLI evaluates Git information from your local or CI environment on a ## Related Commands -- [`checkly login`](/cli/checkly-login) - Log in to your Checkly account -- [`checkly test`](/cli/checkly-test) - Test your setup before deployment +- [`checkly login`](/cli/account/checkly-login) - Log in to your Checkly account +- [`checkly test`](/cli/testing/checkly-test) - Test your setup before deployment diff --git a/cli/checkly-destroy.mdx b/cli/monitoring/checkly-destroy.mdx similarity index 93% rename from cli/checkly-destroy.mdx rename to cli/monitoring/checkly-destroy.mdx index b1183296..9942ffbb 100644 --- a/cli/checkly-destroy.mdx +++ b/cli/monitoring/checkly-destroy.mdx @@ -86,5 +86,5 @@ Please confirm by typing the project name "Website Monitoring": ## Related Commands -- [`checkly deploy`](/cli/checkly-deploy) - Deploy resources to Checkly -- [`checkly test`](/cli/checkly-test) - Test your setup before deployment +- [`checkly deploy`](/cli/monitoring/checkly-deploy) - Deploy resources to Checkly +- [`checkly test`](/cli/testing/checkly-test) - Test your setup before deployment diff --git a/cli/checkly-trigger.mdx b/cli/monitoring/checkly-trigger.mdx similarity index 96% rename from cli/checkly-trigger.mdx rename to cli/monitoring/checkly-trigger.mdx index 53b4c2c2..1ff60faa 100644 --- a/cli/checkly-trigger.mdx +++ b/cli/monitoring/checkly-trigger.mdx @@ -347,9 +347,9 @@ Run your deployed checks before promoting code to production: npx checkly trigger --tags staging --record --test-session-name "Pre-prod validation" ``` -If your production deployment includes monitoring changes and updates, [use `npx checkly test`](/cli/checkly-test) to validate your preview environment with the updated monitoring configuration. +If your production deployment includes monitoring changes and updates, [use `npx checkly test`](/cli/testing/checkly-test) to validate your preview environment with the updated monitoring configuration. ## Related Commands -- [`checkly deploy`](/cli/checkly-deploy) - Deploy your Checkly configuration -- [`checkly test`](/cli/checkly-test) - Test your setup before deployment +- [`checkly deploy`](/cli/monitoring/checkly-deploy) - Deploy your Checkly configuration +- [`checkly test`](/cli/testing/checkly-test) - Test your setup before deployment diff --git a/cli/checkly-pw-test.mdx b/cli/testing/checkly-pw-test.mdx similarity index 98% rename from cli/checkly-pw-test.mdx rename to cli/testing/checkly-pw-test.mdx index 6d65b999..b91e311c 100644 --- a/cli/checkly-pw-test.mdx +++ b/cli/testing/checkly-pw-test.mdx @@ -393,5 +393,5 @@ npx checkly pw-test -- test.spec.ts ## Related Commands -- [`checkly test`](/cli/checkly-test) - Test your setup before deployment -- [`checkly deploy`](/cli/checkly-deploy) - Deploy your Checkly configuration +- [`checkly test`](/cli/testing/checkly-test) - Test your setup before deployment +- [`checkly deploy`](/cli/monitoring/checkly-deploy) - Deploy your Checkly configuration diff --git a/cli/checkly-test.mdx b/cli/testing/checkly-test.mdx similarity index 97% rename from cli/checkly-test.mdx rename to cli/testing/checkly-test.mdx index e41a1c39..0c246447 100644 --- a/cli/checkly-test.mdx +++ b/cli/testing/checkly-test.mdx @@ -358,6 +358,6 @@ npx checkly test --env ENVIRONMENT_URL="https://preview.acme.com" --env PASSWORD ## Related Commands -- [`checkly pw-test`](/cli/checkly-pw-test) - Run Playwright tests in the Checkly cloud -- [`checkly trigger`](/cli/checkly-trigger) - Run deployed checks on-demand -- [`checkly deploy`](/cli/checkly-deploy) - Deploy your application +- [`checkly pw-test`](/cli/testing/checkly-pw-test) - Run Playwright tests in the Checkly cloud +- [`checkly trigger`](/cli/monitoring/checkly-trigger) - Run deployed checks on-demand +- [`checkly deploy`](/cli/monitoring/checkly-deploy) - Deploy your application diff --git a/constructs/check-group-v2.mdx b/constructs/check-group-v2.mdx index f1829499..d2d44b91 100644 --- a/constructs/check-group-v2.mdx +++ b/constructs/check-group-v2.mdx @@ -263,7 +263,7 @@ When referencing existing groups with `fromId()`, note: - You cannot filter tests by group tags since group properties aren't available locally - Checks won't inherit the group's frequency. This only works for groups defined in the CLI project -If you need these features, you can either import the group using the [Checkly import feature](/cli/checkly-import) (e.g. `npx checkly import check-group:123`) or define a new group directly in your project. +If you need these features, you can either import the group using the [Checkly import feature](/cli/configure/checkly-import) (e.g. `npx checkly import check-group:123`) or define a new group directly in your project. ## Shared Settings in Groups with Different Monitor Types diff --git a/constructs/overview.mdx b/constructs/overview.mdx index b52c22f8..9581c8b5 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/monitoring/checkly-destroy/) to remove the old project. ## Programming with Constructs diff --git a/detect/synthetic-monitoring/browser-checks/performance-metrics.mdx b/detect/synthetic-monitoring/browser-checks/performance-metrics.mdx index 7729f580..94b44e2b 100644 --- a/detect/synthetic-monitoring/browser-checks/performance-metrics.mdx +++ b/detect/synthetic-monitoring/browser-checks/performance-metrics.mdx @@ -23,7 +23,7 @@ Checkly automatically collect Network Waterfalls & Performance signals (**Web Vi Checkly only collects tracing and web vitals data if your browser check meets the following criteria: - It is based on **Playwright**. -- It runs on any **runtime above [2021.06](/cli/checkly-runtimes)** +- It runs on any **runtime above [2021.06](/cli/account/checkly-runtimes)** diff --git a/detect/synthetic-monitoring/browser-checks/playwright-support.mdx b/detect/synthetic-monitoring/browser-checks/playwright-support.mdx index 1315703d..5a4868f4 100644 --- a/detect/synthetic-monitoring/browser-checks/playwright-support.mdx +++ b/detect/synthetic-monitoring/browser-checks/playwright-support.mdx @@ -168,7 +168,7 @@ There are three things you should be aware of: If you have an existing `playwright.config.ts` or `playwright.config.js` file in your project that you want to import, -you can simply run the [sync-playwright](/cli/checkly-sync-playwright) +you can simply run the [sync-playwright](/cli/configure/checkly-sync-playwright) ```bash npx checkly sync-playwright diff --git a/detect/testing/overview.mdx b/detect/testing/overview.mdx index dc32e57a..5a17b2b8 100644 --- a/detect/testing/overview.mdx +++ b/detect/testing/overview.mdx @@ -77,7 +77,7 @@ Customize the dependency installation step for the cloud environment: npx checkly pw-test --installCommand='npm install --no-scripts' ``` -Learn more in the [`checkly pw-test` CLI reference](/cli/checkly-pw-test). +Learn more in the [`checkly pw-test` CLI reference](/cli/testing/checkly-pw-test). ## Analyze local test results diff --git a/docs.json b/docs.json index 428afa15..59f9da7b 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/account/checkly-login", + "cli/account/checkly-logout", + "cli/account/checkly-switch", + "cli/account/checkly-whoami", + "cli/account/checkly-runtimes" + ] + }, + { + "group": "Configure", + "pages": [ + "cli/configure/checkly-env", + "cli/configure/checkly-import", + "cli/configure/checkly-sync-playwright" + ] + }, + { + "group": "Testing", + "pages": [ + "cli/testing/checkly-test", + "cli/testing/checkly-pw-test" + ] + }, + { + "group": "Monitoring", + "pages": [ + "cli/monitoring/checkly-deploy", + "cli/monitoring/checkly-destroy", + "cli/monitoring/checkly-trigger", + "cli/monitoring/checkly-checks" + ] + }, + { + "group": "Communicate", + "pages": [ + "cli/communicate/checkly-incidents", + "cli/communicate/checkly-status-pages" + ] + } ] } ] diff --git a/guides/playwright-testing-to-monitoring.mdx b/guides/playwright-testing-to-monitoring.mdx index 0b4028c3..23e15196 100644 --- a/guides/playwright-testing-to-monitoring.mdx +++ b/guides/playwright-testing-to-monitoring.mdx @@ -98,7 +98,7 @@ Here's how Checkly enhances the process of releasing new code: 1. **Write the Playwright Script**: Automate the login, product search, and checkout steps. Run initial tests through the Checkly network to make sure it's working from all your users' geo-locations. 2. **Configure Monitoring Settings**: Define how often the script should run (e.g., every 15 minutes) and from which locations (e.g., Ireland, Frankfurt). 3. **Set Up Alerts**: Notify your team if a Playwright test fails, ensuring quick resolution of issues. -4. **Deploy to Production**: Use [Checkly's CLI to deploy](/cli/checkly-deploy) your Playwright tests and start monitoring your production environment. +4. **Deploy to Production**: Use [Checkly's CLI to deploy](/cli/monitoring/checkly-deploy) your Playwright tests and start monitoring your production environment. With Checkly running your Playwright monitors, you can find and resolve issues before your users are affected. @@ -116,7 +116,7 @@ If you want to learn how to apply different Playwright settings depending on the Once your Playwright tests run locally, in CI/CD, and as scheduled monitors, they need to be aware of their execution environment. -A local Playwright test executed with `npx playwright test` needs to target `localhost`, a CI/CD test run via [`npx checkly pw-test`](/cli/checkly-pw-test) or [`npx checkly test`](/cli/checkly-test) needs to target environment-specific preview URLs, and global production monitoring might need to be aware of its execution region. +A local Playwright test executed with `npx playwright test` needs to target `localhost`, a CI/CD test run via [`npx checkly pw-test`](/cli/testing/checkly-pw-test) or [`npx checkly test`](/cli/testing/checkly-test) needs to target environment-specific preview URLs, and global production monitoring might need to be aware of its execution region. To differentiate your Playwright test runs in Checkly, use the [provided environment variables](/detect/synthetic-monitoring/playwright-checks/environment-variables). diff --git a/quickstarts/playwright-check.mdx b/quickstarts/playwright-check.mdx index f40e0724..ebf92707 100644 --- a/quickstarts/playwright-check.mdx +++ b/quickstarts/playwright-check.mdx @@ -140,7 +140,7 @@ npx checkly test --record --env ENVIRONMENT=staging **Difference between `checkly test` and `checkly pw-test`:** - `checkly test` - Runs check suites defined in `checkly.config.ts` and `check.ts` files -- `checkly pw-test` - Runs any Playwright tests defined in your `playwright.config.ts`, directly on Checkly's cloud infrastructure. See the [CLI reference](/cli/checkly-pw-test). +- `checkly pw-test` - Runs any Playwright tests defined in your `playwright.config.ts`, directly on Checkly's cloud infrastructure. See the [CLI reference](/cli/testing/checkly-pw-test). ## Step 5: Deploy to Production Monitoring From 432915c5e82fa5fb4800d906ff7e591f3a077dcb Mon Sep 17 00:00:00 2001 From: Herve Labas Date: Thu, 5 Mar 2026 12:29:34 +0100 Subject: [PATCH 2/4] docs: standardize CLI command reference consistency MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Add Required column to all options tables across all command pages - Standardize argument names to lowercase (ID → id) - Fix ResponseField short flag pattern to use name="--flag, -f" everywhere - Add missing type attributes to ResponseFields (trigger, pw-test) - Add missing related commands to checkly-whoami Co-Authored-By: Claude Opus 4.6 --- cli/account/checkly-logout.mdx | 6 +-- cli/account/checkly-switch.mdx | 6 +-- cli/account/checkly-whoami.mdx | 2 + cli/communicate/checkly-incidents.mdx | 2 +- cli/communicate/checkly-status-pages.mdx | 20 ++++----- cli/configure/checkly-env.mdx | 28 ++++++------ cli/configure/checkly-import.mdx | 8 ++-- cli/monitoring/checkly-checks.mdx | 34 +++++++-------- cli/monitoring/checkly-deploy.mdx | 18 ++++---- cli/monitoring/checkly-destroy.mdx | 8 ++-- cli/monitoring/checkly-trigger.mdx | 44 +++++++++---------- cli/testing/checkly-pw-test.mdx | 42 +++++++++--------- cli/testing/checkly-test.mdx | 54 ++++++++++++------------ 13 files changed, 137 insertions(+), 135 deletions(-) diff --git a/cli/account/checkly-logout.mdx b/cli/account/checkly-logout.mdx index 6267c817..29cbb239 100644 --- a/cli/account/checkly-logout.mdx +++ b/cli/account/checkly-logout.mdx @@ -23,9 +23,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/account/checkly-switch.mdx b/cli/account/checkly-switch.mdx index 40c5ced9..d0dd4221 100644 --- a/cli/account/checkly-switch.mdx +++ b/cli/account/checkly-switch.mdx @@ -23,9 +23,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/account/checkly-whoami.mdx b/cli/account/checkly-whoami.mdx index 7f4dabb6..f56429aa 100644 --- a/cli/account/checkly-whoami.mdx +++ b/cli/account/checkly-whoami.mdx @@ -41,3 +41,5 @@ environment variables to setup authentication. ## Related Commands - [`checkly login`](/cli/account/checkly-login) - Sign in to your Checkly account +- [`checkly logout`](/cli/account/checkly-logout) - Sign out of your Checkly account +- [`checkly switch`](/cli/account/checkly-switch) - Switch between multiple accounts diff --git a/cli/communicate/checkly-incidents.mdx b/cli/communicate/checkly-incidents.mdx index 95fd37b2..d8ea89d0 100644 --- a/cli/communicate/checkly-incidents.mdx +++ b/cli/communicate/checkly-incidents.mdx @@ -362,7 +362,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/communicate/checkly-status-pages.mdx b/cli/communicate/checkly-status-pages.mdx index 18d41df9..09c32cef 100644 --- a/cli/communicate/checkly-status-pages.mdx +++ b/cli/communicate/checkly-status-pages.mdx @@ -42,12 +42,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 +131,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/configure/checkly-env.mdx b/cli/configure/checkly-env.mdx index c60162f4..3affb0b3 100644 --- a/cli/configure/checkly-env.mdx +++ b/cli/configure/checkly-env.mdx @@ -40,10 +40,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 +70,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 +119,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 +148,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/configure/checkly-import.mdx b/cli/configure/checkly-import.mdx index f92a6db8..d38f8969 100644 --- a/cli/configure/checkly-import.mdx +++ b/cli/configure/checkly-import.mdx @@ -48,10 +48,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/monitoring/checkly-checks.mdx b/cli/monitoring/checkly-checks.mdx index 20126387..56681b8b 100644 --- a/cli/monitoring/checkly-checks.mdx +++ b/cli/monitoring/checkly-checks.mdx @@ -42,15 +42,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 +177,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/monitoring/checkly-deploy.mdx b/cli/monitoring/checkly-deploy.mdx index 60863323..675827e5 100644 --- a/cli/monitoring/checkly-deploy.mdx +++ b/cli/monitoring/checkly-deploy.mdx @@ -19,15 +19,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/monitoring/checkly-destroy.mdx b/cli/monitoring/checkly-destroy.mdx index 9942ffbb..ed77c999 100644 --- a/cli/monitoring/checkly-destroy.mdx +++ b/cli/monitoring/checkly-destroy.mdx @@ -22,10 +22,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/monitoring/checkly-trigger.mdx b/cli/monitoring/checkly-trigger.mdx index 1ff60faa..373a8293 100644 --- a/cli/monitoring/checkly-trigger.mdx +++ b/cli/monitoring/checkly-trigger.mdx @@ -18,25 +18,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 +49,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 +99,7 @@ The dotenv file should contain KEY=value pairs, one per line. - + The location to run the checks at. **Usage:** @@ -138,7 +138,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 +165,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 +177,7 @@ npx checkly trigger --record --test-session-name="Custom session name" - + Custom reporters for test output formatting. @@ -210,7 +210,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/testing/checkly-pw-test.mdx b/cli/testing/checkly-pw-test.mdx index b91e311c..222c0159 100644 --- a/cli/testing/checkly-pw-test.mdx +++ b/cli/testing/checkly-pw-test.mdx @@ -32,32 +32,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 +123,7 @@ const config = defineConfig({ - + Pass environment variables to the test run. Can be specified multiple times to set multiple variables. diff --git a/cli/testing/checkly-test.mdx b/cli/testing/checkly-test.mdx index 0c246447..66f7c8c8 100644 --- a/cli/testing/checkly-test.mdx +++ b/cli/testing/checkly-test.mdx @@ -18,28 +18,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 +52,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 +87,7 @@ npx checkly test --env-file="./config/.env.production" - + Only run checks where the check name matches a regular expression. Default: `.*` @@ -100,7 +100,7 @@ npx checkly test -g="^production-.*" - + The location to run the checks at. @@ -138,7 +138,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 +184,7 @@ npx checkly test --list --tags="production" - + A list of custom reporters for the test output. Options: `list|dot|ci|github|json` @@ -254,7 +254,7 @@ npx checkly test --retries 3 - + A name to use when storing results in Checkly with `--record`. @@ -279,7 +279,7 @@ npx checkly test --timeout=300 - + Update any snapshots using the actual result of this test run. @@ -294,7 +294,7 @@ npx checkly test -u - + Always show the full logs of the checks. From 66d9a36cc73d30d53640bc961081e7275f74de9a Mon Sep 17 00:00:00 2001 From: Herve Labas Date: Thu, 5 Mar 2026 12:32:13 +0100 Subject: [PATCH 3/4] docs: add slug frontmatter to preserve URLs after folder reorganization Adds slug field to all moved command pages so URLs remain at /cli/checkly-* regardless of folder structure. Reverts internal links back to the original slug-based paths. Co-Authored-By: Claude Opus 4.6 --- cli/account/checkly-login.mdx | 9 +++++---- cli/account/checkly-logout.mdx | 9 +++++---- cli/account/checkly-runtimes.mdx | 5 +++-- cli/account/checkly-switch.mdx | 5 +++-- cli/account/checkly-whoami.mdx | 7 ++++--- cli/communicate/checkly-incidents.mdx | 7 ++++--- cli/communicate/checkly-status-pages.mdx | 5 +++-- cli/configure/checkly-env.mdx | 5 +++-- cli/configure/checkly-import.mdx | 5 +++-- cli/configure/checkly-sync-playwright.mdx | 5 +++-- cli/dependencies.mdx | 2 +- cli/environment-variables.mdx | 6 +++--- cli/monitoring/checkly-checks.mdx | 7 ++++--- cli/monitoring/checkly-deploy.mdx | 5 +++-- cli/monitoring/checkly-destroy.mdx | 5 +++-- cli/monitoring/checkly-trigger.mdx | 7 ++++--- cli/testing/checkly-pw-test.mdx | 5 +++-- cli/testing/checkly-test.mdx | 7 ++++--- constructs/check-group-v2.mdx | 2 +- constructs/overview.mdx | 2 +- .../browser-checks/performance-metrics.mdx | 2 +- .../browser-checks/playwright-support.mdx | 2 +- detect/testing/overview.mdx | 2 +- guides/playwright-testing-to-monitoring.mdx | 4 ++-- quickstarts/playwright-check.mdx | 2 +- 25 files changed, 69 insertions(+), 53 deletions(-) diff --git a/cli/account/checkly-login.mdx b/cli/account/checkly-login.mdx index c44af2b5..65f56929 100644 --- a/cli/account/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. @@ -90,10 +91,10 @@ If the authentication browser window doesn't open: If you have access to multiple Checkly accounts, you'll be prompted to select which account to use as the active account for CLI operations. -You can also switch accounts later using [`checkly switch`](/cli/account/checkly-switch). +You can also switch accounts later using [`checkly switch`](/cli/checkly-switch). ## Related Commands -- [`checkly logout`](/cli/account/checkly-logout) - Sign out of your Checkly account -- [`checkly whoami`](/cli/account/checkly-whoami) - Display current account information -- [`checkly switch`](/cli/account/checkly-switch) - Switch between multiple accounts +- [`checkly logout`](/cli/checkly-logout) - Sign out of your Checkly account +- [`checkly whoami`](/cli/checkly-whoami) - Display current account information +- [`checkly switch`](/cli/checkly-switch) - Switch between multiple accounts diff --git a/cli/account/checkly-logout.mdx b/cli/account/checkly-logout.mdx index 29cbb239..fbbac8d4 100644 --- a/cli/account/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. @@ -70,10 +71,10 @@ The command removes authentication tokens stored locally in: ## After Logout -Once logged out, you'll need to run [`checkly login`](/cli/account/checkly-login) before using other CLI commands that require authentication. +Once logged out, you'll need to run [`checkly login`](/cli/checkly-login) before using other CLI commands that require authentication. ## Related Commands -- [`checkly login`](/cli/account/checkly-login) - Authenticate with your Checkly account -- [`checkly whoami`](/cli/account/checkly-whoami) - Display current account information -- [`checkly switch`](/cli/account/checkly-switch) - Switch between multiple accounts +- [`checkly login`](/cli/checkly-login) - Authenticate with your Checkly account +- [`checkly whoami`](/cli/checkly-whoami) - Display current account information +- [`checkly switch`](/cli/checkly-switch) - Switch between multiple accounts diff --git a/cli/account/checkly-runtimes.mdx b/cli/account/checkly-runtimes.mdx index add472ba..58395e73 100644 --- a/cli/account/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. @@ -119,5 +120,5 @@ Check the [Checkly changelog](https://feedback.checklyhq.com/changelog) for runt ## Related Commands -- [`checkly test`](/cli/testing/checkly-test) - Test checks with current runtime -- [`checkly deploy`](/cli/monitoring/checkly-deploy) - Deploy checks to specified runtime +- [`checkly test`](/cli/checkly-test) - Test checks with current runtime +- [`checkly deploy`](/cli/checkly-deploy) - Deploy checks to specified runtime diff --git a/cli/account/checkly-switch.mdx b/cli/account/checkly-switch.mdx index d0dd4221..370933b2 100644 --- a/cli/account/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. @@ -90,5 +91,5 @@ If an expected account doesn't appear: ## Related Commands -- [`checkly login`](/cli/account/checkly-login) - Sign in to your Checkly account -- [`checkly whoami`](/cli/account/checkly-whoami) - Display current account information +- [`checkly login`](/cli/checkly-login) - Sign in to your Checkly account +- [`checkly whoami`](/cli/checkly-whoami) - Display current account information diff --git a/cli/account/checkly-whoami.mdx b/cli/account/checkly-whoami.mdx index f56429aa..cf767f89 100644 --- a/cli/account/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. @@ -40,6 +41,6 @@ environment variables to setup authentication. ## Related Commands -- [`checkly login`](/cli/account/checkly-login) - Sign in to your Checkly account -- [`checkly logout`](/cli/account/checkly-logout) - Sign out of your Checkly account -- [`checkly switch`](/cli/account/checkly-switch) - Switch between multiple accounts +- [`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/communicate/checkly-incidents.mdx b/cli/communicate/checkly-incidents.mdx index d8ea89d0..5926c76e 100644 --- a/cli/communicate/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. @@ -425,6 +426,6 @@ npx checkly incidents resolve --no-notify-subscribers ## Related Commands -- [`checkly status-pages`](/cli/communicate/checkly-status-pages) - List and inspect status pages -- [`checkly checks`](/cli/monitoring/checkly-checks) - List and inspect checks -- [`checkly whoami`](/cli/account/checkly-whoami) - Display current account information +- [`checkly status-pages`](/cli/checkly-status-pages) - List and inspect status pages +- [`checkly checks`](/cli/checkly-checks) - List and inspect checks +- [`checkly whoami`](/cli/checkly-whoami) - Display current account information diff --git a/cli/communicate/checkly-status-pages.mdx b/cli/communicate/checkly-status-pages.mdx index 09c32cef..6f1cb235 100644 --- a/cli/communicate/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. @@ -166,5 +167,5 @@ npx checkly status-pages get 12345 --output=json ## Related Commands -- [`checkly checks`](/cli/monitoring/checkly-checks) - List and inspect checks -- [`checkly whoami`](/cli/account/checkly-whoami) - Display current account information +- [`checkly checks`](/cli/checkly-checks) - List and inspect checks +- [`checkly whoami`](/cli/checkly-whoami) - Display current account information diff --git a/cli/configure/checkly-env.mdx b/cli/configure/checkly-env.mdx index 3affb0b3..b922aa6f 100644 --- a/cli/configure/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'; @@ -208,5 +209,5 @@ For check-specific or group-specific variables, use the web UI or configure them ## Related Commands -- [`checkly test`](/cli/testing/checkly-test) - Test your setup before deployment -- [`checkly deploy`](/cli/monitoring/checkly-deploy) - Deploy your Checkly configuration +- [`checkly test`](/cli/checkly-test) - Test your setup before deployment +- [`checkly deploy`](/cli/checkly-deploy) - Deploy your Checkly configuration diff --git a/cli/configure/checkly-import.mdx b/cli/configure/checkly-import.mdx index d38f8969..fbcf6442 100644 --- a/cli/configure/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. @@ -162,5 +163,5 @@ npx checkly import cancel ## Related Commands -- [`checkly deploy`](/cli/monitoring/checkly-deploy) - Deploy imported resources -- [`checkly test`](/cli/testing/checkly-test) - Test imported checks locally +- [`checkly deploy`](/cli/checkly-deploy) - Deploy imported resources +- [`checkly test`](/cli/checkly-test) - Test imported checks locally diff --git a/cli/configure/checkly-sync-playwright.mdx b/cli/configure/checkly-sync-playwright.mdx index 9fc93dc0..7bb1308a 100644 --- a/cli/configure/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. @@ -128,5 +129,5 @@ The following Playwright config values are supported and will be synced: ## Related Commands -- [`checkly test`](/cli/testing/checkly-test) - Test with synchronized configuration -- [`checkly deploy`](/cli/monitoring/checkly-deploy) - Deploy with updated settings +- [`checkly test`](/cli/checkly-test) - Test with synchronized configuration +- [`checkly deploy`](/cli/checkly-deploy) - Deploy with updated settings diff --git a/cli/dependencies.mdx b/cli/dependencies.mdx index e71dd818..4a9ac2ab 100644 --- a/cli/dependencies.mdx +++ b/cli/dependencies.mdx @@ -91,7 +91,7 @@ new BrowserCheck('login-check', { }) ``` -After running [`npx checkly deploy`](/cli/monitoring/checkly-deploy), you can see in the Web UI that the helper file `login-helper.ts` was also uploaded for this Check. +After running [`npx checkly deploy`](/cli/checkly-deploy), you can see in the Web UI that the helper file `login-helper.ts` was also uploaded for this Check. ![login check with helper file in dependencies](/images/docs/images/cli/local-dependency.png) diff --git a/cli/environment-variables.mdx b/cli/environment-variables.mdx index 7bd97f1b..b3719103 100644 --- a/cli/environment-variables.mdx +++ b/cli/environment-variables.mdx @@ -130,12 +130,12 @@ You can reference that file in the `test` as follows: npx checkly test --env-file="./.env" ``` -You can also pull in the variables from your account and store them in a file using [the `npx checkly env pull` command](/cli/configure/checkly-env#pull). +You can also pull in the variables from your account and store them in a file using [the `npx checkly env pull` command](/cli/checkly-env#pull). See the examples below. ### Managing Remote Environment Variables -Manage your remote environment variables with the CLI using the [`checkly env` command](/cli/configure/checkly-env). You can list, add, update, remove +Manage your remote environment variables with the CLI using the [`checkly env` command](/cli/checkly-env). You can list, add, update, remove and export your global variables. List all your stored variables and lock it. @@ -158,7 +158,7 @@ npx checkly env pull .env.prod Reference that file in your `test` command. -[See the full reference documentation for the `checkly env` command](/cli/configure/checkly-env). +[See the full reference documentation for the `checkly env` command](/cli/checkly-env). ## Securing Environment Variables diff --git a/cli/monitoring/checkly-checks.mdx b/cli/monitoring/checkly-checks.mdx index 56681b8b..529902fb 100644 --- a/cli/monitoring/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. @@ -275,6 +276,6 @@ npx checkly checks get 12345 --results-limit=25 ## Related Commands -- [`checkly status-pages`](/cli/communicate/checkly-status-pages) - List and inspect status pages -- [`checkly trigger`](/cli/monitoring/checkly-trigger) - Trigger checks on-demand -- [`checkly whoami`](/cli/account/checkly-whoami) - Display current account information +- [`checkly status-pages`](/cli/checkly-status-pages) - List and inspect status pages +- [`checkly trigger`](/cli/checkly-trigger) - Trigger checks on-demand +- [`checkly whoami`](/cli/checkly-whoami) - Display current account information diff --git a/cli/monitoring/checkly-deploy.mdx b/cli/monitoring/checkly-deploy.mdx index 675827e5..2191546f 100644 --- a/cli/monitoring/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'; @@ -180,5 +181,5 @@ The Checkly CLI evaluates Git information from your local or CI environment on a ## Related Commands -- [`checkly login`](/cli/account/checkly-login) - Log in to your Checkly account -- [`checkly test`](/cli/testing/checkly-test) - Test your setup before deployment +- [`checkly login`](/cli/checkly-login) - Log in to your Checkly account +- [`checkly test`](/cli/checkly-test) - Test your setup before deployment diff --git a/cli/monitoring/checkly-destroy.mdx b/cli/monitoring/checkly-destroy.mdx index ed77c999..c91a1cbe 100644 --- a/cli/monitoring/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'; @@ -86,5 +87,5 @@ Please confirm by typing the project name "Website Monitoring": ## Related Commands -- [`checkly deploy`](/cli/monitoring/checkly-deploy) - Deploy resources to Checkly -- [`checkly test`](/cli/testing/checkly-test) - Test your setup before deployment +- [`checkly deploy`](/cli/checkly-deploy) - Deploy resources to Checkly +- [`checkly test`](/cli/checkly-test) - Test your setup before deployment diff --git a/cli/monitoring/checkly-trigger.mdx b/cli/monitoring/checkly-trigger.mdx index 373a8293..a7d49bcb 100644 --- a/cli/monitoring/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'; @@ -347,9 +348,9 @@ Run your deployed checks before promoting code to production: npx checkly trigger --tags staging --record --test-session-name "Pre-prod validation" ``` -If your production deployment includes monitoring changes and updates, [use `npx checkly test`](/cli/testing/checkly-test) to validate your preview environment with the updated monitoring configuration. +If your production deployment includes monitoring changes and updates, [use `npx checkly test`](/cli/checkly-test) to validate your preview environment with the updated monitoring configuration. ## Related Commands -- [`checkly deploy`](/cli/monitoring/checkly-deploy) - Deploy your Checkly configuration -- [`checkly test`](/cli/testing/checkly-test) - Test your setup before deployment +- [`checkly deploy`](/cli/checkly-deploy) - Deploy your Checkly configuration +- [`checkly test`](/cli/checkly-test) - Test your setup before deployment diff --git a/cli/testing/checkly-pw-test.mdx b/cli/testing/checkly-pw-test.mdx index 222c0159..7775553b 100644 --- a/cli/testing/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. @@ -393,5 +394,5 @@ npx checkly pw-test -- test.spec.ts ## Related Commands -- [`checkly test`](/cli/testing/checkly-test) - Test your setup before deployment -- [`checkly deploy`](/cli/monitoring/checkly-deploy) - Deploy your Checkly configuration +- [`checkly test`](/cli/checkly-test) - Test your setup before deployment +- [`checkly deploy`](/cli/checkly-deploy) - Deploy your Checkly configuration diff --git a/cli/testing/checkly-test.mdx b/cli/testing/checkly-test.mdx index 66f7c8c8..fba77c48 100644 --- a/cli/testing/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'; @@ -358,6 +359,6 @@ npx checkly test --env ENVIRONMENT_URL="https://preview.acme.com" --env PASSWORD ## Related Commands -- [`checkly pw-test`](/cli/testing/checkly-pw-test) - Run Playwright tests in the Checkly cloud -- [`checkly trigger`](/cli/monitoring/checkly-trigger) - Run deployed checks on-demand -- [`checkly deploy`](/cli/monitoring/checkly-deploy) - Deploy your application +- [`checkly pw-test`](/cli/checkly-pw-test) - Run Playwright tests in the Checkly cloud +- [`checkly trigger`](/cli/checkly-trigger) - Run deployed checks on-demand +- [`checkly deploy`](/cli/checkly-deploy) - Deploy your application diff --git a/constructs/check-group-v2.mdx b/constructs/check-group-v2.mdx index d2d44b91..f1829499 100644 --- a/constructs/check-group-v2.mdx +++ b/constructs/check-group-v2.mdx @@ -263,7 +263,7 @@ When referencing existing groups with `fromId()`, note: - You cannot filter tests by group tags since group properties aren't available locally - Checks won't inherit the group's frequency. This only works for groups defined in the CLI project -If you need these features, you can either import the group using the [Checkly import feature](/cli/configure/checkly-import) (e.g. `npx checkly import check-group:123`) or define a new group directly in your project. +If you need these features, you can either import the group using the [Checkly import feature](/cli/checkly-import) (e.g. `npx checkly import check-group:123`) or define a new group directly in your project. ## Shared Settings in Groups with Different Monitor Types diff --git a/constructs/overview.mdx b/constructs/overview.mdx index 9581c8b5..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/monitoring/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/detect/synthetic-monitoring/browser-checks/performance-metrics.mdx b/detect/synthetic-monitoring/browser-checks/performance-metrics.mdx index 94b44e2b..7729f580 100644 --- a/detect/synthetic-monitoring/browser-checks/performance-metrics.mdx +++ b/detect/synthetic-monitoring/browser-checks/performance-metrics.mdx @@ -23,7 +23,7 @@ Checkly automatically collect Network Waterfalls & Performance signals (**Web Vi Checkly only collects tracing and web vitals data if your browser check meets the following criteria: - It is based on **Playwright**. -- It runs on any **runtime above [2021.06](/cli/account/checkly-runtimes)** +- It runs on any **runtime above [2021.06](/cli/checkly-runtimes)** diff --git a/detect/synthetic-monitoring/browser-checks/playwright-support.mdx b/detect/synthetic-monitoring/browser-checks/playwright-support.mdx index 5a4868f4..1315703d 100644 --- a/detect/synthetic-monitoring/browser-checks/playwright-support.mdx +++ b/detect/synthetic-monitoring/browser-checks/playwright-support.mdx @@ -168,7 +168,7 @@ There are three things you should be aware of: If you have an existing `playwright.config.ts` or `playwright.config.js` file in your project that you want to import, -you can simply run the [sync-playwright](/cli/configure/checkly-sync-playwright) +you can simply run the [sync-playwright](/cli/checkly-sync-playwright) ```bash npx checkly sync-playwright diff --git a/detect/testing/overview.mdx b/detect/testing/overview.mdx index 5a17b2b8..dc32e57a 100644 --- a/detect/testing/overview.mdx +++ b/detect/testing/overview.mdx @@ -77,7 +77,7 @@ Customize the dependency installation step for the cloud environment: npx checkly pw-test --installCommand='npm install --no-scripts' ``` -Learn more in the [`checkly pw-test` CLI reference](/cli/testing/checkly-pw-test). +Learn more in the [`checkly pw-test` CLI reference](/cli/checkly-pw-test). ## Analyze local test results diff --git a/guides/playwright-testing-to-monitoring.mdx b/guides/playwright-testing-to-monitoring.mdx index 23e15196..0b4028c3 100644 --- a/guides/playwright-testing-to-monitoring.mdx +++ b/guides/playwright-testing-to-monitoring.mdx @@ -98,7 +98,7 @@ Here's how Checkly enhances the process of releasing new code: 1. **Write the Playwright Script**: Automate the login, product search, and checkout steps. Run initial tests through the Checkly network to make sure it's working from all your users' geo-locations. 2. **Configure Monitoring Settings**: Define how often the script should run (e.g., every 15 minutes) and from which locations (e.g., Ireland, Frankfurt). 3. **Set Up Alerts**: Notify your team if a Playwright test fails, ensuring quick resolution of issues. -4. **Deploy to Production**: Use [Checkly's CLI to deploy](/cli/monitoring/checkly-deploy) your Playwright tests and start monitoring your production environment. +4. **Deploy to Production**: Use [Checkly's CLI to deploy](/cli/checkly-deploy) your Playwright tests and start monitoring your production environment. With Checkly running your Playwright monitors, you can find and resolve issues before your users are affected. @@ -116,7 +116,7 @@ If you want to learn how to apply different Playwright settings depending on the Once your Playwright tests run locally, in CI/CD, and as scheduled monitors, they need to be aware of their execution environment. -A local Playwright test executed with `npx playwright test` needs to target `localhost`, a CI/CD test run via [`npx checkly pw-test`](/cli/testing/checkly-pw-test) or [`npx checkly test`](/cli/testing/checkly-test) needs to target environment-specific preview URLs, and global production monitoring might need to be aware of its execution region. +A local Playwright test executed with `npx playwright test` needs to target `localhost`, a CI/CD test run via [`npx checkly pw-test`](/cli/checkly-pw-test) or [`npx checkly test`](/cli/checkly-test) needs to target environment-specific preview URLs, and global production monitoring might need to be aware of its execution region. To differentiate your Playwright test runs in Checkly, use the [provided environment variables](/detect/synthetic-monitoring/playwright-checks/environment-variables). diff --git a/quickstarts/playwright-check.mdx b/quickstarts/playwright-check.mdx index ebf92707..f40e0724 100644 --- a/quickstarts/playwright-check.mdx +++ b/quickstarts/playwright-check.mdx @@ -140,7 +140,7 @@ npx checkly test --record --env ENVIRONMENT=staging **Difference between `checkly test` and `checkly pw-test`:** - `checkly test` - Runs check suites defined in `checkly.config.ts` and `check.ts` files -- `checkly pw-test` - Runs any Playwright tests defined in your `playwright.config.ts`, directly on Checkly's cloud infrastructure. See the [CLI reference](/cli/testing/checkly-pw-test). +- `checkly pw-test` - Runs any Playwright tests defined in your `playwright.config.ts`, directly on Checkly's cloud infrastructure. See the [CLI reference](/cli/checkly-pw-test). ## Step 5: Deploy to Production Monitoring From fb4064371cd7da9d7ddf2ffc9389d6e2d695a305 Mon Sep 17 00:00:00 2001 From: Herve Labas Date: Thu, 5 Mar 2026 12:36:23 +0100 Subject: [PATCH 4/4] docs: use slug paths in docs.json navigation Mintlify resolves page entries in docs.json to URLs, so they need to match the slug values rather than the file paths to avoid sidebar links exposing the folder structure. Co-Authored-By: Claude Opus 4.6 --- docs.json | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/docs.json b/docs.json index 59f9da7b..78f84ac6 100644 --- a/docs.json +++ b/docs.json @@ -537,42 +537,42 @@ { "group": "Account", "pages": [ - "cli/account/checkly-login", - "cli/account/checkly-logout", - "cli/account/checkly-switch", - "cli/account/checkly-whoami", - "cli/account/checkly-runtimes" + "cli/checkly-login", + "cli/checkly-logout", + "cli/checkly-switch", + "cli/checkly-whoami", + "cli/checkly-runtimes" ] }, { "group": "Configure", "pages": [ - "cli/configure/checkly-env", - "cli/configure/checkly-import", - "cli/configure/checkly-sync-playwright" + "cli/checkly-env", + "cli/checkly-import", + "cli/checkly-sync-playwright" ] }, { "group": "Testing", "pages": [ - "cli/testing/checkly-test", - "cli/testing/checkly-pw-test" + "cli/checkly-test", + "cli/checkly-pw-test" ] }, { "group": "Monitoring", "pages": [ - "cli/monitoring/checkly-deploy", - "cli/monitoring/checkly-destroy", - "cli/monitoring/checkly-trigger", - "cli/monitoring/checkly-checks" + "cli/checkly-deploy", + "cli/checkly-destroy", + "cli/checkly-trigger", + "cli/checkly-checks" ] }, { "group": "Communicate", "pages": [ - "cli/communicate/checkly-incidents", - "cli/communicate/checkly-status-pages" + "cli/checkly-incidents", + "cli/checkly-status-pages" ] } ]