checkly 5.2.0 → 5.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/dist/commands/login.js +3 -1
  2. package/dist/commands/login.js.map +1 -1
  3. package/dist/constructs/api-check.d.ts +7 -0
  4. package/dist/constructs/browser-check.d.ts +7 -0
  5. package/dist/constructs/check-group.js +6 -3
  6. package/dist/constructs/check-group.js.map +1 -1
  7. package/dist/constructs/check.d.ts +15 -0
  8. package/dist/constructs/check.js +11 -0
  9. package/dist/constructs/check.js.map +1 -1
  10. package/dist/constructs/incident.d.ts +10 -0
  11. package/dist/constructs/incident.js +3 -0
  12. package/dist/constructs/incident.js.map +1 -0
  13. package/dist/constructs/index.d.ts +1 -0
  14. package/dist/constructs/index.js +1 -0
  15. package/dist/constructs/index.js.map +1 -1
  16. package/dist/constructs/multi-step-check.d.ts +7 -0
  17. package/dist/constructs/project.js +4 -2
  18. package/dist/constructs/project.js.map +1 -1
  19. package/dist/constructs/tcp-check.d.ts +7 -0
  20. package/dist/help/help-extension.d.ts +1 -1
  21. package/dist/playwright/playwright-config-loader.js +15 -11
  22. package/dist/playwright/playwright-config-loader.js.map +1 -1
  23. package/dist/services/check-parser/package-files/tsconfig-json-file.js +5 -1
  24. package/dist/services/check-parser/package-files/tsconfig-json-file.js.map +1 -1
  25. package/dist/services/check-parser/parser.js +1 -3
  26. package/dist/services/check-parser/parser.js.map +1 -1
  27. package/dist/services/checkly-config-loader.d.ts +0 -1
  28. package/dist/services/checkly-config-loader.js +13 -28
  29. package/dist/services/checkly-config-loader.js.map +1 -1
  30. package/dist/services/project-parser.js +3 -9
  31. package/dist/services/project-parser.js.map +1 -1
  32. package/dist/services/util.d.ts +1 -2
  33. package/dist/services/util.js +55 -30
  34. package/dist/services/util.js.map +1 -1
  35. package/dist/tsconfig.tsbuildinfo +1 -1
  36. package/oclif.manifest.json +536 -328
  37. package/package.json +61 -51
