Add public docs for QA Wolf's local execution CLI#140
Open
Simon Ingeson (smonn) wants to merge 8 commits into
Open
Add public docs for QA Wolf's local execution CLI#140Simon Ingeson (smonn) wants to merge 8 commits into
Simon Ingeson (smonn) wants to merge 8 commits into
Conversation
Simon Ingeson (smonn)
changed the title
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Adds a Libraries > @qawolf/cli reference subsection (commands, configuration, environment variables, exit codes, troubleshooting) and an Integrations > Local execution group with task-oriented pages for authenticating, running flows, pulling, installing dependencies, scaffolding a local-only project, and diagnosing problems. Refs WIZ-10629.
Match the precision used in the CLI README review: pulls happen only when the local .qawolf/<env>/ cache is missing the flows, and a fresh pull is opt-in via qawolf flows pull --env <env>.
- 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
Simon Ingeson (smonn)
force-pushed
the
local-execution-cli
branch
from
7afa554 to
750bdd8
Compare
Simon Ingeson (smonn)
requested review from
John Gluck (JohnGluck),
Copilot and
Michael Price (michael-pr)
There was a problem hiding this comment.
Pull request overview
Adds a new public documentation section for QA Wolf’s local execution CLI, covering authentication, pulling and running flows locally, runtime dependency installation, project scaffolding, diagnostics, and a stable CLI API reference with troubleshooting.
Changes:
- Added a “Local execution” docs section with end-to-end guides for running/pulling flows, installing dependencies, and diagnosing issues.
- Added a CLI “API Reference” (commands, configuration, environment variables, exit codes) plus a troubleshooting page.
- Updated
docs.jsonnavigation to surface the new CLI and local execution documentation.
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| qawolf/local-execution/set-up-a-project.mdx | New guide for scaffolding a local-only flows project via qawolf init. |
| qawolf/local-execution/run-flows-locally.mdx | New guide for running cached/pulled environment flows locally, with common flags and behaviors. |
| qawolf/local-execution/pull-flows.mdx | New guide for pulling environment flows into a local cache without running them. |
| qawolf/local-execution/install-dependencies.mdx | New guide for explicitly installing Playwright/Android runtime dependencies. |
| qawolf/local-execution/diagnose-problems.mdx | New guide for qawolf doctor and log locations. |
| qawolf/local-execution/authenticate.mdx | New guide for installing the CLI and authenticating locally/CI. |
| qawolf/libraries/cli/troubleshooting.mdx | New CLI troubleshooting reference for common failure cases. |
| qawolf/libraries/cli/api-reference/index.mdx | New landing page for CLI API reference, globals, and exit codes. |
| qawolf/libraries/cli/api-reference/environment-variables.mdx | New reference for CLI environment variables and CI/agent detection. |
| qawolf/libraries/cli/api-reference/configuration.mdx | New reference for qawolf.config.ts fields and generated layout. |
| qawolf/libraries/cli/api-reference/commands.mdx | New command-by-command reference for auth, flows, install, init, and doctor. |
| docs.json | Adds navigation entries for the new CLI docs and local execution guides. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| <Steps> | ||
| <Step> | ||
| Find the environment's ID in your QA Wolf workspace under **Workspace settings → Environments**. |
|
|
||
| <Steps> | ||
| <Step> | ||
| Find the environment's ID in your QA Wolf workspace under **Workspace settings → Environments**. |
| - `--har-content <mode>` — `omit` or `full`. `full` includes response bodies and uses more memory. Default: `omit`. | ||
| - `--output-dir <path>` — directory for artifacts. Default: `qawolf-output`. | ||
| - `--headed` — show the browser window instead of running headless. Default: `false`. | ||
| - `--env <env>` — environment ID. When set, missing flows are pulled before the run. |
|
|
||
| ## Capture artifacts on failure | ||
|
|
||
| By default, no video or trace is recorded. To keep artifacts only when a flow fails, set the mode to `retain-on-failure`: |
| qawolf flows run --env staging --video retain-on-failure --trace retain-on-failure | ||
| ``` | ||
|
|
||
| Artifacts land in `qawolf-output/` (or the directory set by `--output-dir`). |
|
On my list to review in more details. Just wanted to note that we're aiming to make everything public by the end of next week (12th). So we will get these docs in after that. |
2 tasks
Generalize the doctor check lists, drop internal env-var and warning-string specifics, remove the QAWOLF_LOG_LEVEL section, and restore the QAWOLF_*_DIR local-run caveat in pull-flows (the CLI never sets runner-only dirs locally).
docs(cli): correct CLI reference accuracy against shipped behavior
Michael Price (michael-pr)
approved these changes
Jun 12, 2026
Michael Price (michael-pr)
left a comment
Michael Price (michael-pr)
left a comment
There was a problem hiding this comment.
John Gluck (@JohnGluck) This is ready for review and you can install the CLI now with the instructions listed at https://github.com/qawolf/cli.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add public docs for the new local execution CLI.