@testrigor/testrigor-cli 1.0.1 → 2.0.1

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.
@@ -1,33 +1,44 @@
1
1
  {
2
- "version": "1.0.1",
3
2
  "commands": {
4
3
  "authenticate": {
5
- "id": "authenticate",
6
- "description": "Set your testRigor authentication token",
7
- "strict": true,
8
- "pluginName": "@testrigor/testrigor-cli",
9
- "pluginAlias": "@testrigor/testrigor-cli",
10
- "pluginType": "core",
11
4
  "aliases": [],
12
- "hiddenAliases": [],
5
+ "args": {},
6
+ "description": "Set your testRigor authentication token",
13
7
  "examples": [
14
8
  "testrigor authenticate",
15
9
  "Prompts for your API authentication token",
10
+ "testrigor authenticate --token YOUR_TOKEN",
11
+ "Sets the token without prompting (for CI and scripts)",
16
12
  "Use 'testrigor test-suite config' to set default test suite ID separately",
17
13
  "Config will be stored in ~/.testrigor/testrigor.yml"
18
14
  ],
19
- "flags": {},
20
- "args": {}
21
- },
22
- "test-suite:config": {
23
- "id": "test-suite:config",
24
- "description": "Configure test suite settings and default test suite ID",
25
- "strict": true,
26
- "pluginName": "@testrigor/testrigor-cli",
15
+ "flags": {
16
+ "token": {
17
+ "description": "API authentication token to store, instead of prompting for it",
18
+ "name": "token",
19
+ "hasDynamicHelp": false,
20
+ "multiple": false,
21
+ "type": "option"
22
+ }
23
+ },
24
+ "hasDynamicHelp": false,
25
+ "hiddenAliases": [],
26
+ "id": "authenticate",
27
27
  "pluginAlias": "@testrigor/testrigor-cli",
28
+ "pluginName": "@testrigor/testrigor-cli",
28
29
  "pluginType": "core",
30
+ "strict": true,
31
+ "isESM": false,
32
+ "relativePath": [
33
+ "dist",
34
+ "commands",
35
+ "authenticate.js"
36
+ ]
37
+ },
38
+ "test-suite:config": {
29
39
  "aliases": [],
30
- "hiddenAliases": [],
40
+ "args": {},
41
+ "description": "Configure test suite settings and default test suite ID",
31
42
  "examples": [
32
43
  "testrigor test-suite config --default TEST-SUITE-ID",
33
44
  "testrigor test-suite config --show",
@@ -35,177 +46,206 @@
35
46
  ],
36
47
  "flags": {
37
48
  "default": {
38
- "name": "default",
39
- "type": "option",
40
49
  "description": "Set the default test suite ID",
41
- "multiple": false,
42
50
  "exclusive": [
43
51
  "delete",
44
52
  "show"
45
- ]
53
+ ],
54
+ "name": "default",
55
+ "hasDynamicHelp": false,
56
+ "multiple": false,
57
+ "type": "option"
46
58
  },
47
59
  "delete": {
48
- "name": "delete",
49
- "type": "boolean",
50
60
  "description": "Remove the default test suite ID",
51
- "allowNo": false,
52
61
  "exclusive": [
53
62
  "default",
54
63
  "show"
55
- ]
64
+ ],
65
+ "name": "delete",
66
+ "allowNo": false,
67
+ "type": "boolean"
56
68
  },
57
69
  "show": {
58
- "name": "show",
59
- "type": "boolean",
60
70
  "description": "Show current configuration",
61
- "allowNo": false,
62
71
  "exclusive": [
63
72
  "default",
64
73
  "delete"
65
- ]
74
+ ],
75
+ "name": "show",
76
+ "allowNo": false,
77
+ "type": "boolean"
66
78
  }
67
79
  },