@@ -1,300 +1,411 @@
1
1
  {
2
- "version": "5.2.0",
3
2
  "commands": {
4
3
  "authCommand": {
4
+ "aliases": [],
5
+ "args": {},
6
+ "flags": {},
7
+ "hasDynamicHelp": false,
8
+ "hidden": true,
9
+ "hiddenAliases": [],
5
10
  "id": "authCommand",
6
- "strict": true,
7
- "pluginName": "checkly",
8
11
  "pluginAlias": "checkly",
12
+ "pluginName": "checkly",
9
13
  "pluginType": "core",
10
- "hidden": true,
11
- "aliases": [],
12
- "flags": {},
13
- "args": {}
14
+ "strict": true,
15
+ "enableJsonFlag": false,
16
+ "coreCommand": false,
17
+ "isESM": false,
18
+ "relativePath": [
19
+ "dist",
20
+ "commands",
21
+ "authCommand.js"
22
+ ]
14
23
  },
15
24
  "baseCommand": {
25
+ "aliases": [],
26
+ "args": {},
27
+ "flags": {},
28
+ "hasDynamicHelp": false,
29
+ "hidden": true,
30
+ "hiddenAliases": [],
16
31
  "id": "baseCommand",
17
- "strict": true,
18
- "pluginName": "checkly",
19
32
  "pluginAlias": "checkly",
33
+ "pluginName": "checkly",
20
34
  "pluginType": "core",
21
- "hidden": true,
22
- "aliases": [],
23
- "flags": {},
24
- "args": {},
25
- "coreCommand": false
35
+ "strict": true,
36
+ "enableJsonFlag": false,
37
+ "coreCommand": false,
38
+ "isESM": false,
39
+ "relativePath": [
40
+ "dist",
41
+ "commands",
42
+ "baseCommand.js"
43
+ ]
26
44
  },
27
45
  "deploy": {
28
- "id": "deploy",
29
- "description": "Deploy your project to your Checkly account.",
30
- "strict": true,
31
- "pluginName": "checkly",
32
- "pluginAlias": "checkly",
33
- "pluginType": "core",
34
- "hidden": false,
35
46
  "aliases": [],
47
+ "args": {},
48
+ "description": "Deploy your project to your Checkly account.",
36
49
  "flags": {
37
50
  "preview": {
38
- "name": "preview",
39
- "type": "boolean",
40
51
  "char": "p",
41
52
  "description": "Show a preview of the changes made by the deploy command.",
42
- "allowNo": false
53
+ "name": "preview",
54
+ "allowNo": false,
55
+ "type": "boolean"
43
56
  },
44
57
  "output": {
45
- "name": "output",
46
- "type": "boolean",
47
58
  "char": "o",
48
59
  "description": "Shows the changes made after the deploy command.",
49
- "allowNo": false
60
+ "name": "output",
61
+ "allowNo": false,
62
+ "type": "boolean"
50
63
  },
51
64
  "schedule-on-deploy": {
52
- "name": "schedule-on-deploy",
53
- "type": "boolean",
54
65
  "description": "Enables automatic check scheduling after a deploy.",
55
- "allowNo": true
66
+ "name": "schedule-on-deploy",
67
+ "allowNo": true,
68
+ "type": "boolean"
56
69
  },
57
70
  "force": {
58
- "name": "force",
59
- "type": "boolean",
60
71
  "char": "f",
61
72
  "description": "Force mode. Skips the confirmation dialog.",
62
- "allowNo": false
73
+ "name": "force",
74
+ "allowNo": false,
75
+ "type": "boolean"
63
76
  },
64
77
  "config": {
65
- "name": "config",
66
- "type": "option",
67
78
  "char": "c",
68
79
  "description": "The Checkly CLI configuration file. If not passed, uses the checkly.config.ts|js file in the current directory.",
69
- "multiple": false
80
+ "name": "config",
81
+ "hasDynamicHelp": false,
82
+ "multiple": false,
83
+ "type": "option"
70
84
  },
71
85
  "verify-runtime-dependencies": {
72
- "name": "verify-runtime-dependencies",
73
- "type": "boolean",
74
86
  "description": "[default: true] Return an error if checks import dependencies that are not supported by the selected runtime.",
75
- "allowNo": true
87
+ "env": "CHECKLY_VERIFY_RUNTIME_DEPENDENCIES",
88
+ "name": "verify-runtime-dependencies",
89
+ "allowNo": true,
90
+ "type": "boolean"
76
91
  },
77
92
  "debug-bundle": {
78
- "name": "debug-bundle",
79
- "type": "boolean",
80
93
  "description": "Output the project bundle to a file without deploying any resources.",
81
94
  "hidden": true,
82
- "allowNo": false
95
+ "name": "debug-bundle",
96
+ "allowNo": false,
97
+ "type": "boolean"
83
98
  },
84
99
  "debug-bundle-output-file": {
85
- "name": "debug-bundle-output-file",
86
- "type": "option",
87
100
  "description": "The file to output the debug debug bundle to.",
88
101
  "hidden": true,
102
+ "name": "debug-bundle-output-file",
103
+ "default": "./debug-bundle.json",
104
+ "hasDynamicHelp": false,
89
105
  "multiple": false,
90
- "default": "./debug-bundle.json"
106
+ "type": "option"
91
107
  }
92
108
  },
93
- "args": {},
94
- "coreCommand": true
95
- },
96
- "destroy": {
97
- "id": "destroy",
98
- "description": "Destroy your project with all its related resources.",
99
- "strict": true,
100
- "pluginName": "checkly",
109
+ "hasDynamicHelp": false,
110
+ "hidden": false,
111
+ "hiddenAliases": [],
112
+ "id": "deploy",
101
113
  "pluginAlias": "checkly",
114
+ "pluginName": "checkly",
102
115
  "pluginType": "core",
103
- "hidden": false,
116
+ "strict": true,
117
+ "enableJsonFlag": false,
118
+ "coreCommand": true,
119
+ "isESM": false,
120
+ "relativePath": [
121
+ "dist",
122
+ "commands",
123
+ "deploy.js"
124
+ ]
125
+ },
126
+ "destroy": {
104
127
  "aliases": [],
128
+ "args": {},
129
+ "description": "Destroy your project with all its related resources.",
105
130
  "flags": {
106
131
  "force": {
107
- "name": "force",
108
- "type": "boolean",
109
132
  "char": "f",
110
133
  "description": "Force mode. Skips the confirmation dialog.",
111
- "allowNo": false
134
+ "name": "force",
135
+ "allowNo": false,
136
+ "type": "boolean"
112
137
  },
113
138
  "config": {
114
- "name": "config",
115
- "type": "option",
116
139
  "char": "c",
117
140
  "description": "The Checkly CLI configuration file. If not passed, uses the checkly.config.ts|js file in the current directory.",
118
- "multiple": false
141
+ "name": "config",
142
+ "hasDynamicHelp": false,
143
+ "multiple": false,
144
+ "type": "option"
119
145
  }
120
146
  },
121
- "args": {}
147
+ "hasDynamicHelp": false,
148
+ "hidden": false,
149
+ "hiddenAliases": [],
150
+ "id": "destroy",
151
+ "pluginAlias": "checkly",
152
+ "pluginName": "checkly",
153
+ "pluginType": "core",
154
+ "strict": true,
155
+ "enableJsonFlag": false,
156
+ "coreCommand": false,
157
+ "isESM": false,
158
+ "relativePath": [
159
+ "dist",
160
+ "commands",
161
+ "destroy.js"
162
+ ]
122
163
  },
123
164
  "help": {
124
- "id": "help",
165
+ "aliases": [],
166
+ "args": {},
125
167
  "description": "Display help for <%= config.bin %>.",
126
- "strict": true,
127
- "pluginName": "checkly",
168
+ "flags": {},
169
+ "hasDynamicHelp": false,
170
+ "hidden": false,
171
+ "hiddenAliases": [],
172
+ "id": "help",
128
173
  "pluginAlias": "checkly",
174
+ "pluginName": "checkly",
129
175
  "pluginType": "core",
130
- "hidden": false,
131
- "aliases": [],
132
- "flags": {},
133
- "args": {}
176
+ "strict": true,
177
+ "enableJsonFlag": false,
178
+ "coreCommand": false,
179
+ "isESM": false,
180
+ "relativePath": [
181
+ "dist",
182
+ "commands",
183
+ "help.js"
184
+ ]
134
185
  },
135
186
  "login": {
136
- "id": "login",
187
+ "aliases": [],
188
+ "args": {},
137
189
  "description": "Login to your Checkly account or create a new one.",
138
- "strict": true,
139
- "pluginName": "checkly",
190
+ "flags": {},
191
+ "hasDynamicHelp": false,
192
+ "hidden": false,
193
+ "hiddenAliases": [],
194
+ "id": "login",
140
195
  "pluginAlias": "checkly",
196
+ "pluginName": "checkly",
141
197
  "pluginType": "core",
142
- "hidden": false,
143
- "aliases": [],
144
- "flags": {},
145
- "args": {}
198
+ "strict": true,
199
+ "enableJsonFlag": false,
200
+ "coreCommand": false,
201
+ "isESM": false,
202
+ "relativePath": [
203
+ "dist",
204
+ "commands",
205
+ "login.js"
206
+ ]
146
207
  },
147
208
  "logout": {
148
- "id": "logout",
149
- "description": "Log out and clear any local credentials.",
150
- "strict": true,
151
- "pluginName": "checkly",
152
- "pluginAlias": "checkly",
153
- "pluginType": "core",
154
- "hidden": false,
155
209
  "aliases": [],
210
+ "args": {},
211
+ "description": "Log out and clear any local credentials.",
156
212
  "flags": {
157
213
  "force": {
158
- "name": "force",
159
- "type": "boolean",
160
214
  "char": "f",
161
215
  "description": "Force mode. Skips the confirmation dialog.",
162
- "allowNo": false
216
+ "name": "force",
217
+ "allowNo": false,
218
+ "type": "boolean"
163
219
  }
164
220
  },
165
- "args": {}
221
+ "hasDynamicHelp": false,
222
+ "hidden": false,
223
+ "hiddenAliases": [],
224
+ "id": "logout",
225
+ "pluginAlias": "checkly",
226
+ "pluginName": "checkly",
227
+ "pluginType": "core",
228
+ "strict": true,
229
+ "enableJsonFlag": false,
230
+ "coreCommand": false,
231
+ "isESM": false,
232
+ "relativePath": [
233
+ "dist",
234
+ "commands",
235
+ "logout.js"
236
+ ]
166
237
  },
167
238
  "runtimes": {
168
- "id": "runtimes",
239
+ "aliases": [],
240
+ "args": {},
169
241
  "description": "List all supported runtimes and dependencies.",
170
- "strict": true,
171
- "pluginName": "checkly",
242
+ "flags": {},
243
+ "hasDynamicHelp": false,
244
+ "hidden": false,
245
+ "hiddenAliases": [],
246
+ "id": "runtimes",
172
247
  "pluginAlias": "checkly",
248
+ "pluginName": "checkly",
173
249
  "pluginType": "core",
174
- "hidden": false,
175
- "aliases": [],
176
- "flags": {},
177
- "args": {}
250
+ "strict": true,
251
+ "enableJsonFlag": false,
252
+ "coreCommand": false,
253
+ "isESM": false,
254
+ "relativePath": [
255
+ "dist",
256
+ "commands",
257
+ "runtimes.js"
258
+ ]
178
259
  },
179
260
  "switch": {
180
- "id": "switch",
181
- "description": "Switch user account.",
182
- "strict": true,
183
- "pluginName": "checkly",
184
- "pluginAlias": "checkly",
185
- "pluginType": "core",
186
- "hidden": false,
187
261
  "aliases": [],
262
+ "args": {},
263
+ "description": "Switch user account.",
188
264
  "flags": {
189
265
  "account-id": {
190
- "name": "account-id",
191
- "type": "option",
192
266
  "char": "a",
193
267
  "description": "The id of the account you want to switch to.",
194
- "multiple": false
268
+ "name": "account-id",
269
+ "hasDynamicHelp": false,
270
+ "multiple": false,
271
+ "type": "option"
195
272
  }
196
273
  },
197
- "args": {}
274
+ "hasDynamicHelp": false,
275
+ "hidden": false,
276
+ "hiddenAliases": [],
277
+ "id": "switch",
278
+ "pluginAlias": "checkly",
279
+ "pluginName": "checkly",
280
+ "pluginType": "core",
281
+ "strict": true,
282
+ "enableJsonFlag": false,
283
+ "coreCommand": false,
284
+ "isESM": false,
285
+ "relativePath": [
286
+ "dist",
287
+ "commands",
288
+ "switch.js"
289
+ ]
198
290
  },
199
291
  "sync-playwright": {
200
- "id": "sync-playwright",
292
+ "aliases": [],
293
+ "args": {},
201
294
  "description": "Copy Playwright config into the Checkly config file.",
202
- "strict": true,
203
- "pluginName": "checkly",
295
+ "flags": {},
296
+ "hasDynamicHelp": false,
297
+ "hidden": false,
298
+ "hiddenAliases": [],
299
+ "id": "sync-playwright",
204
300
  "pluginAlias": "checkly",
301
+ "pluginName": "checkly",
205
302
  "pluginType": "core",
206
- "hidden": false,
207
- "aliases": [],
208
- "flags": {},
209
- "args": {}
303
+ "strict": true,
304
+ "enableJsonFlag": false,
305
+ "coreCommand": false,
306
+ "isESM": false,
307
+ "relativePath": [
308
+ "dist",
309
+ "commands",
310
+ "sync-playwright.js"
311
+ ]
210
312
  },
211
313
  "test": {
212
- "id": "test",
213
- "description": "Test your checks on Checkly.",
214
- "strict": false,
215
- "pluginName": "checkly",
216
- "pluginAlias": "checkly",
217
- "pluginType": "core",
218
- "hidden": false,
219
314
  "aliases": [],
315
+ "args": {
316
+ "fileArgs": {
317
+ "default": ".*",
318
+ "description": "Only run checks where the file name matches a regular expression",
319
+ "name": "fileArgs",
320
+ "required": false
321
+ }
322
+ },
323
+ "description": "Test your checks on Checkly.",
220
324
  "flags": {
221
325
  "location": {
222
- "name": "location",
223
- "type": "option",
224
326
  "char": "l",
225
327
  "description": "The location to run the checks at.",
226
- "multiple": false
328
+ "name": "location",
329
+ "hasDynamicHelp": false,
330
+ "multiple": false,
331
+ "type": "option"
227
332
  },
228
333
  "private-location": {
229
- "name": "private-location",
230
- "type": "option",
231
334
  "description": "The private location to run checks at.",
232
- "multiple": false,
233
335
  "exclusive": [
234
336
  "location"
235
- ]
337
+ ],
338
+ "name": "private-location",
339
+ "hasDynamicHelp": false,
340
+ "multiple": false,
341
+ "type": "option"
236
342
  },
237
343
  "grep": {
238
- "name": "grep",
239
- "type": "option",
240
344
  "char": "g",
241
345
  "description": "Only run checks where the check name matches a regular expression.",
346
+ "name": "grep",
347
+ "default": ".*",
348
+ "hasDynamicHelp": false,
242
349
  "multiple": false,
243
- "default": ".*"
350
+ "type": "option"
244
351
  },
245
352
  "tags": {
246
- "name": "tags",
247
- "type": "option",
248
353
  "char": "t",
249
354
  "description": "Filter the checks to be run using a comma separated list of tags. Checks will only be run if they contain all of the specified tags. Multiple --tags flags can be passed, in which case checks will be run if they match any of the --tags filters. F.ex. `--tags production,webapp --tags production,backend` will run checks with tags (production AND webapp) OR (production AND backend).",
355
+ "name": "tags",
250
356
  "required": false,
251
- "multiple": true
357
+ "hasDynamicHelp": false,
358
+ "multiple": true,
359
+ "type": "option"
252
360
  },
253
361
  "env": {
254
- "name": "env",
255
- "type": "option",
256
362
  "char": "e",
257
363
  "description": "Env vars to be passed to the test run.",
258
- "multiple": true,
259
364
  "exclusive": [
260
365
  "env-file"
261
366
  ],
262
- "default": []
367
+ "name": "env",
368
+ "default": [],
369
+ "hasDynamicHelp": false,
370
+ "multiple": true,
371
+ "type": "option"
263
372
  },
264
373
  "env-file": {
265
- "name": "env-file",
266
- "type": "option",
267
374
  "description": "dotenv file path to be passed. For example --env-file=\"./.env\"",
268
- "multiple": false,
269
375
  "exclusive": [
270
376
  "env"
271
- ]
377
+ ],
378
+ "name": "env-file",
379
+ "hasDynamicHelp": false,
380
+ "multiple": false,
381
+ "type": "option"
272
382
  },
273
383
  "list": {
274
- "name": "list",
275
- "type": "boolean",
276
384
  "description": "list all checks but don't run them.",
277
- "allowNo": false
385
+ "name": "list",
386
+ "allowNo": false,
387
+ "type": "boolean"
278
388
  },
279
389
  "timeout": {
280
- "name": "timeout",
281
- "type": "option",
282
390
  "description": "A timeout (in seconds) to wait for checks to complete.",
391
+ "name": "timeout",
392
+ "default": 600,
393
+ "hasDynamicHelp": false,
283
394
  "multiple": false,
284
- "default": 600
395
+ "type": "option"
285
396
  },
286
397
  "verbose": {
287
- "name": "verbose",
288
- "type": "boolean",
289
398
  "char": "v",
290
399
  "description": "Always show the full logs of the checks.",
291
- "allowNo": true
400
+ "name": "verbose",
401
+ "allowNo": true,
402
+ "type": "boolean"
292
403
  },
293
404
  "reporter": {
294
- "name": "reporter",
295
- "type": "option",
296
405
  "char": "r",
297
406
  "description": "A list of custom reporters for the test output.",
407
+ "name": "reporter",
408
+ "hasDynamicHelp": false,
298
409
  "multiple": false,
299
410
  "options": [
300
411
  "list",
@@ -302,124 +413,136 @@
302
413
  "ci",
303
414
  "github",
304
415
  "json"
305
- ]
416
+ ],
417
+ "type": "option"
306
418
  },
307
419
  "config": {
308
- "name": "config",
309
- "type": "option",
310
420
  "char": "c",
311
421
  "description": "The Checkly CLI configuration file. If not passed, uses the checkly.config.ts|js file in the current directory.",
312
- "multiple": false
422
+ "name": "config",
423
+ "hasDynamicHelp": false,
424
+ "multiple": false,
425
+ "type": "option"
313
426
  },
314
427
  "record": {
315
- "name": "record",
316
- "type": "boolean",
317
428
  "description": "Record test results in Checkly as a test session with full logs, traces and videos.",
318
- "allowNo": false
429
+ "name": "record",
430
+ "allowNo": false,
431
+ "type": "boolean"
319
432
  },
320
433
  "test-session-name": {
321
- "name": "test-session-name",
322
- "type": "option",
323
434
  "char": "n",
324
435
  "description": "A name to use when storing results in Checkly with --record.",
325
- "multiple": false
436
+ "name": "test-session-name",
437
+ "hasDynamicHelp": false,
438
+ "multiple": false,
439
+ "type": "option"
326
440
  },
327
441
  "update-snapshots": {
328
- "name": "update-snapshots",
329
- "type": "boolean",
330
442
  "char": "u",
331
443
  "description": "Update any snapshots using the actual result of this test run.",
332
- "allowNo": false
444
+ "name": "update-snapshots",
445
+ "allowNo": false,
446
+ "type": "boolean"
333
447
  },
334
448
  "retries": {
335
- "name": "retries",
336
- "type": "option",
337
449
  "description": "[default: 0, max: 3] How many times to retry a failing test run.",
338
- "multiple": false
450
+ "name": "retries",
451
+ "hasDynamicHelp": false,
452
+ "multiple": false,
453
+ "type": "option"
339
454
  },
340
455
  "verify-runtime-dependencies": {
341
- "name": "verify-runtime-dependencies",
342
- "type": "boolean",
343
456
  "description": "[default: true] Return an error if checks import dependencies that are not supported by the selected runtime.",
344
- "allowNo": true
345
- }
346
- },
347
- "args": {
348
- "fileArgs": {
349
- "name": "fileArgs",
350
- "description": "Only run checks where the file name matches a regular expression",
351
- "required": false,
352
- "default": ".*"
457
+ "env": "CHECKLY_VERIFY_RUNTIME_DEPENDENCIES",
458
+ "name": "verify-runtime-dependencies",
459
+ "allowNo": true,
460
+ "type": "boolean"
353
461
  }
354
462
  },
