Skip to content

Commit 3716006

Browse files
thebiglabaskyclaude
andcommitted
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) <noreply@anthropic.com>
1 parent 5680815 commit 3716006

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

cli/checkly-checks.mdx

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ npx checkly checks <subcommand> [arguments] [options]
3333

3434
## `checkly checks list`
3535

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

3838
**Usage:**
3939

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

@@ -120,6 +121,19 @@ npx checkly checks list --type=BROWSER
120121

121122
</ResponseField>
122123

124+
<ResponseField name="--status" type="string">
125+
126+
Filter checks by current status. Available values: `passing`, `failing`, `degraded`.
127+
128+
**Usage:**
129+
130+
```bash Terminal
131+
npx checkly checks list --status=failing
132+
npx checkly checks list --status=degraded
133+
```
134+
135+
</ResponseField>
136+
123137
<ResponseField name="--hide-id" type="boolean">
124138

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

174+
# Show only failing checks
175+
npx checkly checks list --status=failing
176+
160177
# Get results as JSON
161178
npx checkly checks list --output=json
162179

0 commit comments

Comments
 (0)