68
- "args": {}
69
- },
70
- "test-suite:run": {
71
- "id": "test-suite:run",
72
- "description": "Run all tests of a Test Suite",
73
- "strict": true,
74
- "pluginName": "@testrigor/testrigor-cli",
80
+ "hasDynamicHelp": false,
81
+ "hiddenAliases": [],
82
+ "id": "test-suite:config",
75
83
  "pluginAlias": "@testrigor/testrigor-cli",
84
+ "pluginName": "@testrigor/testrigor-cli",
76
85
  "pluginType": "core",
86
+ "strict": true,
87
+ "isESM": false,
88
+ "relativePath": [
89
+ "dist",
90
+ "commands",
91
+ "test-suite",
92
+ "config.js"
93
+ ]
94
+ },
95
+ "test-suite:run": {
77
96
  "aliases": [],
78
- "hiddenAliases": [],
97
+ "args": {
98
+ "testSuiteId": {
99
+ "description": "The test suite id (optional if set in config)",
100
+ "name": "testSuiteId",
101
+ "required": false
102
+ }
103
+ },
104
+ "description": "Run all tests of a Test Suite",
79
105
  "examples": [],
80
106
  "flags": {
81
107
  "auth-token": {
82
- "name": "auth-token",
83
- "type": "option",
84
108
  "description": "Personal authentication token",
85
- "required": false,
86
109
  "helpGroup": "GLOBAL",
87
- "multiple": false
110
+ "name": "auth-token",
111
+ "required": false,
112
+ "hasDynamicHelp": false,
113
+ "multiple": false,
114
+ "type": "option"
88
115
  },
89
116
  "token": {
90
- "name": "token",
91
- "type": "option",
92
117
  "char": "t",
93
118
  "description": "Suite authentication token",
94
- "required": false,
95
119
  "helpGroup": "GLOBAL",
96
- "multiple": false
120
+ "name": "token",
121
+ "required": false,
122
+ "hasDynamicHelp": false,
123
+ "multiple": false,
124
+ "type": "option"
97
125
  },
98
126
  "min-port": {
99
- "name": "min-port",
100
- "type": "option",
101
127
  "description": "Min port for tunnel",
128
+ "name": "min-port",
129
+ "default": 40000,
130
+ "hasDynamicHelp": false,
102
131
  "multiple": false,
103
- "default": 40000
132
+ "type": "option"
104
133
  },
105
134
  "max-port": {
106
- "name": "max-port",
107
- "type": "option",
108
135
  "description": "Max port for tunnel",
136
+ "name": "max-port",
137
+ "default": 50000,
138
+ "hasDynamicHelp": false,
109
139
  "multiple": false,
110
- "default": 50000
140
+ "type": "option"
111
141
  },
112
142
  "verbose": {
113
- "name": "verbose",
114
- "type": "boolean",
115
143
  "description": "Verbose output",
116
144
  "helpGroup": "GLOBAL",
117
- "allowNo": false
145
+ "name": "verbose",
146
+ "allowNo": false,
147
+ "type": "boolean"
118
148
  },
119
149
  "async": {
120
- "name": "async",
121
- "type": "boolean",
150
+ "aliases": [
151
+ "nowait"
152
+ ],
122
153
  "char": "w",
123
154
  "description": "Don't wait for the test suite to finish",
155
+ "name": "async",
124
156
  "allowNo": false,
125
- "aliases": [
126
- "nowait"
127
- ]
157
+ "type": "boolean"
128
158
  },
129
159
  "branch": {
130
- "name": "branch",
131
- "type": "option",
132
- "description": "The branch name",
133
- "multiple": false,
134
160
  "dependsOn": [
135
161
  "commit"
136
- ]
162
+ ],
163
+ "description": "The branch name",
164
+ "env": "TR_BRANCH",
165
+ "name": "branch",
166
+ "hasDynamicHelp": false,
167
+ "multiple": false,
168
+ "type": "option"
137
169
  },
138
170
  "commit": {
139
- "name": "commit",
140
- "type": "option",
141
- "description": "The commit",
142
- "multiple": false,
143
171
  "dependsOn": [
144
172
  "branch"
145
- ]
173
+ ],
174
+ "description": "The commit",
175
+ "env": "TR_COMMIT",
176
+ "name": "commit",
177
+ "hasDynamicHelp": false,
178
+ "multiple": false,
179
+ "type": "option"
146
180
  },
147
181
  "localhost": {
148
- "name": "localhost",
149
- "type": "boolean",
150
- "description": "Localhost run (auto-detects web vs mobile)",
151
- "allowNo": false,
152
182
  "aliases": [
153
183
  "tunnel"
154
- ]
184
+ ],
185
+ "description": "Localhost run (auto-detects web vs mobile)",
186
+ "name": "localhost",
187
+ "allowNo": false,
188
+ "type": "boolean"
155
189
  },