355
- "coreCommand": true
356
- },
357
- "trigger": {
358
- "id": "trigger",
359
- "description": "Trigger your existing checks on Checkly.",
360
- "strict": true,
361
- "pluginName": "checkly",
463
+ "hasDynamicHelp": false,
464
+ "hidden": false,
465
+ "hiddenAliases": [],
466
+ "id": "test",
362
467
  "pluginAlias": "checkly",
468
+ "pluginName": "checkly",
363
469
  "pluginType": "core",
364
- "hidden": false,
470
+ "strict": false,
471
+ "enableJsonFlag": false,
472
+ "coreCommand": true,
473
+ "isESM": false,
474
+ "relativePath": [
475
+ "dist",
476
+ "commands",
477
+ "test.js"
478
+ ]
479
+ },
480
+ "trigger": {
365
481
  "aliases": [],
482
+ "args": {},
483
+ "description": "Trigger your existing checks on Checkly.",
366
484
  "flags": {
367
485
  "location": {
368
- "name": "location",
369
- "type": "option",
370
486
  "char": "l",
371
487
  "description": "The location to run the checks at.",
372
- "multiple": false
488
+ "name": "location",
489
+ "hasDynamicHelp": false,
490
+ "multiple": false,
491
+ "type": "option"
373
492
  },
374
493
  "private-location": {
375
- "name": "private-location",
376
- "type": "option",
377
494
  "description": "The private location to run checks at.",
378
- "multiple": false,
379
495
  "exclusive": [
380
496
  "location"
381
- ]
497
+ ],
498
+ "name": "private-location",
499
+ "hasDynamicHelp": false,
500
+ "multiple": false,
501
+ "type": "option"
382
502
  },
383
503
  "tags": {
384
- "name": "tags",
385
- "type": "option",
386
504
  "char": "t",
387
505
  "description": "Filter the checks to be run using a comma separated list of tags. Checks will only be run if they contain all of the specified tags. Multiple --tags flags can be passed, in which case checks will be run if they match any of the --tags filters. F.ex. `--tags production,webapp --tags production,backend` will run checks with tags (production AND webapp) OR (production AND backend).",
506
+ "name": "tags",
388
507
  "required": false,
389
- "multiple": true
508
+ "hasDynamicHelp": false,
509
+ "multiple": true,
510
+ "type": "option"
390
511
  },
391
512
  "config": {
392
- "name": "config",
393
- "type": "option",
394
513
  "char": "c",
395
514
  "description": "The Checkly CLI config filename.",
396
- "multiple": false
515
+ "name": "config",
516
+ "hasDynamicHelp": false,
517
+ "multiple": false,
518
+ "type": "option"
397
519
  },
398
520
  "timeout": {
399
- "name": "timeout",
400
- "type": "option",
401
521
  "description": "A timeout (in seconds) to wait for checks to complete.",
522
+ "name": "timeout",
523
+ "default": 600,
524
+ "hasDynamicHelp": false,
402
525
  "multiple": false,
403
- "default": 600
526
+ "type": "option"
404
527
  },
405
528
  "verbose": {
406
- "name": "verbose",
407
- "type": "boolean",
408
529
  "char": "v",
409
530
  "description": "Always show the full logs of the checks.",
410
- "allowNo": true
531
+ "name": "verbose",
532
+ "allowNo": true,
533
+ "type": "boolean"
411
534
  },
412
535
  "fail-on-no-matching": {
413
- "name": "fail-on-no-matching",
414
- "type": "boolean",
415
536
  "description": "Exit with a failing status code when there are no matching tests.",
416
- "allowNo": false
537
+ "name": "fail-on-no-matching",
538
+ "allowNo": false,
539
+ "type": "boolean"
417
540
  },
418
541
  "reporter": {
419
- "name": "reporter",
420
- "type": "option",
421
542
  "char": "r",
422
543
  "description": "A list of custom reporters for the test output.",
544
+ "name": "reporter",
545
+ "hasDynamicHelp": false,
423
546
  "multiple": false,
424
547
  "options": [
425
548
  "list",
@@ -427,209 +550,294 @@
427
550
  "ci",
428
551
  "github",
429
552
  "json"
430
- ]
553
+ ],
554
+ "type": "option"
431
555
  },
