From 9c3962a27c9066dd33419561fadc4eb49b229f76 Mon Sep 17 00:00:00 2001 From: Herve Labas Date: Thu, 9 Apr 2026 08:38:05 +0200 Subject: [PATCH] docs(cli): document --status flag for checkly checks list The --status flag was added to checks list in checkly-cli#1244 but hadn't been documented. Adds it to the intro, options table, a dedicated ResponseField, and the examples section. Co-Authored-By: Claude Opus 4.6 (1M context) --- cli/checkly-checks.mdx | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/cli/checkly-checks.mdx b/cli/checkly-checks.mdx index ea90ac7d..0efd1f8d 100644 --- a/cli/checkly-checks.mdx +++ b/cli/checkly-checks.mdx @@ -33,7 +33,7 @@ npx checkly checks [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:** @@ -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`. | @@ -120,6 +121,19 @@ npx checkly checks list --type=BROWSER + + +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 +``` + + + Hide check IDs in table output for a cleaner view. @@ -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