156
190
  "url": {
157
- "name": "url",
158
- "type": "option",
159
191
  "description": "The url",
160
- "multiple": false
192
+ "name": "url",
193
+ "hasDynamicHelp": false,
194
+ "multiple": false,
195
+ "type": "option"
161
196
  },
162
197
  "file-path": {
163
- "name": "file-path",
164
- "type": "option",
165
198
  "description": "Path to the file stored locally. It will upload the new file to be used. File type should be according to the file type accepted for the Test Suite type of testing. If the parameter --url is used, this parameter will be ignored.",
166
- "multiple": false
199
+ "name": "file-path",
200
+ "hasDynamicHelp": false,
201
+ "multiple": false,
202
+ "type": "option"
167
203
  },
168
204
  "junit-report-save-path": {
169
- "name": "junit-report-save-path",
170
- "type": "option",
171
205
  "description": "JUnit report save path",
172
- "multiple": false
206
+ "name": "junit-report-save-path",
207
+ "hasDynamicHelp": false,
208
+ "multiple": false,
209
+ "type": "option"
173
210
  },
174
211
  "variables-path": {
175
- "name": "variables-path",
176
- "type": "option",
177
212
  "description": "Variables path",
178
- "multiple": false
213
+ "name": "variables-path",
214
+ "hasDynamicHelp": false,
215
+ "multiple": false,
216
+ "type": "option"
179
217
  },
180
218
  "test-cases-path": {
181
- "name": "test-cases-path",
182
- "type": "option",
183
219
  "description": "Test cases files",
184
- "multiple": false
220
+ "name": "test-cases-path",
221
+ "hasDynamicHelp": false,
222
+ "multiple": false,
223
+ "type": "option"
185
224
  },
186
225
  "rules-path": {
187
- "name": "rules-path",
188
- "type": "option",
189
226
  "description": "Rules path",
190
- "multiple": false
227
+ "name": "rules-path",
228
+ "hasDynamicHelp": false,
229
+ "multiple": false,
230
+ "type": "option"
191
231
  },
192
232
  "settings-path": {
193
- "name": "settings-path",
194
- "type": "option",
195
233
  "description": "Settings path",
196
- "multiple": false
234
+ "name": "settings-path",
235
+ "hasDynamicHelp": false,
236
+ "multiple": false,
237
+ "type": "option"
197
238
  },
198
239
  "local-test-nodes-path": {
199
- "name": "local-test-nodes-path",
200
- "type": "option",
201
240
  "description": "Path to a YAML or JSON file with local test nodes configuration",
202
- "multiple": false
241
+ "name": "local-test-nodes-path",
242
+ "hasDynamicHelp": false,
243
+ "multiple": false,
244
+ "type": "option"
203
245
  },
204
246
  "test-case-uuid": {
205
- "name": "test-case-uuid",
206
- "type": "option",
207
247
  "description": "Test case uuid (can be repeated). Requires --url (web) or --file-path (mobile app upload).",
208
- "multiple": true,
248
+ "name": "test-case-uuid",
209
249
  "relationships": [
210
250
  {
211
251
  "type": "some",
@@ -214,164 +254,197 @@
214
254
  "file-path"
215
255
  ]
216
256
  }
217
- ]
257
+ ],
258
+ "hasDynamicHelp": false,
259
+ "multiple": true,
260
+ "type": "option"
218
261
  },
219
262
  "auto-create-ai-rules": {
220
- "name": "auto-create-ai-rules",
221
- "type": "boolean",
222
263
  "description": "Enable auto create AI based rules",
223
- "allowNo": false
264
+ "name": "auto-create-ai-rules",
265
+ "allowNo": false,
266
+ "type": "boolean"
224
267
  },
225
268
  "explicit-mutations": {
226
- "name": "explicit-mutations",
227
- "type": "boolean",
228
269
  "description": "In cases where you are always using mutations, such as storing test cases in your own repository, and you always send us the set of test cases you have through our API you should send \"--explicit-mutations\"",
229
- "allowNo": false
270
+ "name": "explicit-mutations",
271
+ "allowNo": false,
272
+ "type": "boolean"
230
273
  },
