@qawolf/cli 2.2.1 → 2.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.
- package/dist/cli.js +129 -47
- package/dist/investigation-parser.js +34 -14
- package/dist/runner-sdk.js +75 -8
- package/package.json +1 -1
- package/skills/qawolf-cli/SKILL.md +6 -0
- package/skills/qawolf-cli/references/runner.md +298 -48
|
@@ -6,6 +6,8 @@ An interactive runner is a live pod with a browser or a mobile device in it. You
|
|
|
6
6
|
|
|
7
7
|
## Which runner a command reaches
|
|
8
8
|
|
|
9
|
+
Every runner command works in the workspace `qawolf auth switch` saved, unless it is given `--workspace-id <id>`. The flag holds for that one command and is never saved, so sessions on one machine working on different workspaces do not move each other. Since runner ids are scoped to a team, pass the same `--workspace-id` to every command that drives a runner you launched with it; leave it off one and that command looks for the runner in the saved workspace.
|
|
10
|
+
|
|
9
11
|
Commands that target a runner find one in this order: `--runner`, then `QAWOLF_RUNNER_ID`, then the runner stored for the current directory, which `qawolf runner launch` sets. Setting the environment variable once is the most robust for a harness whose working directory may not be stable, with two catches:
|
|
10
12
|
|
|
11
13
|
- `qawolf runner launch` is not in that order: it takes its id from `--id` and never reads `QAWOLF_RUNNER_ID`. Pass `--id` whenever you have an id in mind.
|
|
@@ -23,9 +25,9 @@ Any other runner, such as a mobile one, has no screen until its first run, and n
|
|
|
23
25
|
|
|
24
26
|
## Exit codes
|
|
25
27
|
|
|
26
|
-
Retry on the exit code
|
|
28
|
+
Retry on the exit code:
|
|
27
29
|
|
|
28
|
-
- `4` is transient, with one exception. The screen cannot serve this instant: still coming up just after launch, restarting after a display-size change, or busy with another request. Retry in a second or two, and bound the retries. The exception is a command that changes something, where a `4` can instead mean the answer was lost with the work in flight. For `act` and `actions`, take a screenshot first and repeat only what the screen says did not happen. For `run`, poll `run-status` instead of submitting again, since a second submission risks a second billed run. For `exec`, check the effect the snippet was meant to have before running it again.
|
|
30
|
+
- `4` is transient, with one exception. The screen cannot serve this instant: still coming up just after launch, restarting after a display-size change, or busy with another request. Retry in a second or two, and bound the retries. The exception is a command that changes something, where a `4` can instead mean the answer was lost with the work in flight, unless the message says nothing was sent. For `act` and `actions`, take a screenshot first and repeat only what the screen says did not happen. For `run`, poll `run-status` instead of submitting again, since a second submission risks a second billed run. For `exec`, check the effect the snippet was meant to have before running it again.
|
|
29
31
|
- `6` means the work ran out of the time it is given.
|
|
30
32
|
- `7` means billing prevented the request, such as a plan that does not cover the runner you asked for. The message says what was refused and what clears it.
|
|
31
33
|
- `8` means there is no such runner. It was never launched, or it was terminated, or it idled out. Retrying never brings one back, so stop and launch the id or name one that is running. The message says which runner was meant and whether `--runner`, `QAWOLF_RUNNER_ID` or this directory's stored default chose it; read that line before you pick an id to launch.
|
|
@@ -64,8 +66,17 @@ Usage: qawolf runner [options] [command]
|
|
|
64
66
|
Drive an interactive runner on the QA Wolf platform
|
|
65
67
|
|
|
66
68
|
Options:
|
|
69
|
+
--workspace-id <id> Workspace to work in for this command only. Defaults to
|
|
70
|
+
the one 'qawolf auth switch' saved, and is never saved
|
|
71
|
+
itself
|
|
67
72
|
-h, --help display help for command
|
|
68
73
|
|
|
74
|
+
Global Options:
|
|
75
|
+
-V, --version output the version number
|
|
76
|
+
--verbose Enable debug logging to stderr
|
|
77
|
+
--json Output as JSON
|
|
78
|
+
--agent Output for agent consumption
|
|
79
|
+
|
|
69
80
|
Commands:
|
|
70
81
|
launch [options] Launch an interactive runner and make it this directory's
|
|
71
82
|
default
|
|
@@ -110,7 +121,8 @@ Commands:
|
|
|
110
121
|
to clear the highlight
|
|
111
122
|
promote-snapshot [options] Accept a run's screenshot as the new baseline for an
|
|
112
123
|
image diff, on the runner that produced it
|
|
113
|
-
record Control video recording on a
|
|
124
|
+
record Control video recording on a browser, mobile, Windows, or
|
|
125
|
+
Mac runner
|
|
114
126
|
list-recordings [options] Read a page of published video recordings, including
|
|
115
127
|
after the runner terminates. Platform URLs persist; video
|
|
116
128
|
URLs expire
|
|
@@ -125,9 +137,17 @@ Usage: qawolf runner launch [options]
|
|
|
125
137
|
Launch an interactive runner and make it this directory's default
|
|
126
138
|
|
|
127
139
|
Options:
|
|
128
|
-
--id <id>
|
|
129
|
-
--name <family>
|
|
130
|
-
-h, --help
|
|
140
|
+
--id <id> Id to launch under. Relaunching an id attaches to that runner
|
|
141
|
+
--name <family> Runner family to run, e.g. playwright
|
|
142
|
+
-h, --help display help for command
|
|
143
|
+
|
|
144
|
+
Global Options:
|
|
145
|
+
--workspace-id <id> Workspace to work in for this command only. Defaults to the one 'qawolf auth
|
|
146
|
+
switch' saved, and is never saved itself
|
|
147
|
+
-V, --version output the version number
|
|
148
|
+
--verbose Enable debug logging to stderr
|
|
149
|
+
--json Output as JSON
|
|
150
|
+
--agent Output for agent consumption
|
|
131
151
|
|
|
132
152
|
Examples:
|
|
133
153
|
$ qawolf runner launch
|
|
@@ -182,8 +202,16 @@ Usage: qawolf runner list [options]
|
|
|
182
202
|
List the runners running on your team
|
|
183
203
|
|
|
184
204
|
Options:
|
|
185
|
-
--here
|
|
186
|
-
-h, --help
|
|
205
|
+
--here Only the runners this directory launched or QAWOLF_RUNNER_ID names
|
|
206
|
+
-h, --help display help for command
|
|
207
|
+
|
|
208
|
+
Global Options:
|
|
209
|
+
--workspace-id <id> Workspace to work in for this command only. Defaults to the one 'qawolf auth
|
|
210
|
+
switch' saved, and is never saved itself
|
|
211
|
+
-V, --version output the version number
|
|
212
|
+
--verbose Enable debug logging to stderr
|
|
213
|
+
--json Output as JSON
|
|
214
|
+
--agent Output for agent consumption
|
|
187
215
|
|
|
188
216
|
Examples:
|
|
189
217
|
$ qawolf runner list
|
|
@@ -221,8 +249,17 @@ Usage: qawolf runner terminate [options]
|
|
|
221
249
|
End an interactive runner, and the pod it runs on with it
|
|
222
250
|
|
|
223
251
|
Options:
|
|
224
|
-
--runner <id>
|
|
225
|
-
|
|
252
|
+
--runner <id> Runner to target. Defaults to QAWOLF_RUNNER_ID, then this directory's stored
|
|
253
|
+
runner
|
|
254
|
+
-h, --help display help for command
|
|
255
|
+
|
|
256
|
+
Global Options:
|
|
257
|
+
--workspace-id <id> Workspace to work in for this command only. Defaults to the one 'qawolf auth
|
|
258
|
+
switch' saved, and is never saved itself
|
|
259
|
+
-V, --version output the version number
|
|
260
|
+
--verbose Enable debug logging to stderr
|
|
261
|
+
--json Output as JSON
|
|
262
|
+
--agent Output for agent consumption
|
|
226
263
|
|
|
227
264
|
Stopping a run or ending a runner:
|
|
228
265
|
Two different things, and the names are the only warning you get:
|
|
@@ -247,8 +284,17 @@ Usage: qawolf runner stop-run [options]
|
|
|
247
284
|
Stop what a runner is currently executing, leaving the runner up
|
|
248
285
|
|
|
249
286
|
Options:
|
|
250
|
-
--runner <id>
|
|
251
|
-
|
|
287
|
+
--runner <id> Runner to target. Defaults to QAWOLF_RUNNER_ID, then this directory's stored
|
|
288
|
+
runner
|
|
289
|
+
-h, --help display help for command
|
|
290
|
+
|
|
291
|
+
Global Options:
|
|
292
|
+
--workspace-id <id> Workspace to work in for this command only. Defaults to the one 'qawolf auth
|
|
293
|
+
switch' saved, and is never saved itself
|
|
294
|
+
-V, --version output the version number
|
|
295
|
+
--verbose Enable debug logging to stderr
|
|
296
|
+
--json Output as JSON
|
|
297
|
+
--agent Output for agent consumption
|
|
252
298
|
|
|
253
299
|
Stopping a run or ending a runner:
|
|
254
300
|
Two different things, and the names are the only warning you get:
|
|
@@ -273,8 +319,17 @@ Usage: qawolf runner keepalive [options]
|
|
|
273
319
|
Reset a runner's inactivity clock, for a caller that pauses between actions
|
|
274
320
|
|
|
275
321
|
Options:
|
|
276
|
-
--runner <id>
|
|
277
|
-
|
|
322
|
+
--runner <id> Runner to target. Defaults to QAWOLF_RUNNER_ID, then this directory's stored
|
|
323
|
+
runner
|
|
324
|
+
-h, --help display help for command
|
|
325
|
+
|
|
326
|
+
Global Options:
|
|
327
|
+
--workspace-id <id> Workspace to work in for this command only. Defaults to the one 'qawolf auth
|
|
328
|
+
switch' saved, and is never saved itself
|
|
329
|
+
-V, --version output the version number
|
|
330
|
+
--verbose Enable debug logging to stderr
|
|
331
|
+
--json Output as JSON
|
|
332
|
+
--agent Output for agent consumption
|
|
278
333
|
|
|
279
334
|
Examples:
|
|
280
335
|
$ qawolf runner keepalive
|
|
@@ -328,6 +383,14 @@ Options:
|
|
|
328
383
|
"3600")
|
|
329
384
|
-h, --help display help for command
|
|
330
385
|
|
|
386
|
+
Global Options:
|
|
387
|
+
--workspace-id <id> Workspace to work in for this command only. Defaults to the one 'qawolf auth
|
|
388
|
+
switch' saved, and is never saved itself
|
|
389
|
+
-V, --version output the version number
|
|
390
|
+
--verbose Enable debug logging to stderr
|
|
391
|
+
--json Output as JSON
|
|
392
|
+
--agent Output for agent consumption
|
|
393
|
+
|
|
331
394
|
Examples:
|
|
332
395
|
$ qawolf runner run flows/checkout.flow.ts
|
|
333
396
|
$ qawolf runner run flows/checkout.flow.ts --follow
|
|
@@ -470,6 +533,14 @@ Options:
|
|
|
470
533
|
"3600")
|
|
471
534
|
-h, --help display help for command
|
|
472
535
|
|
|
536
|
+
Global Options:
|
|
537
|
+
--workspace-id <id> Workspace to work in for this command only. Defaults to the one 'qawolf auth
|
|
538
|
+
switch' saved, and is never saved itself
|
|
539
|
+
-V, --version output the version number
|
|
540
|
+
--verbose Enable debug logging to stderr
|
|
541
|
+
--json Output as JSON
|
|
542
|
+
--agent Output for agent consumption
|
|
543
|
+
|
|
473
544
|
Examples:
|
|
474
545
|
$ qawolf runner events recorder --tail 5
|
|
475
546
|
$ qawolf runner events run-logs --run <runId> --follow
|
|
@@ -543,10 +614,20 @@ Usage: qawolf runner screenshot [options]
|
|
|
543
614
|
Save a JPEG of an interactive runner's screen to a file, or write it to stdout with --out -
|
|
544
615
|
|
|
545
616
|
Options:
|
|
546
|
-
--out <path>
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
617
|
+
--out <path> File to write the image to. - writes the JPEG bytes to stdout on their own
|
|
618
|
+
and moves the confirmation, JSON included, to stderr (default:
|
|
619
|
+
"screenshot.jpg")
|
|
620
|
+
--runner <id> Runner to target. Defaults to QAWOLF_RUNNER_ID, then this directory's stored
|
|
621
|
+
runner
|
|
622
|
+
-h, --help display help for command
|
|
623
|
+
|
|
624
|
+
Global Options:
|
|
625
|
+
--workspace-id <id> Workspace to work in for this command only. Defaults to the one 'qawolf auth
|
|
626
|
+
switch' saved, and is never saved itself
|
|
627
|
+
-V, --version output the version number
|
|
628
|
+
--verbose Enable debug logging to stderr
|
|
629
|
+
--json Output as JSON
|
|
630
|
+
--agent Output for agent consumption
|
|
550
631
|
|
|
551
632
|
Examples:
|
|
552
633
|
$ qawolf runner screenshot
|
|
@@ -591,8 +672,8 @@ Options:
|
|
|
591
672
|
place of a separate screenshot. An action that did not take effect answers
|
|
592
673
|
with one too. - writes it to stdout and moves the confirmation, JSON
|
|
593
674
|
included, to stderr
|
|
594
|
-
--scroll-x <delta> scroll: horizontal wheel delta
|
|
595
|
-
--scroll-y <delta> scroll: vertical wheel delta
|
|
675
|
+
--scroll-x <delta> scroll: horizontal wheel delta, 0 when only --scroll-y is given
|
|
676
|
+
--scroll-y <delta> scroll: vertical wheel delta, 0 when only --scroll-x is given
|
|
596
677
|
--selector <selector> tap or fill: the element to act on, as a screen object would find it. tap
|
|
597
678
|
takes it in place of --x and --y
|
|
598
679
|
--strategy <strategy> how --selector is resolved: xpath (default), ios-predicate or shadow
|
|
@@ -603,10 +684,19 @@ Options:
|
|
|
603
684
|
--y <pixels> click, tap and the like: y, in screenshot pixels
|
|
604
685
|
-h, --help display help for command
|
|
605
686
|
|
|
687
|
+
Global Options:
|
|
688
|
+
--workspace-id <id> Workspace to work in for this command only. Defaults to the one 'qawolf
|
|
689
|
+
auth switch' saved, and is never saved itself
|
|
690
|
+
-V, --version output the version number
|
|
691
|
+
--verbose Enable debug logging to stderr
|
|
692
|
+
--json Output as JSON
|
|
693
|
+
--agent Output for agent consumption
|
|
694
|
+
|
|
606
695
|
Examples:
|
|
607
696
|
$ qawolf runner act click --button left --x 480 --y 260
|
|
608
697
|
$ qawolf runner act type --text "hello@example.com"
|
|
609
698
|
$ qawolf runner act keypress --keys Control a
|
|
699
|
+
$ qawolf runner act scroll --x 640 --y 400 --scroll-y 600
|
|
610
700
|
$ qawolf runner act navigate --url https://example.com
|
|
611
701
|
$ qawolf runner act drag --path '[{"x":10,"y":20},{"x":80,"y":90}]'
|
|
612
702
|
$ qawolf runner act click --button left --x 480 --y 260 --screenshot step-4.jpg
|
|
@@ -643,9 +733,9 @@ Seeing and acting:
|
|
|
643
733
|
instead. Bounds are checked before anything is sent, so an over-long --text or
|
|
644
734
|
an out-of-range coordinate comes back immediately naming the limit.
|
|
645
735
|
|
|
646
|
-
On a 4, the
|
|
647
|
-
|
|
648
|
-
not happen.
|
|
736
|
+
On a 4, unless the message says nothing was sent, the answer may have been
|
|
737
|
+
lost with the action in flight: take a screenshot before repeating a click,
|
|
738
|
+
and repeat only what the screen says did not happen.
|
|
649
739
|
|
|
650
740
|
Mobile:
|
|
651
741
|
A mobile runner has a touchscreen, not a mouse, so it has actions of its own:
|
|
@@ -698,6 +788,14 @@ Options:
|
|
|
698
788
|
"none", "final", "each")
|
|
699
789
|
-h, --help display help for command
|
|
700
790
|
|
|
791
|
+
Global Options:
|
|
792
|
+
--workspace-id <id> Workspace to work in for this command only. Defaults to the one 'qawolf
|
|
793
|
+
auth switch' saved, and is never saved itself
|
|
794
|
+
-V, --version output the version number
|
|
795
|
+
--verbose Enable debug logging to stderr
|
|
796
|
+
--json Output as JSON
|
|
797
|
+
--agent Output for agent consumption
|
|
798
|
+
|
|
701
799
|
Examples:
|
|
702
800
|
$ qawolf runner actions '[{"type":"click","button":"left","x":480,"y":260},{"type":"type","text":"hello@example.com"},{"type":"keypress","keys":["Enter"]}]' --screenshot after-login.jpg
|
|
703
801
|
$ echo '[{"type":"click","button":"left","x":1,"y":2},{"type":"type","text":"hi"}]' | qawolf runner actions -
|
|
@@ -764,10 +862,19 @@ Usage: qawolf runner exec [options] <file>
|
|
|
764
862
|
Evaluate a snippet against a runner's live page. Use - to read the snippet from stdin
|
|
765
863
|
|
|
766
864
|
Options:
|
|
767
|
-
--file <path>
|
|
768
|
-
|
|
769
|
-
--runner <id>
|
|
770
|
-
|
|
865
|
+
--file <path> File whose scope the snippet is evaluated in; it and the directory's other
|
|
866
|
+
files travel with it
|
|
867
|
+
--runner <id> Runner to target. Defaults to QAWOLF_RUNNER_ID, then this directory's stored
|
|
868
|
+
runner
|
|
869
|
+
-h, --help display help for command
|
|
870
|
+
|
|
871
|
+
Global Options:
|
|
872
|
+
--workspace-id <id> Workspace to work in for this command only. Defaults to the one 'qawolf auth
|
|
873
|
+
switch' saved, and is never saved itself
|
|
874
|
+
-V, --version output the version number
|
|
875
|
+
--verbose Enable debug logging to stderr
|
|
876
|
+
--json Output as JSON
|
|
877
|
+
--agent Output for agent consumption
|
|
771
878
|
|
|
772
879
|
Examples:
|
|
773
880
|
$ qawolf runner exec snippet.ts
|
|
@@ -813,6 +920,14 @@ Read one thing off a runner's live page (browser) or Appium session (mobile)
|
|
|
813
920
|
Options:
|
|
814
921
|
-h, --help display help for command
|
|
815
922
|
|
|
923
|
+
Global Options:
|
|
924
|
+
--workspace-id <id> Workspace to work in for this command only. Defaults to the one 'qawolf
|
|
925
|
+
auth switch' saved, and is never saved itself
|
|
926
|
+
-V, --version output the version number
|
|
927
|
+
--verbose Enable debug logging to stderr
|
|
928
|
+
--json Output as JSON
|
|
929
|
+
--agent Output for agent consumption
|
|
930
|
+
|
|
816
931
|
Commands:
|
|
817
932
|
element-html [options] Print the HTML of the first element a selector matches
|
|
818
933
|
page-html [options] Print the page's HTML, simplified for a model to read
|
|
@@ -901,6 +1016,14 @@ Options:
|
|
|
901
1016
|
--runner <id> Runner to target. Defaults to QAWOLF_RUNNER_ID, then this directory's
|
|
902
1017
|
stored runner
|
|
903
1018
|
-h, --help display help for command
|
|
1019
|
+
|
|
1020
|
+
Global Options:
|
|
1021
|
+
--workspace-id <id> Workspace to work in for this command only. Defaults to the one 'qawolf
|
|
1022
|
+
auth switch' saved, and is never saved itself
|
|
1023
|
+
-V, --version output the version number
|
|
1024
|
+
--verbose Enable debug logging to stderr
|
|
1025
|
+
--json Output as JSON
|
|
1026
|
+
--agent Output for agent consumption
|
|
904
1027
|
```
|
|
905
1028
|
|
|
906
1029
|
### qawolf runner inspect page-html
|
|
@@ -915,6 +1038,14 @@ Options:
|
|
|
915
1038
|
--runner <id> Runner to target. Defaults to QAWOLF_RUNNER_ID, then this directory's
|
|
916
1039
|
stored runner
|
|
917
1040
|
-h, --help display help for command
|
|
1041
|
+
|
|
1042
|
+
Global Options:
|
|
1043
|
+
--workspace-id <id> Workspace to work in for this command only. Defaults to the one 'qawolf
|
|
1044
|
+
auth switch' saved, and is never saved itself
|
|
1045
|
+
-V, --version output the version number
|
|
1046
|
+
--verbose Enable debug logging to stderr
|
|
1047
|
+
--json Output as JSON
|
|
1048
|
+
--agent Output for agent consumption
|
|
918
1049
|
```
|
|
919
1050
|
|
|
920
1051
|
### qawolf runner inspect variable
|
|
@@ -925,9 +1056,18 @@ Usage: qawolf runner inspect variable [options]
|
|
|
925
1056
|
Print a top-level variable's value from the running workflow
|
|
926
1057
|
|
|
927
1058
|
Options:
|
|
928
|
-
--name <name>
|
|
929
|
-
--runner <id>
|
|
930
|
-
|
|
1059
|
+
--name <name> Name of the variable to read
|
|
1060
|
+
--runner <id> Runner to target. Defaults to QAWOLF_RUNNER_ID, then this directory's stored
|
|
1061
|
+
runner
|
|
1062
|
+
-h, --help display help for command
|
|
1063
|
+
|
|
1064
|
+
Global Options:
|
|
1065
|
+
--workspace-id <id> Workspace to work in for this command only. Defaults to the one 'qawolf auth
|
|
1066
|
+
switch' saved, and is never saved itself
|
|
1067
|
+
-V, --version output the version number
|
|
1068
|
+
--verbose Enable debug logging to stderr
|
|
1069
|
+
--json Output as JSON
|
|
1070
|
+
--agent Output for agent consumption
|
|
931
1071
|
```
|
|
932
1072
|
|
|
933
1073
|
### qawolf runner inspect session
|
|
@@ -938,8 +1078,17 @@ Usage: qawolf runner inspect session [options]
|
|
|
938
1078
|
Print the Appium session's status: ready, or why not
|
|
939
1079
|
|
|
940
1080
|
Options:
|
|
941
|
-
--runner <id>
|
|
942
|
-
|
|
1081
|
+
--runner <id> Runner to target. Defaults to QAWOLF_RUNNER_ID, then this directory's stored
|
|
1082
|
+
runner
|
|
1083
|
+
-h, --help display help for command
|
|
1084
|
+
|
|
1085
|
+
Global Options:
|
|
1086
|
+
--workspace-id <id> Workspace to work in for this command only. Defaults to the one 'qawolf auth
|
|
1087
|
+
switch' saved, and is never saved itself
|
|
1088
|
+
-V, --version output the version number
|
|
1089
|
+
--verbose Enable debug logging to stderr
|
|
1090
|
+
--json Output as JSON
|
|
1091
|
+
--agent Output for agent consumption
|
|
943
1092
|
```
|
|
944
1093
|
|
|
945
1094
|
### qawolf runner inspect contexts
|
|
@@ -950,8 +1099,17 @@ Usage: qawolf runner inspect contexts [options]
|
|
|
950
1099
|
List the WebView contexts available, and which is current
|
|
951
1100
|
|
|
952
1101
|
Options:
|
|
953
|
-
--runner <id>
|
|
954
|
-
|
|
1102
|
+
--runner <id> Runner to target. Defaults to QAWOLF_RUNNER_ID, then this directory's stored
|
|
1103
|
+
runner
|
|
1104
|
+
-h, --help display help for command
|
|
1105
|
+
|
|
1106
|
+
Global Options:
|
|
1107
|
+
--workspace-id <id> Workspace to work in for this command only. Defaults to the one 'qawolf auth
|
|
1108
|
+
switch' saved, and is never saved itself
|
|
1109
|
+
-V, --version output the version number
|
|
1110
|
+
--verbose Enable debug logging to stderr
|
|
1111
|
+
--json Output as JSON
|
|
1112
|
+
--agent Output for agent consumption
|
|
955
1113
|
```
|
|
956
1114
|
|
|
957
1115
|
### qawolf runner inspect page-source
|
|
@@ -962,10 +1120,18 @@ Usage: qawolf runner inspect page-source [options]
|
|
|
962
1120
|
Print the current context's page source, as a tree
|
|
963
1121
|
|
|
964
1122
|
Options:
|
|
965
|
-
--context <name>
|
|
966
|
-
--runner <id>
|
|
967
|
-
|
|
968
|
-
-h, --help
|
|
1123
|
+
--context <name> Read this context instead of the current one
|
|
1124
|
+
--runner <id> Runner to target. Defaults to QAWOLF_RUNNER_ID, then this directory's stored
|
|
1125
|
+
runner
|
|
1126
|
+
-h, --help display help for command
|
|
1127
|
+
|
|
1128
|
+
Global Options:
|
|
1129
|
+
--workspace-id <id> Workspace to work in for this command only. Defaults to the one 'qawolf auth
|
|
1130
|
+
switch' saved, and is never saved itself
|
|
1131
|
+
-V, --version output the version number
|
|
1132
|
+
--verbose Enable debug logging to stderr
|
|
1133
|
+
--json Output as JSON
|
|
1134
|
+
--agent Output for agent consumption
|
|
969
1135
|
```
|
|
970
1136
|
|
|
971
1137
|
### qawolf runner inspect elements
|
|
@@ -986,6 +1152,14 @@ Options:
|
|
|
986
1152
|
--x <pixels> point: whole pixels on the device's own screen
|
|
987
1153
|
--y <pixels> point: whole pixels on the device's own screen
|
|
988
1154
|
-h, --help display help for command
|
|
1155
|
+
|
|
1156
|
+
Global Options:
|
|
1157
|
+
--workspace-id <id> Workspace to work in for this command only. Defaults to the one 'qawolf
|
|
1158
|
+
auth switch' saved, and is never saved itself
|
|
1159
|
+
-V, --version output the version number
|
|
1160
|
+
--verbose Enable debug logging to stderr
|
|
1161
|
+
--json Output as JSON
|
|
1162
|
+
--agent Output for agent consumption
|
|
989
1163
|
```
|
|
990
1164
|
|
|
991
1165
|
## qawolf runner import-package
|
|
@@ -1001,6 +1175,14 @@ Options:
|
|
|
1001
1175
|
stored runner
|
|
1002
1176
|
-h, --help display help for command
|
|
1003
1177
|
|
|
1178
|
+
Global Options:
|
|
1179
|
+
--workspace-id <id> Workspace to work in for this command only. Defaults to the one
|
|
1180
|
+
'qawolf auth switch' saved, and is never saved itself
|
|
1181
|
+
-V, --version output the version number
|
|
1182
|
+
--verbose Enable debug logging to stderr
|
|
1183
|
+
--json Output as JSON
|
|
1184
|
+
--agent Output for agent consumption
|
|
1185
|
+
|
|
1004
1186
|
Examples:
|
|
1005
1187
|
$ qawolf runner import-package dayjs
|
|
1006
1188
|
$ qawolf runner import-package dayjs --package-version 1.11.13
|
|
@@ -1024,8 +1206,17 @@ Highlight what a selector matches on a runner's live page, so the next screensho
|
|
|
1024
1206
|
selector to clear the highlight
|
|
1025
1207
|
|
|
1026
1208
|
Options:
|
|
1027
|
-
--runner <id>
|
|
1028
|
-
|
|
1209
|
+
--runner <id> Runner to target. Defaults to QAWOLF_RUNNER_ID, then this directory's stored
|
|
1210
|
+
runner
|
|
1211
|
+
-h, --help display help for command
|
|
1212
|
+
|
|
1213
|
+
Global Options:
|
|
1214
|
+
--workspace-id <id> Workspace to work in for this command only. Defaults to the one 'qawolf auth
|
|
1215
|
+
switch' saved, and is never saved itself
|
|
1216
|
+
-V, --version output the version number
|
|
1217
|
+
--verbose Enable debug logging to stderr
|
|
1218
|
+
--json Output as JSON
|
|
1219
|
+
--agent Output for agent consumption
|
|
1029
1220
|
|
|
1030
1221
|
Examples:
|
|
1031
1222
|
$ qawolf runner highlight-selector "text=Sign in"
|
|
@@ -1065,6 +1256,14 @@ Options:
|
|
|
1065
1256
|
runner
|
|
1066
1257
|
-h, --help display help for command
|
|
1067
1258
|
|
|
1259
|
+
Global Options:
|
|
1260
|
+
--workspace-id <id> Workspace to work in for this command only. Defaults to the one 'qawolf auth
|
|
1261
|
+
switch' saved, and is never saved itself
|
|
1262
|
+
-V, --version output the version number
|
|
1263
|
+
--verbose Enable debug logging to stderr
|
|
1264
|
+
--json Output as JSON
|
|
1265
|
+
--agent Output for agent consumption
|
|
1266
|
+
|
|
1068
1267
|
Examples:
|
|
1069
1268
|
$ qawolf runner promote-snapshot --screenshot checkout-1-actual.png --baseline checkout-1.png
|
|
1070
1269
|
$ qawolf runner events run-events --tail 20 | jq 'select(.type == "imageDiffArtifact")'
|
|
@@ -1088,11 +1287,19 @@ Paths:
|
|
|
1088
1287
|
```text
|
|
1089
1288
|
Usage: qawolf runner record [options] [command]
|
|
1090
1289
|
|
|
1091
|
-
Control video recording on a
|
|
1290
|
+
Control video recording on a browser, mobile, Windows, or Mac runner
|
|
1092
1291
|
|
|
1093
1292
|
Options:
|
|
1094
1293
|
-h, --help display help for command
|
|
1095
1294
|
|
|
1295
|
+
Global Options:
|
|
1296
|
+
--workspace-id <id> Workspace to work in for this command only. Defaults to the one
|
|
1297
|
+
'qawolf auth switch' saved, and is never saved itself
|
|
1298
|
+
-V, --version output the version number
|
|
1299
|
+
--verbose Enable debug logging to stderr
|
|
1300
|
+
--json Output as JSON
|
|
1301
|
+
--agent Output for agent consumption
|
|
1302
|
+
|
|
1096
1303
|
Commands:
|
|
1097
1304
|
start [options] Start manual video capture across runs. Requires a ready screen and
|
|
1098
1305
|
suppresses automatic capture until stopped
|
|
@@ -1138,6 +1345,14 @@ Options:
|
|
|
1138
1345
|
--runner <id> Runner to target. Defaults to QAWOLF_RUNNER_ID, then this directory's
|
|
1139
1346
|
stored runner
|
|
1140
1347
|
-h, --help display help for command
|
|
1348
|
+
|
|
1349
|
+
Global Options:
|
|
1350
|
+
--workspace-id <id> Workspace to work in for this command only. Defaults to the one 'qawolf
|
|
1351
|
+
auth switch' saved, and is never saved itself
|
|
1352
|
+
-V, --version output the version number
|
|
1353
|
+
--verbose Enable debug logging to stderr
|
|
1354
|
+
--json Output as JSON
|
|
1355
|
+
--agent Output for agent consumption
|
|
1141
1356
|
```
|
|
1142
1357
|
|
|
1143
1358
|
### qawolf runner record stop
|
|
@@ -1148,8 +1363,17 @@ Usage: qawolf runner record stop [options] <recording-id>
|
|
|
1148
1363
|
Stop the recording with this UUID and publish it. Retrying cannot stop a later recording
|
|
1149
1364
|
|
|
1150
1365
|
Options:
|
|
1151
|
-
--runner <id>
|
|
1152
|
-
|
|
1366
|
+
--runner <id> Runner to target. Defaults to QAWOLF_RUNNER_ID, then this directory's stored
|
|
1367
|
+
runner
|
|
1368
|
+
-h, --help display help for command
|
|
1369
|
+
|
|
1370
|
+
Global Options:
|
|
1371
|
+
--workspace-id <id> Workspace to work in for this command only. Defaults to the one 'qawolf auth
|
|
1372
|
+
switch' saved, and is never saved itself
|
|
1373
|
+
-V, --version output the version number
|
|
1374
|
+
--verbose Enable debug logging to stderr
|
|
1375
|
+
--json Output as JSON
|
|
1376
|
+
--agent Output for agent consumption
|
|
1153
1377
|
```
|
|
1154
1378
|
|
|
1155
1379
|
### qawolf runner record status
|
|
@@ -1160,8 +1384,17 @@ Usage: qawolf runner record status [options]
|
|
|
1160
1384
|
Show the active recording and automatic recording setting
|
|
1161
1385
|
|
|
1162
1386
|
Options:
|
|
1163
|
-
--runner <id>
|
|
1164
|
-
|
|
1387
|
+
--runner <id> Runner to target. Defaults to QAWOLF_RUNNER_ID, then this directory's stored
|
|
1388
|
+
runner
|
|
1389
|
+
-h, --help display help for command
|
|
1390
|
+
|
|
1391
|
+
Global Options:
|
|
1392
|
+
--workspace-id <id> Workspace to work in for this command only. Defaults to the one 'qawolf auth
|
|
1393
|
+
switch' saved, and is never saved itself
|
|
1394
|
+
-V, --version output the version number
|
|
1395
|
+
--verbose Enable debug logging to stderr
|
|
1396
|
+
--json Output as JSON
|
|
1397
|
+
--agent Output for agent consumption
|
|
1165
1398
|
```
|
|
1166
1399
|
|
|
1167
1400
|
### qawolf runner record auto
|
|
@@ -1172,11 +1405,20 @@ Usage: qawolf runner record auto [options] <setting>
|
|
|
1172
1405
|
Enable or disable automatic recording for subsequent full runs
|
|
1173
1406
|
|
|
1174
1407
|
Arguments:
|
|
1175
|
-
setting
|
|
1408
|
+
setting Automatic recording setting (choices: "on", "off")
|
|
1176
1409
|
|
|
1177
1410
|
Options:
|
|
1178
|
-
--runner <id>
|
|
1179
|
-
|
|
1411
|
+
--runner <id> Runner to target. Defaults to QAWOLF_RUNNER_ID, then this directory's stored
|
|
1412
|
+
runner
|
|
1413
|
+
-h, --help display help for command
|
|
1414
|
+
|
|
1415
|
+
Global Options:
|
|
1416
|
+
--workspace-id <id> Workspace to work in for this command only. Defaults to the one 'qawolf auth
|
|
1417
|
+
switch' saved, and is never saved itself
|
|
1418
|
+
-V, --version output the version number
|
|
1419
|
+
--verbose Enable debug logging to stderr
|
|
1420
|
+
--json Output as JSON
|
|
1421
|
+
--agent Output for agent consumption
|
|
1180
1422
|
```
|
|
1181
1423
|
|
|
1182
1424
|
## qawolf runner list-recordings
|
|
@@ -1195,6 +1437,14 @@ Options:
|
|
|
1195
1437
|
--page-token <token> Continue from nextPageToken returned by the previous page
|
|
1196
1438
|
-h, --help display help for command
|
|
1197
1439
|
|
|
1440
|
+
Global Options:
|
|
1441
|
+
--workspace-id <id> Workspace to work in for this command only. Defaults to the one 'qawolf
|
|
1442
|
+
auth switch' saved, and is never saved itself
|
|
1443
|
+
-V, --version output the version number
|
|
1444
|
+
--verbose Enable debug logging to stderr
|
|
1445
|
+
--json Output as JSON
|
|
1446
|
+
--agent Output for agent consumption
|
|
1447
|
+
|
|
1198
1448
|
Reading pages:
|
|
1199
1449
|
$ qawolf runner list-recordings --runner ci --json
|
|
1200
1450
|
$ qawolf runner list-recordings --runner ci --recording-id <uuid> --json
|