432
556
  "env": {
433
- "name": "env",
434
- "type": "option",
435
557
  "char": "e",
436
558
  "description": "Env vars to be passed to the check run.",
437
- "multiple": true,
438
559
  "exclusive": [
439
560
  "env-file"
440
561
  ],
441
- "default": []
562
+ "name": "env",
563
+ "default": [],
564
+ "hasDynamicHelp": false,
565
+ "multiple": true,
566
+ "type": "option"
442
567
  },
443
568
  "env-file": {
444
- "name": "env-file",
445
- "type": "option",
446
569
  "description": "dotenv file path to be passed. For example --env-file=\"./.env\"",
447
- "multiple": false,
448
570
  "exclusive": [
449
571
  "env"
450
- ]
572
+ ],
573
+ "name": "env-file",
574
+ "hasDynamicHelp": false,
575
+ "multiple": false,
576
+ "type": "option"
451
577
  },
452
578
  "record": {
453
- "name": "record",
454
- "type": "boolean",
455
579
  "description": "Record check results in Checkly as a test session with full logs, traces and videos.",
456
- "allowNo": false
580
+ "name": "record",
581
+ "allowNo": false,
582
+ "type": "boolean"
457
583
  },
458
584
  "test-session-name": {
459
- "name": "test-session-name",
460
- "type": "option",
461
585
  "char": "n",
462
586
  "description": "A name to use when storing results in Checkly with --record.",
463
- "multiple": false
587
+ "name": "test-session-name",
588
+ "hasDynamicHelp": false,
589
+ "multiple": false,
590
+ "type": "option"
464
591
  },
465
592
  "retries": {
466
- "name": "retries",
467
- "type": "option",
468
593
  "description": "[default: 0, max: 3] How many times to retry a check run.",
469
- "multiple": false
594
+ "name": "retries",
595
+ "hasDynamicHelp": false,
596
+ "multiple": false,
597
+ "type": "option"
470
598
  }
471
599
  },
472
- "args": {},
473
- "coreCommand": true
600
+ "hasDynamicHelp": false,
601
+ "hidden": false,
602
+ "hiddenAliases": [],
603
+ "id": "trigger",
604
+ "pluginAlias": "checkly",
605
+ "pluginName": "checkly",
606
+ "pluginType": "core",
607
+ "strict": true,
608
+ "enableJsonFlag": false,
609
+ "coreCommand": true,
610
+ "isESM": false,
611
+ "relativePath": [
612
+ "dist",
613
+ "commands",
614
+ "trigger.js"
615
+ ]
474
616
  },
475
617
  "whoami": {
476
- "id": "whoami",
618
+ "aliases": [],
619
+ "args": {},
477
620
  "description": "See your currently logged in account and user.",
478
- "strict": true,
479
- "pluginName": "checkly",
621
+ "flags": {},
622
+ "hasDynamicHelp": false,
623
+ "hidden": false,
624
+ "hiddenAliases": [],
625
+ "id": "whoami",
480
626
  "pluginAlias": "checkly",
627
+ "pluginName": "checkly",
481
628
  "pluginType": "core",
482
- "hidden": false,
483
- "aliases": [],
484
- "flags": {},
485
- "args": {}
629
+ "strict": true,
630
+ "enableJsonFlag": false,
631
+ "coreCommand": false,
632
+ "isESM": false,
633
+ "relativePath": [
634
+ "dist",
635
+ "commands",
636
+ "whoami.js"
637
+ ]
486
638
  },
