Skip to content

docs: reorganize CLI commands into categorical folders #204

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
thebiglabasky wants to merge 4 commits into
base: main
Choose a base branch
from
Open

docs: reorganize CLI commands into categorical folders #204

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5441b23
docs: reorganize CLI commands into categorical folders
thebiglabasky Mar 5, 2026
432915c
docs: standardize CLI command reference consistency
thebiglabasky Mar 5, 2026
66d9a36
docs: add slug frontmatter to preserve URLs after folder reorganization
thebiglabasky Mar 5, 2026
fb40643
docs: use slug paths in docs.json navigation
thebiglabasky Mar 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions cli/checkly-login.mdx → cli/account/checkly-login.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
7 changes: 4 additions & 3 deletions cli/checkly-logout.mdx → cli/account/checkly-logout.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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

Expand Down
1 change: 1 addition & 0 deletions cli/checkly-runtimes.mdx → cli/account/checkly-runtimes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
7 changes: 4 additions & 3 deletions cli/checkly-switch.mdx → cli/account/checkly-switch.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand Down
3 changes: 3 additions & 0 deletions cli/checkly-whoami.mdx → cli/account/checkly-whoami.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
3 changes: 2 additions & 1 deletion cli/checkly-incidents.mdx → cli/communicate/checkly-incidents.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
---

<Note>Available since CLI v7.5.0.</Note>
Expand Down Expand Up @@ -362,7 +363,7 @@ npx checkly incidents resolve <id> [options]

| Argument | Description |
|----------|-------------|
| `ID` | The ID of the incident to resolve. |
| `id` | The ID of the incident to resolve. |

**Options:**

Expand Down
21 changes: 11 additions & 10 deletions cli/checkly-status-pages.mdx → cli/communicate/checkly-status-pages.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
---

<Note>Available since CLI v7.3.0.</Note>
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -131,13 +132,13 @@ npx checkly status-pages get <id> [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

Expand Down
29 changes: 15 additions & 14 deletions cli/checkly-env.mdx → cli/configure/checkly-env.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand Down Expand Up @@ -40,10 +41,10 @@ npx checkly env add <key> <value> [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:**

Expand All @@ -70,10 +71,10 @@ npx checkly env update <key> <value> [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:**

Expand Down Expand Up @@ -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:**

Expand All @@ -148,9 +149,9 @@ npx checkly env rm <key> [options]

**Options:**

| Option | Description |
|--------|-------------|
| `--force, -f` | Skip confirmation dialog |
| Option | Required | Description |
|--------|----------|-------------|
| `--force, -f` | - | Skip confirmation dialog |

**Examples:**

Expand Down
9 changes: 5 additions & 4 deletions cli/checkly-import.mdx → cli/configure/checkly-import.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: checkly import
description: 'Import existing resources into your CLI-managed project.'
sidebarTitle: 'checkly import'
slug: cli/checkly-import
---

<Note>Available since CLI v5.4.0.</Note>
Expand Down Expand Up @@ -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

Expand Down
1 change: 1 addition & 0 deletions cli/checkly-sync-playwright.mdx → cli/configure/checkly-sync-playwright.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: checkly sync-playwright
description: 'Synchronize Playwright configuration with Checkly settings.'
sidebarTitle: 'checkly sync-playwright'
slug: cli/checkly-sync-playwright
---

<Note>Available since CLI v4.6.0.</Note>
Expand Down
35 changes: 18 additions & 17 deletions cli/checkly-checks.mdx → cli/monitoring/checkly-checks.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: checkly checks
description: 'List and inspect checks in your Checkly account.'
sidebarTitle: 'checkly checks'
slug: cli/checkly-checks
---

<Note>Available since CLI v7.3.0.</Note>
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -177,17 +178,17 @@ npx checkly checks get <id> [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

Expand Down
19 changes: 10 additions & 9 deletions cli/checkly-deploy.mdx → cli/monitoring/checkly-deploy.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand All @@ -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

Expand Down
9 changes: 5 additions & 4 deletions cli/checkly-destroy.mdx → cli/monitoring/checkly-destroy.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand All @@ -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

Expand Down
Loading