Skip to content

docs(cli): correct CLI reference accuracy against shipped behavior#162

Merged
Michael Price (michael-pr) merged 2 commits into
local-execution-clifrom
local-execution-cli-accuracy
Jun 12, 2026
Merged

docs(cli): correct CLI reference accuracy against shipped behavior#162
Michael Price (michael-pr) merged 2 commits into
local-execution-clifrom
local-execution-cli-accuracy

Conversation

@michael-pr

@michael-pr Michael Price (michael-pr) commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

Summary

Accuracy pass over the new CLI docs on local-execution-cli (#140), verifying behavioral claims against the shipped CLI (qawolf/cli @ 3618e07). Kept at user-level detail — internals stay in the source.

  • Setup & install — corrected the Node requirement (22.12+, not 24) and binary platform list; clarified what auto-installs during runs (npm deps + Playwright browsers; Android tooling needs qawolf install android); fixed what init does when package.json already exists.
  • Running & pulling flows — dynamic-target and iOS flows are skipped with a warning, not errors; with --env, patterns expand only against the env cache dir; flows pull does sync team-storage file assets — the remaining caveats are mobile app binaries and runner-only directories.
  • Diagnostics — corrected the log file path per platform and summarized what doctor checks.
  • API reference — documented the missing run command and -V, --version; reframed qawolf.config.ts as written by init but not currently read by the CLI, so effective defaults are the flag defaults.

Test Plan

  • Every claim verified against qawolf/cli main @ 3618e07 (source + --help output)
  • npx mintlify broken-links passes

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).
@michael-pr Michael Price (michael-pr) marked this pull request as ready for review June 12, 2026 19:49
@michael-pr Michael Price (michael-pr) merged commit 6812cda into local-execution-cli Jun 12, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants