Skip to content

Commit 7afa554

Browse files
committed
docs: catch up with recent CLI changes (--workers, --junit, binaries)
- Parallel workers are now supported for web flows; Android still requires --workers 1 - Document the new --junit [path] flag and how it composites with console/JSON/agent output - Add a precompiled binary install path alongside npm - Rewrite the stale "workers capped at 1" troubleshooting entry to cover the Android constraint
1 parent 308c269 commit 7afa554

4 files changed

Lines changed: 38 additions & 8 deletions

File tree

qawolf/libraries/cli/api-reference/commands.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,9 @@ Options:
5252

5353
- `--retries <n>` — number of retries for each failing flow. Default: `0`.
5454
- `--bail` — stop after the first failure. Default: `false`.
55-
- `--workers <n>` — parallel worker count. Default: `1`. Currently capped at `1`.
55+
- `--workers <n>` — parallel worker count for web flows. Default: `1`. Android flows must run with `--workers 1`; the CLI errors out if Android flows are selected with a higher value.
5656
- `--timeout <ms>` — per-flow timeout in milliseconds. Default: `30000`.
57+
- `--junit [path]` — write a JUnit XML report. With no value, writes to `<output-dir>/junit-report.xml`. Pass an explicit path to override.
5758
- `--video <mode>``on`, `off`, or `retain-on-failure`. Default: `off`.
5859
- `--trace <mode>` — Playwright trace mode. `on`, `off`, or `retain-on-failure`. Default: `off`.
5960
- `--har <mode>` — HAR capture mode. `on`, `off`, or `retain-on-failure`. Default: `off`.

qawolf/libraries/cli/troubleshooting.mdx

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -80,13 +80,14 @@ Check:
8080
- `@qawolf/testkit` is listed in `package.json` and installed
8181
- the command is being run from the project root, or from a directory inside a pulled environment
8282

83-
## Parallel Worker Count Capped At 1
83+
## Android Flows Are Not Supported With `--workers > 1`
8484

85-
Cause: `--workers <n>` was set to a value greater than `1`. Parallel workers are not yet supported.
85+
Cause: `--workers <n>` was set to a value greater than `1` and at least one Android flow was selected for the run.
8686

8787
Check:
8888

89-
- omit `--workers` or set it to `1`
89+
- rerun the Android flows with `--workers 1`
90+
- split the run into a web-only invocation with `--workers <n>` and an Android-only invocation with `--workers 1`
9091

9192
## Basic Target Flow Cannot Be Executed
9293

qawolf/local-execution/authenticate.mdx

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,23 @@ Before the CLI can pull flows from your workspace or run flows that depend on en
99

1010
## Install the CLI
1111

12+
The CLI ships in two forms: an npm package and a precompiled standalone binary.
13+
14+
### Install with npm
15+
1216
<Check>
1317
Node.js 24 or later is required.
1418
</Check>
1519

16-
Install the CLI globally with npm:
17-
1820
```bash
1921
npm install -g @qawolf/cli
2022
```
2123

22-
Verify the install:
24+
### Install a precompiled binary
25+
26+
Download the binary for your platform from [GitHub Releases](https://github.com/qawolf/cli/releases). Builds are published for Linux x64, macOS (Apple Silicon and Intel), and Windows x64. The binary has no Node.js runtime dependency. Extract the archive, then move the binary into a directory on your `PATH`.
27+
28+
### Verify
2329

2430
```bash
2531
qawolf --version

qawolf/local-execution/run-flows-locally.mdx

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,28 @@ qawolf flows run --env staging --bail
9090

9191
`--bail` is useful when iterating on a single flow and you want to fail fast.
9292

93+
## Run web flows in parallel
94+
95+
```bash
96+
qawolf flows run --env staging --workers 4
97+
```
98+
99+
`--workers` controls how many web flows run concurrently. Android flows must run with `--workers 1` — the CLI errors out if Android flows are selected with a higher value.
100+
101+
## Write a JUnit XML report
102+
103+
```bash
104+
qawolf flows run --env staging --junit
105+
```
106+
107+
The CLI writes a JUnit XML report to `qawolf-output/junit-report.xml` (or under the directory set by `--output-dir`). Pass an explicit path to override the default:
108+
109+
```bash
110+
qawolf flows run --env staging --junit ./reports/results.xml
111+
```
112+
113+
The XML report is written alongside the console output and is independent of `--json` and `--agent`.
114+
93115
## Run flows you authored locally
94116

95117
If you've scaffolded a [local-only project](/qawolf/local-execution/set-up-a-project) with `qawolf init`, run without `--env`:
@@ -106,7 +128,7 @@ The CLI discovers flows matching `**/*.flow.{ts,js}` in the current directory an
106128

107129
## Current limitations
108130

109-
- `--workers` is capped at `1`. Parallel execution is on the roadmap.
131+
- Android flows must run with `--workers 1`. Parallel execution is supported for web flows only.
110132
- iOS flows are not executed. The CLI prints a clear error if an iOS flow is selected for a run.
111133
- Flows that target the legacy `"Basic"` platform pull successfully but cannot be executed by the CLI.
112134
- Dynamic-target flows — flows where `target` is a computed value rather than a string literal — are included in every run because the CLI cannot determine the platform ahead of time.

0 commit comments

Comments
 (0)