487
639
  "env:add": {
488
- "id": "env:add",
489
- "description": "Add environment variable via \"checkly env add <key> <value>\".",
490
- "strict": true,
491
- "pluginName": "checkly",
492
- "pluginAlias": "checkly",
493
- "pluginType": "core",
494
- "hidden": false,
495
640
  "aliases": [],
641
+ "args": {
642
+ "key": {
643
+ "description": "Environment variable key.",
644
+ "name": "key",
645
+ "required": true
646
+ },
647
+ "value": {
648
+ "description": "Environment variable value.",
649
+ "name": "value",
650
+ "required": false
651
+ }
652
+ },
653
+ "description": "Add environment variable via \"checkly env add <key> <value>\".",
496
654
  "flags": {
497
655
  "locked": {
498
- "name": "locked",
499
- "type": "boolean",
500
656
  "char": "l",
501
657
  "description": "Indicate that the environment variable will be locked.",
502
- "allowNo": false
658
+ "name": "locked",
659
+ "allowNo": false,
660
+ "type": "boolean"
503
661
  },
504
662
  "secret": {
505
- "name": "secret",
506
- "type": "boolean",
507
663
  "char": "s",
508
664
  "description": "Indicate that the environment variable will be secret.",
509
- "allowNo": false,
510
665
  "exclusive": [
511
666
  "locked"
512
- ]
667
+ ],
668
+ "name": "secret",
669
+ "allowNo": false,
670
+ "type": "boolean"
513
671
  }
514
672
  },
