You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<Note>Available since CLI v7.3.0. Analytics stats available since v7.6.0.</Note>
9
9
10
-
The `checkly checks` command lets you list, inspect, and analyze checks in your Checkly account directly from the terminal. You can filter, search, and drill into individual check details, recent results, error groups, and analytics stats.
10
+
The `checkly checks` command lets you list, inspect, run, and analyze checks in your Checkly account directly from the terminal. You can filter, search, run deployed checks on demand, and drill into individual check details, recent results, error groups, and analytics stats.
|`get`| Get details of a specific check, including recent results and analytics stats. |
33
+
|`run`| Run deployed checks now using their configured locations and alerting rules. |
33
34
|`stats`| Show analytics stats for your checks. |
34
35
|`delete`| Delete a check by ID. |
35
36
@@ -183,6 +184,60 @@ npx checkly checks list --output=json
183
184
npx checkly checks list --limit=10 --page=2
184
185
```
185
186
187
+
## `checkly checks run`
188
+
189
+
<Note>The `checkly checks run` command is available since CLI v8.18.0.</Note>
190
+
191
+
Run deployed checks immediately using their configured locations and alerting rules. This is the CLI equivalent of selecting **Schedule now** in the Checkly dashboard.
192
+
193
+
<Warning>
194
+
These are normal monitoring runs. They update check health and can trigger configured alerts. To run checks in a test session without affecting monitoring state or sending alerts, use [`checkly trigger`](/cli/checkly-trigger).
195
+
</Warning>
196
+
197
+
**Usage:**
198
+
199
+
```bash Terminal
200
+
npx checkly checks run [options]
201
+
```
202
+
203
+
Without a selector, the command runs all eligible checks in your account. By default, it waits up to 600 seconds for every check session to finish and exits with a failing status code if a session fails, times out, or is cancelled.
204
+
205
+
**Options:**
206
+
207
+
| Option | Required | Description |
208
+
|--------|----------|-------------|
209
+
|`--tags, -t`| - | Select checks by tag. Use commas to require multiple tags, or repeat the option to match any filter. |
210
+
|`--check-id`| - | Run specific checks by ID. Accepts comma-separated values and can be repeated. |
211
+
|`--refresh-cache`| - | Refresh the selected checks cache before running. |
212
+
|`--timeout`| - | Number of seconds to wait for all check sessions to finish. Default: `600`. |
213
+
|`--detach, -d`| - | Start the check sessions and exit without waiting for results. |
214
+
|`--[no-]fail-on-no-matching`| - | Fail when no checks match. Enabled by default. |
# Run checks that have both the production and api tags
224
+
npx checkly checks run --tags=production,api
225
+
226
+
# Run checks matching either tag filter
227
+
npx checkly checks run --tags=production,api --tags=critical
228
+
229
+
# Schedule matching checks and exit immediately
230
+
npx checkly checks run --tags=production --detach
231
+
232
+
# Return machine-readable results
233
+
npx checkly checks run --check-id=<check-id> --output=json
234
+
235
+
# Exit successfully when no checks match
236
+
npx checkly checks run --tags=optional --no-fail-on-no-matching
237
+
```
238
+
239
+
The `--timeout` option only controls how long the CLI waits. Check sessions continue running in Checkly after the CLI times out. Use `--detach` when you do not need to wait for results.
240
+
186
241
## `checkly checks get`
187
242
188
243
Get details of a specific check, including recent results and analytics stats. Use `--result` to drill into a specific result, `--error-group` to view error details, or the stats flags to customize the analytics view.
0 commit comments