231
274
  "labels": {
232
- "name": "labels",
233
- "type": "option",
234
275
  "description": "Run tests of specific labels",
235
- "multiple": true
276
+ "name": "labels",
277
+ "hasDynamicHelp": false,
278
+ "multiple": true,
279
+ "type": "option"
236
280
  },
237
281
  "excluded-labels": {
238
- "name": "excluded-labels",
239
- "type": "option",
240
282
  "description": "Not run tests of specific labels",
241
- "multiple": true
283
+ "name": "excluded-labels",
284
+ "hasDynamicHelp": false,
285
+ "multiple": true,
286
+ "type": "option"
242
287
  },
243
288
  "base-url-web": {
244
- "name": "base-url-web",
245
- "type": "option",
246
289
  "description": "Base URL for web interface (e.g., https://app.testrigor.com)",
247
- "multiple": false
290
+ "name": "base-url-web",
291
+ "hasDynamicHelp": false,
292
+ "multiple": false,
293
+ "type": "option"
248
294
  },
249
295
  "base-url-api": {
250
- "name": "base-url-api",
251
- "type": "option",
252
296
  "description": "Base URL for API2 (e.g., https://api2.testrigor.com)",
253
- "multiple": false
297
+ "name": "base-url-api",
298
+ "hasDynamicHelp": false,
299
+ "multiple": false,
300
+ "type": "option"
254
301
  },
255
302
  "chrome-extension": {
256
- "name": "chrome-extension",
257
- "type": "option",
258
303
  "description": "Chrome extension: \"name=EXT_NAME file=PATH_TO_CRX\"",
259
- "multiple": true,
260
304
  "exclusive": [
261
305
  "file-path"
262
- ]
306
+ ],
307
+ "name": "chrome-extension",
308
+ "hasDynamicHelp": false,
309
+ "multiple": true,
310
+ "type": "option"
263
311
  },
264
312
  "xray-execution-key": {
265
- "name": "xray-execution-key",
266
- "type": "option",
267
313
  "description": "Reuse an existing Xray Cloud Test Execution by key (e.g. XR-123) instead of creating a new one. Optional; leave blank to create a new execution.",
268
- "multiple": false
314
+ "name": "xray-execution-key",
315
+ "hasDynamicHelp": false,
316
+ "multiple": false,
317
+ "type": "option"
269
318
  }
270
319
  },
320
+ "hasDynamicHelp": false,
321
+ "hiddenAliases": [],
322
+ "id": "test-suite:run",
323
+ "pluginAlias": "@testrigor/testrigor-cli",
324
+ "pluginName": "@testrigor/testrigor-cli",
325
+ "pluginType": "core",
326
+ "strict": true,
327
+ "isESM": false,
328
+ "relativePath": [
329
+ "dist",
330
+ "commands",
331
+ "test-suite",
332
+ "run.js"
333
+ ]
334
+ },
335
+ "test-suite:validate-syntax": {
336
+ "aliases": [],
271
337
  "args": {
272
338
  "testSuiteId": {
273
- "name": "testSuiteId",
274
339
  "description": "The test suite id (optional if set in config)",
340
+ "name": "testSuiteId",
275
341
  "required": false
276
342
  }
277
- }
278
- },
279
- "test-suite:validate-syntax": {
280
- "id": "test-suite:validate-syntax",
343
+ },
281
344
  "description": "Validate step syntax against a test suite's reusable rules, without running the steps",
282
- "strict": true,
283
- "pluginName": "@testrigor/testrigor-cli",
284
- "pluginAlias": "@testrigor/testrigor-cli",
285
- "pluginType": "core",
286
- "aliases": [],
287
- "hiddenAliases": [],
288
345
  "examples": [
289
346
  "testrigor test-suite validate-syntax <test-suite-id> --steps \"click \\\"Login\\\"\"",
290
347
  "testrigor test-suite validate-syntax <test-suite-id> --test-cases-path \"test_cases/**/*.{yaml,txt}\""
291
348
  ],
