@qawolf/cli 2.2.2 → 2.4.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 +424 -57
- package/dist/runner-sdk.js +373 -22
- package/package.json +2 -2
- package/skills/qawolf-cli/SKILL.md +14 -0
- package/skills/qawolf-cli/references/run-results.md +15 -0
- package/skills/qawolf-cli/references/runner.md +292 -44
|
@@ -62,6 +62,12 @@ rather than leaving it to time out.
|
|
|
62
62
|
commands that follow need no `--runner`. Override that default for one command
|
|
63
63
|
with `--runner <id>`, or for a whole session with `QAWOLF_RUNNER_ID`.
|
|
64
64
|
|
|
65
|
+
Runner commands work in the workspace `qawolf auth switch` saved, which is
|
|
66
|
+
shared by every session on the machine. When more than one session may be
|
|
67
|
+
working in different workspaces, pass `--workspace-id <id>` to every runner
|
|
68
|
+
command instead of switching; it applies to that command only and is never
|
|
69
|
+
saved.
|
|
70
|
+
|
|
65
71
|
## Output
|
|
66
72
|
|
|
67
73
|
When consuming output programmatically, always pass `--json` (or `--agent`).
|
|
@@ -136,6 +142,11 @@ that `url`; never guess a route and never send a repository link in its place.
|
|
|
136
142
|
| `qawolf auth logout` | local | Remove stored credentials |
|
|
137
143
|
| `qawolf auth switch` | local | Choose which workspace to work in |
|
|
138
144
|
| `qawolf auth whoami` | read | Show authentication status |
|
|
145
|
+
| `qawolf build create` | write | Create a build from a file uploaded with build.requestUpload. Reads the app ID, name, version and build number from the file before it answers, or refuses a file that isn't an app. Calling it again with the same buildId answers the build the first call created, unchanged: a repeated call's branch, commitSha and environment are ignored. |
|
|
146
|
+
| `qawolf build delete` | write | Delete a build. Runs never install a deleted build. Deleting an environment's latest build makes the previous one its latest. Runs install that build only if its file is still kept: only the latest builds of static environments are kept past the bucket's expiry, 180 days after upload on QA Wolf's cloud. Answers the build with deletedAt set. Deleting a deleted build answers it unchanged. |
|
|
147
|
+
| `qawolf build get` | read | Get a build: its app, platform, version and environment. Deleted builds are returned too. |
|
|
148
|
+
| `qawolf build list` | read | List the workspace's undeleted builds, newest first. With latestOnly, list what the environment's next run installs. |
|
|
149
|
+
| `qawolf build requestUpload` | write | Get a URL to upload an app build: an .apk, .aab or .ipa, up to 500 MB. PUT the file there with uploadHeaders, then call build.create with the buildId. |
|
|
139
150
|
| `qawolf codeHostIntegration find` | read | List the workspace's code host integrations (GitHub or GitLab). A connected integration lets QA Wolf read repositories and receive the code host's webhooks. codeHostIntegration.listRepositories pages the repositories each integration covers. |
|
|
140
151
|
| `qawolf codeHostIntegration listRepositories` | read | List the repositories the workspace's code host integrations cover, alphabetical by full name. The list reflects the last sync from the code host; codeHostIntegration.find lists the integrations themselves. |
|
|
141
152
|
| `qawolf deployment find` | read | List the deployments QA Wolf has received for the workspace, newest first. A deployment arrives through a code host integration's webhook or through deployment.reportStatus, and is what a deployment trigger evaluates against. deployment.listTriggerEvaluations reports each trigger's verdict for one deployment. |
|
|
@@ -173,8 +184,10 @@ that `url`; never guess a route and never send a repository link in its place.
|
|
|
173
184
|
| `qawolf install browsers` | local | Install Playwright browsers used by the project's web flows |
|
|
174
185
|
| `qawolf install clear` | local | Remove the managed runtime cache (all installed runtime versions) |
|
|
175
186
|
| `qawolf investigation get` | read | Read what the QA Wolf AI investigating a run has concluded: one finding per cause of its failures, with the question waiting for a person and any answer or dispute the investigation hasn't acted on yet. A run that automatic investigation does not cover answers status "not-enabled". |
|
|
187
|
+
| `qawolf investigation question find` | read | List the questions the QA Wolf AI investigating failed runs is waiting for a person to answer, across a workspace's runs. Each question names its run, flows, details and offered answers. To answer one, send the person's answer to its sessionId with agent.send. |
|
|
176
188
|
| `qawolf issue addFlows` | write | Add flows to a coverage request owned by the caller's team. Flows already covered stay covered. Bug reports and blockers link to flows through the runs that reproduce them; use run.diagnose to record one. |
|
|
177
189
|
| `qawolf issue create` | write | Create a bug report, blocker (issue type `maintenance`), or coverage request issue for the caller's team. A user can create a blocker only when they can see the workspace's blockers; a team or organization API key credits it to the workspace's automation user. Link its failed flows afterwards with run.diagnose. |
|
|
190
|
+
| `qawolf issue decideSuggestion` | write | Decide a coverage request or bug report that QA Wolf suggested after exploring an environment. Add turns on the suggested flow in the environment. Report files a potential bug. Skip declines the suggestion. Undo takes back a decision before the flow joins. The issue's status follows the decision, so change the status only through this tool while the suggestion is undecided. |
|
|
178
191
|
| `qawolf issue find` | read | List the team's bug reports, blockers, or coverage requests, newest first. |
|
|
179
192
|
| `qawolf issue get` | read | Get an issue by id. |
|
|
180
193
|
| `qawolf issue listActivity` | read | List an issue's activity, oldest first: creation, status and priority changes, and the flows that started or stopped reproducing it. Use it to measure time to fix or to find issues that came back. |
|
|
@@ -183,6 +196,7 @@ that `url`; never guess a route and never send a repository link in its place.
|
|
|
183
196
|
| `qawolf legacyTrigger find` | read | List a workspace's legacy per-environment triggers; trigger.find lists the current ones. For migration only; it goes when legacy triggers go. adaptiveFlowSelection becomes a generativeSuite action, which takes no tags. |
|
|
184
197
|
| `qawolf legacyTrigger pause` | write | Pause one legacy trigger, the older per-environment kind, so it stops firing; use trigger.pause for a current one. Its copies in pull request environments pause too. For migration only; it goes when legacy triggers go. |
|
|
185
198
|
| `qawolf legacyTrigger resume` | write | Resume one legacy trigger, the older per-environment kind; use trigger.resume for a current one. Its copies in pull request environments resume too, and a scheduled one jumps to the next upcoming slot even if it was not paused. For migration only; it goes when legacy triggers go. |
|
|
199
|
+
| `qawolf mcpServer connect` | write | Start connecting an MCP server from the workspace's catalog, such as Linear, so Tester can use its tools. Returns a sign-in link to show the user. |
|
|
186
200
|
| `qawolf promotion find` | read | List environment promotions, newest first. A promotion moves the flow changes made in a head environment into its base environment. Filter by status conflicted to find the promotions whose conflicts still need a resolution. |
|
|
187
201
|
| `qawolf promotion get` | read | Read one environment promotion: its status, the conflicting paths and commit hashes while it is conflicted or resolving, the commit it landed when promoted, and the AI task resolving it. Poll it after environment.promote to learn how the promotion settled. It does not serve file contents; a resolver reads both branches from the flow code repository. |
|
|
188
202
|
| `qawolf promotion resolve` | write | Submit the resolution of a conflicted promotion: the full resolved contents of every conflicting path to keep, and every conflicting path to delete. Together they must cover exactly the paths in the promotion's conflict, and both commit hashes must match the conflict's; if a branch moved since, the call is refused as stale-conflict and promotion.get has the current conflict. Returns the promotion in resolving; poll promotion.get until it is promoted, or conflicted again if the branches moved while it applied. |
|
|
@@ -192,6 +192,21 @@ Every documented field of the `run.get` response. `[]` marks an array, so
|
|
|
192
192
|
- `supersededBy.runId` — The id of the run.
|
|
193
193
|
- `supersededBy.url` — Absolute URL of the replacement run's page.
|
|
194
194
|
- `blockingBugCount` — How many bugs this run found are blocking: still open, and priority urgent, high, or unprioritized — unprioritized counts because nobody has ruled it out yet. This is what `failed` is derived from, so it explains a failure rather than adding a second verdict: gate on `status`, then read this to say how many bugs are holding the build. It counts a bug filed against a later run by an investigation that carried over from this one, and it drops a bug once that bug is resolved.
|
|
195
|
+
- `builds` — The builds the run installs, one per app and platform. Empty when the run has none.
|
|
196
|
+
- `builds[].appId` — The package name (Android) or bundle ID (iOS) read from the file. A flow launches it with `launch({ app: { id } })`.
|
|
197
|
+
- `builds[].appName` — The app's display name, when the file names one.
|
|
198
|
+
- `builds[].branch` — The branch the uploader said the build came from.
|
|
199
|
+
- `builds[].buildNumber` — versionCode (Android) or CFBundleVersion (iOS), when the file has one.
|
|
200
|
+
- `builds[].commitSha` — The commit the uploader said the build came from.
|
|
201
|
+
- `builds[].createdAt` — When the build was created.
|
|
202
|
+
- `builds[].deletedAt` — When the build was deleted. Runs never install it after.
|
|
203
|
+
- `builds[].environmentId` — The environment whose runs install the build while it is the newest one there for its app and platform. Absent: only a run created with the build installs it.
|
|
204
|
+
- `builds[].fileName` — The uploaded file's name.
|
|
205
|
+
- `builds[].id` — The id of the build, from build.requestUpload.
|
|
206
|
+
- `builds[].platform` — One of: android, ios
|
|
207
|
+
- `builds[].sizeBytes` — The file's size in bytes.
|
|
208
|
+
- `builds[].version` — versionName (Android) or CFBundleShortVersionString (iOS), when the file has one.
|
|
209
|
+
- `builds[].url` — Absolute URL of the team's Builds page.
|
|
195
210
|
- `flows` — The run's flows, ordered alphabetically by name. Only the flows matching flowStatuses when the request set it.
|
|
196
211
|
- `flows[].attempts` — The flow's finished execution attempts, oldest first, including manual Wolf Browser attempts. Present once at least one attempt has finished, so a flow that passed after retries also lists its failed attempts. Artifact URLs appear only on attempts that reached a verdict, and on a manual attempt only when its Wolf Browser run kept them. They stay valid for at least a day (call run.get again for fresh ones), and can return 404 when the attempt did not produce that artifact.
|
|
197
212
|
- `flows[].attempts[].logsUrl` — Signed URL for the attempt's execution logs.
|
|
@@ -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
|
|
@@ -126,9 +137,17 @@ Usage: qawolf runner launch [options]
|
|
|
126
137
|
Launch an interactive runner and make it this directory's default
|
|
127
138
|
|
|
128
139
|
Options:
|
|
129
|
-
--id <id>
|
|
130
|
-
--name <family>
|
|
131
|
-
-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
|
|
132
151
|
|
|
133
152
|
Examples:
|
|
134
153
|
$ qawolf runner launch
|
|
@@ -183,8 +202,16 @@ Usage: qawolf runner list [options]
|
|
|
183
202
|
List the runners running on your team
|
|
184
203
|
|
|
185
204
|
Options:
|
|
186
|
-
--here
|
|
187
|
-
-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
|
|
188
215
|
|
|
189
216
|
Examples:
|
|
190
217
|
$ qawolf runner list
|
|
@@ -222,8 +249,17 @@ Usage: qawolf runner terminate [options]
|
|
|
222
249
|
End an interactive runner, and the pod it runs on with it
|
|
223
250
|
|
|
224
251
|
Options:
|
|
225
|
-
--runner <id>
|
|
226
|
-
|
|
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
|
|
227
263
|
|
|
228
264
|
Stopping a run or ending a runner:
|
|
229
265
|
Two different things, and the names are the only warning you get:
|
|
@@ -248,8 +284,17 @@ Usage: qawolf runner stop-run [options]
|
|
|
248
284
|
Stop what a runner is currently executing, leaving the runner up
|
|
249
285
|
|
|
250
286
|
Options:
|
|
251
|
-
--runner <id>
|
|
252
|
-
|
|
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
|
|
253
298
|
|
|
254
299
|
Stopping a run or ending a runner:
|
|
255
300
|
Two different things, and the names are the only warning you get:
|
|
@@ -274,8 +319,17 @@ Usage: qawolf runner keepalive [options]
|
|
|
274
319
|
Reset a runner's inactivity clock, for a caller that pauses between actions
|
|
275
320
|
|
|
276
321
|
Options:
|
|
277
|
-
--runner <id>
|
|
278
|
-
|
|
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
|
|
279
333
|
|
|
280
334
|
Examples:
|
|
281
335
|
$ qawolf runner keepalive
|
|
@@ -329,6 +383,14 @@ Options:
|
|
|
329
383
|
"3600")
|
|
330
384
|
-h, --help display help for command
|
|
331
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
|
+
|
|
332
394
|
Examples:
|
|
333
395
|
$ qawolf runner run flows/checkout.flow.ts
|
|
334
396
|
$ qawolf runner run flows/checkout.flow.ts --follow
|
|
@@ -471,6 +533,14 @@ Options:
|
|
|
471
533
|
"3600")
|
|
472
534
|
-h, --help display help for command
|
|
473
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
|
+
|
|
474
544
|
Examples:
|
|
475
545
|
$ qawolf runner events recorder --tail 5
|
|
476
546
|
$ qawolf runner events run-logs --run <runId> --follow
|
|
@@ -544,10 +614,20 @@ Usage: qawolf runner screenshot [options]
|
|
|
544
614
|
Save a JPEG of an interactive runner's screen to a file, or write it to stdout with --out -
|
|
545
615
|
|
|
546
616
|
Options:
|
|
547
|
-
--out <path>
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
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
|
|
551
631
|
|
|
552
632
|
Examples:
|
|
553
633
|
$ qawolf runner screenshot
|
|
@@ -604,6 +684,14 @@ Options:
|
|
|
604
684
|
--y <pixels> click, tap and the like: y, in screenshot pixels
|
|
605
685
|
-h, --help display help for command
|
|
606
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
|
+
|
|
607
695
|
Examples:
|
|
608
696
|
$ qawolf runner act click --button left --x 480 --y 260
|
|
609
697
|
$ qawolf runner act type --text "hello@example.com"
|
|
@@ -645,9 +733,9 @@ Seeing and acting:
|
|
|
645
733
|
instead. Bounds are checked before anything is sent, so an over-long --text or
|
|
646
734
|
an out-of-range coordinate comes back immediately naming the limit.
|
|
647
735
|
|
|
648
|
-
On a 4, the
|
|
649
|
-
|
|
650
|
-
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.
|
|
651
739
|
|
|
652
740
|
Mobile:
|
|
653
741
|
A mobile runner has a touchscreen, not a mouse, so it has actions of its own:
|
|
@@ -700,6 +788,14 @@ Options:
|
|
|
700
788
|
"none", "final", "each")
|
|
701
789
|
-h, --help display help for command
|
|
702
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
|
+
|
|
703
799
|
Examples:
|
|
704
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
|
|
705
801
|
$ echo '[{"type":"click","button":"left","x":1,"y":2},{"type":"type","text":"hi"}]' | qawolf runner actions -
|
|
@@ -766,10 +862,19 @@ Usage: qawolf runner exec [options] <file>
|
|
|
766
862
|
Evaluate a snippet against a runner's live page. Use - to read the snippet from stdin
|
|
767
863
|
|
|
768
864
|
Options:
|
|
769
|
-
--file <path>
|
|
770
|
-
|
|
771
|
-
--runner <id>
|
|
772
|
-
|
|
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
|
|
773
878
|
|
|
774
879
|
Examples:
|
|
775
880
|
$ qawolf runner exec snippet.ts
|
|
@@ -815,6 +920,14 @@ Read one thing off a runner's live page (browser) or Appium session (mobile)
|
|
|
815
920
|
Options:
|
|
816
921
|
-h, --help display help for command
|
|
817
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
|
+
|
|
818
931
|
Commands:
|
|
819
932
|
element-html [options] Print the HTML of the first element a selector matches
|
|
820
933
|
page-html [options] Print the page's HTML, simplified for a model to read
|
|
@@ -903,6 +1016,14 @@ Options:
|
|
|
903
1016
|
--runner <id> Runner to target. Defaults to QAWOLF_RUNNER_ID, then this directory's
|
|
904
1017
|
stored runner
|
|
905
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
|
|
906
1027
|
```
|
|
907
1028
|
|
|
908
1029
|
### qawolf runner inspect page-html
|
|
@@ -917,6 +1038,14 @@ Options:
|
|
|
917
1038
|
--runner <id> Runner to target. Defaults to QAWOLF_RUNNER_ID, then this directory's
|
|
918
1039
|
stored runner
|
|
919
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
|
|
920
1049
|
```
|
|
921
1050
|
|
|
922
1051
|
### qawolf runner inspect variable
|
|
@@ -927,9 +1056,18 @@ Usage: qawolf runner inspect variable [options]
|
|
|
927
1056
|
Print a top-level variable's value from the running workflow
|
|
928
1057
|
|
|
929
1058
|
Options:
|
|
930
|
-
--name <name>
|
|
931
|
-
--runner <id>
|
|
932
|
-
|
|
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
|
|
933
1071
|
```
|
|
934
1072
|
|
|
935
1073
|
### qawolf runner inspect session
|
|
@@ -940,8 +1078,17 @@ Usage: qawolf runner inspect session [options]
|
|
|
940
1078
|
Print the Appium session's status: ready, or why not
|
|
941
1079
|
|
|
942
1080
|
Options:
|
|
943
|
-
--runner <id>
|
|
944
|
-
|
|
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
|
|
945
1092
|
```
|
|
946
1093
|
|
|
947
1094
|
### qawolf runner inspect contexts
|
|
@@ -952,8 +1099,17 @@ Usage: qawolf runner inspect contexts [options]
|
|
|
952
1099
|
List the WebView contexts available, and which is current
|
|
953
1100
|
|
|
954
1101
|
Options:
|
|
955
|
-
--runner <id>
|
|
956
|
-
|
|
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
|
|
957
1113
|
```
|
|
958
1114
|
|
|
959
1115
|
### qawolf runner inspect page-source
|
|
@@ -964,10 +1120,18 @@ Usage: qawolf runner inspect page-source [options]
|
|
|
964
1120
|
Print the current context's page source, as a tree
|
|
965
1121
|
|
|
966
1122
|
Options:
|
|
967
|
-
--context <name>
|
|
968
|
-
--runner <id>
|
|
969
|
-
|
|
970
|
-
-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
|
|
971
1135
|
```
|
|
972
1136
|
|
|
973
1137
|
### qawolf runner inspect elements
|
|
@@ -988,6 +1152,14 @@ Options:
|
|
|
988
1152
|
--x <pixels> point: whole pixels on the device's own screen
|
|
989
1153
|
--y <pixels> point: whole pixels on the device's own screen
|
|
990
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
|
|
991
1163
|
```
|
|
992
1164
|
|
|
993
1165
|
## qawolf runner import-package
|
|
@@ -1003,6 +1175,14 @@ Options:
|
|
|
1003
1175
|
stored runner
|
|
1004
1176
|
-h, --help display help for command
|
|
1005
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
|
+
|
|
1006
1186
|
Examples:
|
|
1007
1187
|
$ qawolf runner import-package dayjs
|
|
1008
1188
|
$ qawolf runner import-package dayjs --package-version 1.11.13
|
|
@@ -1026,8 +1206,17 @@ Highlight what a selector matches on a runner's live page, so the next screensho
|
|
|
1026
1206
|
selector to clear the highlight
|
|
1027
1207
|
|
|
1028
1208
|
Options:
|
|
1029
|
-
--runner <id>
|
|
1030
|
-
|
|
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
|
|
1031
1220
|
|
|
1032
1221
|
Examples:
|
|
1033
1222
|
$ qawolf runner highlight-selector "text=Sign in"
|
|
@@ -1067,6 +1256,14 @@ Options:
|
|
|
1067
1256
|
runner
|
|
1068
1257
|
-h, --help display help for command
|
|
1069
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
|
+
|
|
1070
1267
|
Examples:
|
|
1071
1268
|
$ qawolf runner promote-snapshot --screenshot checkout-1-actual.png --baseline checkout-1.png
|
|
1072
1269
|
$ qawolf runner events run-events --tail 20 | jq 'select(.type == "imageDiffArtifact")'
|
|
@@ -1095,6 +1292,14 @@ Control video recording on a browser, mobile, Windows, or Mac runner
|
|
|
1095
1292
|
Options:
|
|
1096
1293
|
-h, --help display help for command
|
|
1097
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
|
+
|
|
1098
1303
|
Commands:
|
|
1099
1304
|
start [options] Start manual video capture across runs. Requires a ready screen and
|
|
1100
1305
|
suppresses automatic capture until stopped
|
|
@@ -1140,6 +1345,14 @@ Options:
|
|
|
1140
1345
|
--runner <id> Runner to target. Defaults to QAWOLF_RUNNER_ID, then this directory's
|
|
1141
1346
|
stored runner
|
|
1142
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
|
|
1143
1356
|
```
|
|
1144
1357
|
|
|
1145
1358
|
### qawolf runner record stop
|
|
@@ -1150,8 +1363,17 @@ Usage: qawolf runner record stop [options] <recording-id>
|
|
|
1150
1363
|
Stop the recording with this UUID and publish it. Retrying cannot stop a later recording
|
|
1151
1364
|
|
|
1152
1365
|
Options:
|
|
1153
|
-
--runner <id>
|
|
1154
|
-
|
|
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
|
|
1155
1377
|
```
|
|
1156
1378
|
|
|
1157
1379
|
### qawolf runner record status
|
|
@@ -1162,8 +1384,17 @@ Usage: qawolf runner record status [options]
|
|
|
1162
1384
|
Show the active recording and automatic recording setting
|
|
1163
1385
|
|
|
1164
1386
|
Options:
|
|
1165
|
-
--runner <id>
|
|
1166
|
-
|
|
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
|
|
1167
1398
|
```
|
|
1168
1399
|
|
|
1169
1400
|
### qawolf runner record auto
|
|
@@ -1174,11 +1405,20 @@ Usage: qawolf runner record auto [options] <setting>
|
|
|
1174
1405
|
Enable or disable automatic recording for subsequent full runs
|
|
1175
1406
|
|
|
1176
1407
|
Arguments:
|
|
1177
|
-
setting
|
|
1408
|
+
setting Automatic recording setting (choices: "on", "off")
|
|
1178
1409
|
|
|
1179
1410
|
Options:
|
|
1180
|
-
--runner <id>
|
|
1181
|
-
|
|
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
|
|
1182
1422
|
```
|
|
1183
1423
|
|
|
1184
1424
|
## qawolf runner list-recordings
|
|
@@ -1197,6 +1437,14 @@ Options:
|
|
|
1197
1437
|
--page-token <token> Continue from nextPageToken returned by the previous page
|
|
1198
1438
|
-h, --help display help for command
|
|
1199
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
|
+
|
|
1200
1448
|
Reading pages:
|
|
1201
1449
|
$ qawolf runner list-recordings --runner ci --json
|
|
1202
1450
|
$ qawolf runner list-recordings --runner ci --recording-id <uuid> --json
|