515
- "args": {
516
- "key": {
517
- "name": "key",
518
- "description": "Environment variable key.",
519
- "required": true
520
- },
521
- "value": {
522
- "name": "value",
523
- "description": "Environment variable value.",
524
- "required": false
525
- }
526
- }
673
+ "hasDynamicHelp": false,
674
+ "hidden": false,
675
+ "hiddenAliases": [],
676
+ "id": "env:add",
677
+ "pluginAlias": "checkly",
678
+ "pluginName": "checkly",
679
+ "pluginType": "core",
680
+ "strict": true,
681
+ "enableJsonFlag": false,
682
+ "coreCommand": false,
683
+ "isESM": false,
684
+ "relativePath": [
685
+ "dist",
686
+ "commands",
687
+ "env",
688
+ "add.js"
689
+ ]
527
690
  },
528
691
  "env:ls": {
529
- "id": "env:ls",
692
+ "aliases": [],
693
+ "args": {},
530
694
  "description": "List all Checkly environment variables via \"checkly env ls\".",
531
- "strict": true,
532
- "pluginName": "checkly",
695
+ "flags": {},
696
+ "hasDynamicHelp": false,
697
+ "hidden": false,
698
+ "hiddenAliases": [],
699
+ "id": "env:ls",
533
700
  "pluginAlias": "checkly",
701
+ "pluginName": "checkly",
534
702
  "pluginType": "core",
535
- "hidden": false,
536
- "aliases": [],
537
- "flags": {},
538
- "args": {}
703
+ "strict": true,
704
+ "enableJsonFlag": false,
705
+ "coreCommand": false,
706
+ "isESM": false,
707
+ "relativePath": [
708
+ "dist",
709
+ "commands",
710
+ "env",
711
+ "ls.js"
712
+ ]
539
713
  },