292
349
  "flags": {
293
350
  "auth-token": {
294
- "name": "auth-token",
295
- "type": "option",
296
351
  "description": "Personal authentication token",
297
- "required": false,
298
352
  "helpGroup": "GLOBAL",
299
- "multiple": false
353
+ "name": "auth-token",
354
+ "required": false,
355
+ "hasDynamicHelp": false,
356
+ "multiple": false,
357
+ "type": "option"
300
358
  },
301
359
  "token": {
302
- "name": "token",
303
- "type": "option",
304
360
  "char": "t",
305
361
  "description": "Suite authentication token",
306
- "required": false,
307
362
  "helpGroup": "GLOBAL",
308
- "multiple": false
363
+ "name": "token",
364
+ "required": false,
365
+ "hasDynamicHelp": false,
366
+ "multiple": false,
367
+ "type": "option"
309
368
  },
310
369
  "min-port": {
311
- "name": "min-port",
312
- "type": "option",
313
370
  "description": "Min port for tunnel",
371
+ "name": "min-port",
372
+ "default": 40000,
373
+ "hasDynamicHelp": false,
314
374
  "multiple": false,
315
- "default": 40000
375
+ "type": "option"
316
376
  },
317
377
  "max-port": {
318
- "name": "max-port",
319
- "type": "option",
320
378
  "description": "Max port for tunnel",
379
+ "name": "max-port",
380
+ "default": 50000,
381
+ "hasDynamicHelp": false,
321
382
  "multiple": false,
322
- "default": 50000
383
+ "type": "option"
323
384
  },
324
385
  "verbose": {
325
- "name": "verbose",
326
- "type": "boolean",
327
386
  "description": "Verbose output",
328
387
  "helpGroup": "GLOBAL",
329
- "allowNo": false
388
+ "name": "verbose",
389
+ "allowNo": false,
390
+ "type": "boolean"
330
391
  },
331
392
  "steps": {
332
- "name": "steps",
333
- "type": "option",
334
393
  "description": "Raw step text to validate directly",
335
- "multiple": false,
336
394
  "exclusive": [
337
395
  "test-cases-path"
338
- ]
396
+ ],
397
+ "name": "steps",
398
+ "hasDynamicHelp": false,
399
+ "multiple": false,
400
+ "type": "option"
339
401
  },
340
402
  "test-cases-path": {
341
- "name": "test-cases-path",
342
- "type": "option",
343
403
  "description": "Test case files to validate (same glob format as `test-suite run --test-cases-path`)",
344
- "multiple": false,
345
404
  "exclusive": [
346
405
  "steps"
347
- ]
406
+ ],
407
+ "name": "test-cases-path",
408
+ "hasDynamicHelp": false,
409
+ "multiple": false,
410
+ "type": "option"
348
411
  },
349
412
  "base-url-api": {
350
- "name": "base-url-api",
351
- "type": "option",
352
413
  "description": "Base URL for API2 (e.g., https://api2.testrigor.com)",
353
- "multiple": false
414
+ "name": "base-url-api",
415
+ "hasDynamicHelp": false,
416
+ "multiple": false,
417
+ "type": "option"
354
418
  },
355
419
  "rules-path": {
356
- "name": "rules-path",
357
- "type": "option",
358
420
  "description": "Ad hoc reusable rules to validate against, for rules not yet saved to this suite (same glob format as `test-suite run --rules-path`)",
359
- "multiple": false
421
+ "name": "rules-path",
422
+ "hasDynamicHelp": false,
423
+ "multiple": false,
424
+ "type": "option"
360
425
  },
361
426
  "explicit-mutations": {
362
- "name": "explicit-mutations",
363
- "type": "boolean",
364
427
  "description": "Validate using only the supplied rules instead of merging them with the suite's saved rules",
365
- "allowNo": false
428
+ "name": "explicit-mutations",
429
+ "allowNo": false,
430
+ "type": "boolean"
366
431
  }
367
432
  },
368
- "args": {
369
- "testSuiteId": {
370
- "name": "testSuiteId",
371
- "description": "The test suite id (optional if set in config)",
372
- "required": false
373
- }
374
- }
433
+ "hasDynamicHelp": false,
434
+ "hiddenAliases": [],
435
+ "id": "test-suite:validate-syntax",
436
+ "pluginAlias": "@testrigor/testrigor-cli",
437
+ "pluginName": "@testrigor/testrigor-cli",
438
+ "pluginType": "core",
439
+ "strict": true,
440
+ "isESM": false,
441
+ "relativePath": [
442
+ "dist",
443
+ "commands",
444
+ "test-suite",
445
+ "validate-syntax.js"
446
+ ]
375
447
  }
376
- }
448
+ },
449
+ "version": "2.0.1"
377
450
  }