@qawolf/cli 2.5.0 → 2.7.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 +408 -42
- package/dist/runner-sdk.js +406 -40
- package/package.json +2 -2
- package/skills/qawolf-cli/SKILL.md +9 -3
- package/skills/qawolf-cli/references/run-results.md +22 -0
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@qawolf/cli",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.7.0",
|
|
4
4
|
"description": "Run and manage QA Wolf flows from the terminal, CI, or an AI agent",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"automation",
|
|
@@ -72,7 +72,7 @@
|
|
|
72
72
|
"@clack/prompts": "1.5.1",
|
|
73
73
|
"@napi-rs/keyring": "1.3.0",
|
|
74
74
|
"@oxc-node/core": "0.1.0",
|
|
75
|
-
"@qawolf/api-contracts": "0.
|
|
75
|
+
"@qawolf/api-contracts": "0.114.0",
|
|
76
76
|
"@qawolf/emails": "1.1.1",
|
|
77
77
|
"@qawolf/flow-targets": "2.0.0",
|
|
78
78
|
"@qawolf/flows": "0.3.0",
|
|
@@ -135,6 +135,7 @@ that `url`; never guess a route and never send a repository link in its place.
|
|
|
135
135
|
<!-- prettier-ignore -->
|
|
136
136
|
| Command | Kind | What it does |
|
|
137
137
|
| --- | --- | --- |
|
|
138
|
+
| `qawolf activity wait` | read | Wait on many QA Wolf AI (Tester) sessions and runs in one call. Pass every Tester session and run you are waiting on. The call returns as soon as any session replies or changes status or any run finishes, and reports every item with news. Send back open as the next call's input, and call again as soon as it returns. Pass waitSeconds above 45 only when your instructions say your client keeps the call open while progress arrives. |
|
|
138
139
|
| `qawolf agent get` | read | Read what the QA Wolf AI has said and whether it is still working |
|
|
139
140
|
| `qawolf agent send` | write | Ask the QA Wolf AI to do a piece of work, such as covering a journey or fixing a broken flow |
|
|
140
141
|
| `qawolf attempt get` | read | Get a finished run attempt: its run and flow status, its place among that flow's attempts in the run, and signed links to its logs, trace, and video when they were captured. |
|
|
@@ -148,6 +149,7 @@ that `url`; never guess a route and never send a repository link in its place.
|
|
|
148
149
|
| `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. |
|
|
149
150
|
| `qawolf build get` | read | Get a build: its app, platform, version and environment. Deleted builds are returned too. |
|
|
150
151
|
| `qawolf build list` | read | List the workspace's undeleted builds, newest first. With latestOnly, list what the environment's next run installs. |
|
|
152
|
+
| `qawolf build requestDownload` | read | Get a URL to download a build's file. Deleted builds can be downloaded while their file exists. Answers 404 when the file has expired. |
|
|
151
153
|
| `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. |
|
|
152
154
|
| `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. |
|
|
153
155
|
| `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. |
|
|
@@ -165,7 +167,7 @@ that `url`; never guess a route and never send a repository link in its place.
|
|
|
165
167
|
| `qawolf environment deleteVariable` | write | Remove one environment variable by name. Succeeds whether or not the variable existed. |
|
|
166
168
|
| `qawolf environment find` | read | List the team's environments, newest first. |
|
|
167
169
|
| `qawolf environment get` | read | Read a single environment's name, kind, release readiness status, flow-code branch and reconciliation state, run concurrency limit, and termination state. If flowCodeBranch exists, use its syncStatus for Git reconciliation and read lastSyncedCommitHash only when syncStatus is reconciled. |
|
|
168
|
-
| `qawolf environment getVariable` | read | Read the values of named environment variables in one call. Values are secrets. Names that do not exist go to missingNames and
|
|
170
|
+
| `qawolf environment getVariable` | read | Read the values of named environment variables in one call. Values are secrets. Names that do not exist go to missingNames and write-only secrets go to secretNames; neither fails the call. |
|
|
169
171
|
| `qawolf environment listVariableNames` | read | Use this to answer which QA Wolf environment variables are available to test code. Returns names only; values never leave the server. |
|
|
170
172
|
| `qawolf environment promote` | write | Declare a preview environment's work accepted, typically when its pull request merges: its flow changes are promoted into its base environment and the environment is terminated once they land. Returns the promotion in pending; poll promotion.get to learn how it settled. Calling again while a promotion is open returns that promotion. A conflict settles the promotion conflicted and cancels the environment's in-progress runs; promotion.get names the conflicting paths. Use environment.terminate instead when the work is abandoned. |
|
|
171
173
|
| `qawolf environment setVariable` | write | Create or replace an environment variable. If the user asks to create one for "my email" without naming it, use DEFAULT_EMAIL. The value is never returned. |
|
|
@@ -186,13 +188,17 @@ that `url`; never guess a route and never send a repository link in its place.
|
|
|
186
188
|
| `qawolf install browsers` | local | Install Playwright browsers used by the project's web flows |
|
|
187
189
|
| `qawolf install clear` | local | Remove the managed runtime cache (all installed runtime versions) |
|
|
188
190
|
| `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". |
|
|
189
|
-
| `qawolf investigation question
|
|
191
|
+
| `qawolf investigation question answer` | write | Answer the questions the QA Wolf AI investigating a failed run is waiting on, as the signed-in person. List the questions with investigation.question.find, and answer only with the person's approval. The first answer to a question wins, and the investigation acts on it. Only a person's own sign-in or user API key can answer; a team or organization key cannot. |
|
|
192
|
+
| `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 them, call investigation.question.answer with the run and the person's answers. |
|
|
190
193
|
| `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. |
|
|
194
|
+
| `qawolf issue attachFiles` | write | Attach files from the team's storage to a bug report owned by the caller's team, for example the files a bug was reproduced with. Files already attached stay attached. Upload a file with file.requestUpload first. |
|
|
195
|
+
| `qawolf issue comment` | write | Comment on a bug report, blocker (issue type `maintenance`), or coverage request owned by the caller's team. The comment changes nothing else on the issue, such as its status or priority. |
|
|
191
196
|
| `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. |
|
|
192
197
|
| `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. |
|
|
193
198
|
| `qawolf issue find` | read | List the team's bug reports, blockers, or coverage requests, newest first. |
|
|
194
199
|
| `qawolf issue get` | read | Get an issue by id. |
|
|
195
200
|
| `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. |
|
|
201
|
+
| `qawolf issue listComments` | read | List the comments on a bug report, blocker (issue type `maintenance`), or coverage request, oldest first, with who wrote each one. |
|
|
196
202
|
| `qawolf issue removeFlows` | write | Remove flows from a coverage request or remove bug report or blocker reproductions in an environment. Unlinked flows are left alone. Reports auto-close when no active reproductions remain and auto-close is enabled. For reports, omit environmentId only when each selected flow is linked in at most one environment. |
|
|
197
203
|
| `qawolf issue update` | write | Update an issue owned by the caller's team. Omitted fields remain unchanged. |
|
|
198
204
|
| `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. |
|
|
@@ -206,7 +212,7 @@ that `url`; never guess a route and never send a repository link in its place.
|
|
|
206
212
|
| `qawolf run create` | write | Create a run for the selected flows and/or tags in an environment. |
|
|
207
213
|
| `qawolf run diagnose` | write | Link failed flows in a run to an existing bug report or blocker owned by the caller's team, recording them as its reproductions. It does not explain why a run failed; read investigation.get or attempt.get for that. The issue's type selects the diagnosis. Each flow must have failed in the run. A flow that is already diagnosed in the run moves to this issue, and may stay linked to other open reports. The diagnosis appears on the run, and the reproduction appears under the issue's reproductions. Coverage requests cannot be diagnosed; use issue.addFlows to cover flows instead. |
|
|
208
214
|
| `qawolf run find` | read | List an environment's recent runs, newest first, including failed-attempt discovery metadata. |
|
|
209
|
-
| `qawolf run get` | read | Get a run's status, per-flow results, links, and how many of its bugs are blocking. |
|
|
215
|
+
| `qawolf run get` | read | Get a run's status, per-flow results, links, and how many of its bugs are blocking. Call it without waitSeconds for an immediate answer. To wait on a run that is still queued or running, pass waitSeconds up to 45: the server holds the check open and answers the moment the status changes. A held check also waits while the run is still being created. After a held check returns, call again only while status is queued or running. Stop when status is passed, failed, canceled, or superseded. |
|
|
210
216
|
| `qawolf run listScreenshotComparisons` | read | List the screenshot comparisons that failed a run's flows, with the expected, actual and diff images of each. Only comparisons that caused a failure are listed: a screenshot that differs within tolerance, or that differs on a line that did not fail, is left out. Each comparison tells whether its baseline changed since the run and whether the baseline still passes in other environments. The image URLs expire after a few minutes; fetch the preview URLs to look at the images. The first call for an image makes its missing JPEG preview and keeps it in team storage, so later calls reuse it. |
|
|
211
217
|
| `qawolf run optOutOfInvestigation` | write | Mark failed flows in a run as "do not investigate" (DNI): the failures need no bug report or blocker. Each flow must have failed in the run and still be under investigation. A flow that already has a diagnosis cannot be opted out. A team or organization key records the opt-out as the workspace's automation user. To link a failure to a report instead, use run.diagnose. |
|
|
212
218
|
| `qawolf run reattempt` | write | Request new attempts for a run's flows. A flow is eligible once its result is failed or canceled and QA Wolf's automatic retries have finished. A flow that kept failing in later runs is attempted in the latest of them, because that is the run carrying the failure, so read reattemptedInRunIds for where each attempt landed. A fully investigated run no longer accepts reattempts. Attempts run with the flow code the environment has synced when the request arrives: after publishing a fix, pass afterCommit so the request waits for that commit instead of rerunning older code. Poll run.get for results, or pass aiTaskId or chatSessionId to be notified when they settle. |
|
|
@@ -207,6 +207,17 @@ Every documented field of the `run.get` response. `[]` marks an array, so
|
|
|
207
207
|
- `builds[].sizeBytes` — The file's size in bytes.
|
|
208
208
|
- `builds[].version` — versionName (Android) or CFBundleShortVersionString (iOS), when the file has one.
|
|
209
209
|
- `builds[].url` — Absolute URL of the team's Builds page.
|
|
210
|
+
- `buildVersions` — The apps the run's attempts installed, one per app and platform, with warnings. Empty when no attempt reported an install and the run has no builds.
|
|
211
|
+
- `buildVersions[].appId` — The package name (Android) or bundle ID (iOS) of the app.
|
|
212
|
+
- `buildVersions[].expected` — The run's build of this app. Absent for an app it got none of.
|
|
213
|
+
- `buildVersions[].expected.buildId` — The id of the build, from build.requestUpload.
|
|
214
|
+
- `buildVersions[].kind` — One of build, info; newer servers may add values, so ignore any you don't know. build: the run got a build of this app. info: any other app an attempt installed, such as a companion app. It has no warnings.
|
|
215
|
+
- `buildVersions[].observed` — What attempts installed, one entry per build or version.
|
|
216
|
+
- `buildVersions[].observed[].attempts` — How many attempts reported it.
|
|
217
|
+
- `buildVersions[].observed[].buildId` — Absent when the file is not one of the team's builds.
|
|
218
|
+
- `buildVersions[].platform` — One of: android, ios
|
|
219
|
+
- `buildVersions[].unreportedAttempts` — Finished attempts that reported no installed app, such as web attempts or attempts on an older Flows SDK.
|
|
220
|
+
- `buildVersions[].warnings` — Why the installed apps may not be what the run should test.
|
|
210
221
|
- `flows` — The run's flows, ordered alphabetically by name. Only the flows matching flowStatuses when the request set it.
|
|
211
222
|
- `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.
|
|
212
223
|
- `flows[].attempts[].logsUrl` — Signed URL for the attempt's execution logs.
|
|
@@ -225,6 +236,17 @@ Every documented field of the `run.get` response. `[]` marks an array, so
|
|
|
225
236
|
- `flows[].failure.optedOutOfInvestigation.by` — One of: user, system
|
|
226
237
|
- `flows[].flowId` — The id of the flow.
|
|
227
238
|
- `flows[].status` — One of: failed, queued, running, passed, canceled
|
|
239
|
+
- `siteVersions` — The versions the run's attempts saw on each site origin, with warnings. Empty when no attempt reported one.
|
|
240
|
+
- `siteVersions[].expected` — The commit the run should see. Only on the origin the deployment reported as its target. Absent when no deployment names a commit and a target, or the deployment has a service.
|
|
241
|
+
- `siteVersions[].expected.from` — One of deployment, latestDeployment; newer servers may add values, so ignore any you don't know. deployment: the run's own deployment. latestDeployment: the environment's latest successful deployment before the run.
|
|
242
|
+
- `siteVersions[].expected.version` — The deployed commit.
|
|
243
|
+
- `siteVersions[].observed` — What attempts saw, one entry per version and source.
|
|
244
|
+
- `siteVersions[].observed[].attempts` — How many attempts reported it.
|
|
245
|
+
- `siteVersions[].observed[].source` — One of header, meta, versionPath, frameworkBuildId, fingerprint; newer servers may add values, so ignore any you don't know. Where the attempt read the version.
|
|
246
|
+
- `siteVersions[].origin` — The site origin the attempts visited.
|
|
247
|
+
- `siteVersions[].warnings` — Why the site may not be the version the run should test.
|
|
248
|
+
- `waitSeconds` — The hold this check was allowed, in seconds, after clamping. Absent when the check did not wait.
|
|
249
|
+
- `wokeOn` — One of: status, timeout
|
|
228
250
|
- `url` — Absolute URL of the run page.
|
|
229
251
|
|
|
230
252
|
<!-- fields:end -->
|