Skip to main content
The qawolf CLI exposes six top-level commands. Each section below documents the command’s purpose, accepted arguments, and flags.

​
auth

Manages authentication with the QA Wolf platform. Credentials are read from the QAWOLF_API_KEY environment variable first, then from the system keychain, then from a config file fallback.

​
auth login

Prompts for an API key, validates it against the platform, and stores it locally. Requires an interactive terminal — in non-interactive contexts, set QAWOLF_API_KEY directly. 
qawolf auth login

​
auth logout

Removes stored credentials. Credentials set via the QAWOLF_API_KEY environment variable cannot be removed by this command. 
qawolf auth logout

​
auth whoami

Displays the authenticated team name, ID, optional slug, and the credential source. 
qawolf auth whoami

​
flows

Manages and runs QA Wolf flows.

​
flows run [pattern]

Runs flows matching [pattern], or every flow when omitted. The default pattern matches **/*.flow.{ts,js} in the current working directory and in .qawolf/<env>/ subdirectories. 
qawolf flows run
qawolf flows run "flows/checkout/**"
qawolf flows run checkout --env staging --headed
Options:
  • --retries <n> — number of retries for each failing flow. Default: 0.
  • --bail — stop after the first failure. Default: false.
  • --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.
  • --timeout <ms> — per-flow timeout in milliseconds. Default: 30000.
  • --junit [path] — write a JUnit XML report. With no value, writes to <output-dir>/junit-report.xml. Pass an explicit path to override.
  • --video <mode> — on, off, or retain-on-failure. Default: off.
  • --trace <mode> — Playwright trace mode. on, off, or retain-on-failure. Default: off.
  • --har <mode> — HAR capture mode. on, off, or retain-on-failure. Default: off.
  • --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.
Exit codes: 0 when all flows pass, 1 when one or more flows fail, 2 for invalid arguments or an unrecognized flow target. See Exit codes.

​
flows list [pattern]

Lists flows matching [pattern]. By default, lists local flows; with --remote, lists flows from the QA Wolf platform. 
qawolf flows list
qawolf flows list "flows/checkout/**"
qawolf flows list --remote
Options:
  • --remote — list flows from the QA Wolf platform instead of the local project. Default: false.

​
flows pull

Downloads an environment’s flows into the local .qawolf/<env>/ cache. 
qawolf flows pull --env staging
qawolf flows pull --env 4e9c... --out ./snapshot
qawolf flows pull --env staging --yes
Options:
  • --env <env> — required. The environment ID to pull from.
  • --out <path> — destination directory. Defaults to .qawolf/<env>/.
  • --yes — overwrite locally-modified files without prompting. Default: false.

​
install

Installs every runtime dependency the project’s flows need. With a [pattern] argument, only the dependencies for the matching flows are installed. 
qawolf install
qawolf install "flows/checkout/**"

​
install browsers [pattern]

Installs the Playwright browsers used by the project’s web flows. 
qawolf install browsers
qawolf install browsers "flows/web/**"

​
install android [pattern]

Installs Android system images, AVDs, and the Appium driver used by the project’s Android flows. Requires ANDROID_HOME or ANDROID_SDK_ROOT. 
qawolf install android
qawolf install android "flows/mobile/**"

​
init

Scaffolds a QA Wolf project in the current directory. Creates qawolf.config.ts, an example flow at src/flows/example.flow.ts, and .qawolf/.gitignore. When no package.json exists, creates one with "type": "module", the @qawolf/flows dependency, and a test:e2e script; when one already exists, only adds the test:e2e script (after a prompt). 
qawolf init
qawolf init --yes
Options:
  • --yes — overwrite existing files without prompting. Default: false.

​
doctor

Diagnoses problems running flows locally. Checks your environment (CLI and Node.js versions, API key, connectivity) and the dependencies your flows need, such as Playwright browsers and the Android SDK. 
qawolf doctor
qawolf doctor --all
Options:
  • --all — run every platform check, including platforms the project does not use. Default: false.

​
run

Triggers and manages runs on the QA Wolf platform. Unlike the local execution commands, run does not execute flows on your machine and requires authentication.

​
run create

Creates a run on the QA Wolf platform. 
qawolf run create --environment-id <id>
qawolf run create --environment-id <id> --flow-ids <id>... --environment-variables KEY=VALUE
Options:
  • --environment-id <value> — the ID of the environment to run.
  • --environment-variables <KEY=VALUE...> — environment variables to set for the run.
  • --flow-ids <values...> — limit the run to specific flow IDs.
  • --ignore-rules — ignore the environment’s run rules.
Last modified on June 12, 2026