Skip to content

docs(cli): document --status flag for checkly checks list #253

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

Merged
thebiglabasky merged 1 commit into from
Apr 9, 2026
Merged

docs(cli): document --status flag for checkly checks list #253

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 18 additions & 1 deletion cli/checkly-checks.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ npx checkly checks <subcommand> [arguments] [options]

## `checkly checks list`

List all checks in your account with optional filtering by name, tag, or check type.
List all checks in your account with optional filtering by name, tag, check type, or status.

**Usage:**

Expand All @@ -50,6 +50,7 @@ npx checkly checks list [options]
| `--search, -s` | - | Filter checks by name (case-insensitive). |
| `--tag, -t` | - | Filter by tag. Can be specified multiple times. |
| `--type` | - | Filter by check type. |
| `--status` | - | Filter by check status: `passing`, `failing`, or `degraded`. |
| `--hide-id` | - | Hide check IDs in table output. |
| `--output, -o` | - | Output format: `table`, `json`, or `md`. Default: `table`. |

Expand Down Expand Up @@ -120,6 +121,19 @@ npx checkly checks list --type=BROWSER

</ResponseField>

<ResponseField name="--status" type="string">

Filter checks by current status. Available values: `passing`, `failing`, `degraded`.

**Usage:**

```bash Terminal
npx checkly checks list --status=failing
npx checkly checks list --status=degraded
```

</ResponseField>

<ResponseField name="--hide-id" type="boolean">

Hide check IDs in table output for a cleaner view.
Expand Down Expand Up @@ -157,6 +171,9 @@ npx checkly checks list --search="homepage"
# Filter by tag and type
npx checkly checks list --tag=production --type=API

# Show only failing checks
npx checkly checks list --status=failing

# Get results as JSON
npx checkly checks list --output=json

Expand Down