540
714
  "env:pull": {
541
- "id": "env:pull",
542
- "description": "Pull Checkly environment variables via \"checkly env pull <filename>\".",
543
- "strict": true,
544
- "pluginName": "checkly",
545
- "pluginAlias": "checkly",
546
- "pluginType": "core",
547
- "hidden": false,
548
715
  "aliases": [],
716
+ "args": {
717
+ "filename": {
718
+ "default": ".env",
719
+ "description": "Filename of the generated file.",
720
+ "name": "filename",
721
+ "required": false
722
+ }
723
+ },
724
+ "description": "Pull Checkly environment variables via \"checkly env pull <filename>\".",
549
725
  "flags": {
550
726
  "force": {
551
- "name": "force",
552
- "type": "boolean",
553
727
  "char": "f",
554
728
  "description": "Force to overwrite existing file.",
555
- "allowNo": false
729
+ "name": "force",
730
+ "allowNo": false,
731
+ "type": "boolean"
556
732
  }
557
733
  },
558
- "args": {
559
- "filename": {
560
- "name": "filename",
561
- "description": "Filename of the generated file.",
562
- "required": false,
563
- "default": ".env"
564
- }
565
- }
566
- },
567
- "env:rm": {
568
- "id": "env:rm",
569
- "description": "Remove environment variable via \"checkly env rm <key>\".",
570
- "strict": true,
571
- "pluginName": "checkly",
734
+ "hasDynamicHelp": false,
735
+ "hidden": false,
736
+ "hiddenAliases": [],
737
+ "id": "env:pull",
572
738
  "pluginAlias": "checkly",
739
+ "pluginName": "checkly",
573
740
  "pluginType": "core",
574
- "hidden": false,
741
+ "strict": true,
742
+ "enableJsonFlag": false,
743
+ "coreCommand": false,
744
+ "isESM": false,
745
+ "relativePath": [
746
+ "dist",
747
+ "commands",
748
+ "env",
749
+ "pull.js"
750
+ ]
751
+ },
752
+ "env:rm": {
575
753
  "aliases": [],
754
+ "args": {
755
+ "key": {
756
+ "description": "Environment variable key to remove.",
757
+ "name": "key",
758
+ "required": true
759
+ }
760
+ },
761
+ "description": "Remove environment variable via \"checkly env rm <key>\".",
576
762
  "flags": {
577
763
  "force": {
578
- "name": "force",
579
- "type": "boolean",
580
764
  "char": "f",
581
765
  "description": "Force to skip the confirmation prompt.",
582
- "allowNo": false
766
+ "name": "force",
767
+ "allowNo": false,
768
+ "type": "boolean"
583
769
  }
584
770
  },
771
+ "hasDynamicHelp": false,
772
+ "hidden": false,
773
+ "hiddenAliases": [],
774
+ "id": "env:rm",
775
+ "pluginAlias": "checkly",
776
+ "pluginName": "checkly",
777
+ "pluginType": "core",
778
+ "strict": true,
779
+ "enableJsonFlag": false,
780
+ "coreCommand": false,
781
+ "isESM": false,
782
+ "relativePath": [
783
+ "dist",
784
+ "commands",
785
+ "env",
786
+ "rm.js"
787
+ ]
788
+ },
789
+ "env:update": {
790
+ "aliases": [],
585
791
  "args": {
586
792
  "key": {
793
+ "description": "Environment variable key.",
587
794
  "name": "key",
588
- "description": "Environment variable key to remove.",
589
795
  "required": true
796
+ },
797
+ "value": {
798
+ "description": "Environment variable value.",
799
+ "name": "value",
800
+ "required": false
590
801
  }
591
- }
592
- },
593
- "env:update": {
594
- "id": "env:update",
802
+ },
595
803
  "description": "Update environment variable via \"checkly env update <key> <value>\".",
596
- "strict": true,
597
- "pluginName": "checkly",
598
- "pluginAlias": "checkly",
599
- "pluginType": "core",
600
- "hidden": false,
601
- "aliases": [],
602
804
  "flags": {
603
805
  "locked": {
604
- "name": "locked",
605
- "type": "boolean",
606
806
  "char": "l",
607
807
  "description": "Indicate if environment variable is locked.",
608
- "allowNo": false
808
+ "name": "locked",
809
+ "allowNo": false,
810
+ "type": "boolean"
609
811
  },
610
812
  "secret": {
611
- "name": "secret",
612
- "type": "boolean",
613
813
  "char": "s",
614
814
  "description": "Indicate if environment variable is secret.",
615
- "allowNo": false,
616
815
  "exclusive": [
617
816
  "locked"
618
- ]
817
+ ],
818
+ "name": "secret",
819
+ "allowNo": false,
820
+ "type": "boolean"
619
821
  }
620
822
  },
621
- "args": {
622
- "key": {
623
- "name": "key",
624
- "description": "Environment variable key.",
625
- "required": true
626
- },
627
- "value": {
628
- "name": "value",
629
- "description": "Environment variable value.",
630
- "required": false
631
- }
632
- }
823
+ "hasDynamicHelp": false,
824
+ "hidden": false,
825
+ "hiddenAliases": [],
826
+ "id": "env:update",
827
+ "pluginAlias": "checkly",
828
+ "pluginName": "checkly",
829
+ "pluginType": "core",
830
+ "strict": true,
831
+ "enableJsonFlag": false,
832
+ "coreCommand": false,
833
+ "isESM": false,
834
+ "relativePath": [
835
+ "dist",
836
+ "commands",
837
+ "env",
838
+ "update.js"
839
+ ]
633
840
  }
634
- }
841
+ },
842
+ "version": "5.3.0"
635
843
  }