QA Wolf CLI

Run QA Wolf flows from your terminal or in CI.

The CLI runs and manages flows locally. Flow creation, AI-powered test generation, managed cloud execution, and team collaboration are part of the full QA Wolf platform. See docs.qawolf.com for the full docs, or qawolf.com to get started.

Install

npm install -g @qawolf/cli
# or: pnpm add -g @qawolf/cli
# or: yarn global add @qawolf/cli
# or: bun add -g @qawolf/cli

Try it without installing:

npx @qawolf/cli --help

Supported Node versions: Node 20.19+. Node 20 reached end-of-life on 2026-04-30 and no longer receives security updates; it remains supported here only for environments still pinned to Node 20. Prefer Node 22+ where possible.

Standalone binaries

Precompiled binaries are attached to each GitHub Release — no Node.js required: qawolf-linux-x64, qawolf-linux-arm64, qawolf-darwin-x64, qawolf-darwin-arm64, and qawolf-windows-x64.exe.

curl -fsSL -o qawolf https://github.com/qawolf/cli/releases/latest/download/qawolf-darwin-arm64
chmod +x qawolf && ./qawolf --help

Quick start

You need a QA Wolf account — sign up at qawolf.com. The <env-id> comes from the QA Wolf dashboard under Settings → Environments.

qawolf auth login                  # or set QAWOLF_API_KEY for CI
qawolf flows run --env <env-id>

qawolf flows run --env runs your team's flows from the local .qawolf/<env> cache (a per-environment copy of your flows on disk), pulling them first only if they are not already cached locally and installing the runtime dependencies they need. To refresh the local cache, run qawolf flows pull --env <env-id>; to author flows locally without the platform, run qawolf init first.

Examples

The examples/ directory contains sample flows you can run directly:

qawolf install   # one-time: install the browser runtime
qawolf flows run examples/example.flow.ts

Commands

| Command | What it does | | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | qawolf auth | Authenticate with QA Wolf | | qawolf flows | Run flows locally, pull flows | | qawolf run | Trigger and manage QA Wolf runs on the platform (public API) | | qawolf install | Install runtime dependencies | | qawolf init | Set up a local-only project | | qawolf doctor | Diagnose problems |

Run any command with --help for its flags and options.

Agent integration

This repository ships a qawolf-cli Agent Skill that follows the open Agent Skills specification. It works with compatible harnesses such as Claude Code, Codex, Cursor, Gemini CLI, GitHub Copilot, and OpenCode.

Install the CLI first, then use the cross-harness skills installer to install the skill globally:

npm install -g @qawolf/cli
npx skills add qawolf/cli --skill qawolf-cli --global

The installer detects supported harnesses and prompts you to select where to install the skill. To target specific harnesses non-interactively:

npx skills add qawolf/cli \
  --skill qawolf-cli \
  --global \
  --agent claude-code \
  --agent codex \
  --yes

Omit --global to install the skill only for the current project. The skill also ships in the npm package for consumers that manage skill files directly.

The skill is generated from its source template and the command tree (bun run generate), and kept in sync by the test suite.

Runner SDK

Drive interactive runners from TypeScript instead of spawning commands. Every verb names the runner it addresses, so nothing is launched or billed implicitly.

import { createRunnerSdk } from "@qawolf/cli/runner-sdk";

const runner = createRunnerSdk({ apiKey: process.env.QAWOLF_API_KEY });

await runner.launch({ id: "agent-1", runnerFamily: "default" });

const submitted = await runner.run({
  entryPointPath: "src/flows/smoke.flow.ts",
  environment: "ambient",
  runnerId: "agent-1",
  selection: "whole-flow",
});
if (submitted.ok) console.log(submitted.value.runId, submitted.value.fileSync);

ok: false reports a request failure, including transport, auth, or local validation. A runner that refused the request comes back as ok: true with an outcome and failureReason from the published contract, so a caller can switch on it exhaustively. Most verbs expose value.outcome; recording controls expose value.result.outcome and a history value.url.

Control video recording on a Playwright runner after a flow has started its screen:

const recordingId = crypto.randomUUID();
const recording = await runner.record({
  runnerId: "agent-1",
  command: { action: "start", recordingId },
});
if (recording.ok && recording.value.result.outcome === "success") {
  // Drive the browser, then stop this specific capture.
  await runner.record({
    runnerId: "agent-1",
    command: { action: "stop", recordingId },
  });
}

// History remains readable after the runner terminates.
const history = await runner.listRecordings({ runnerId: "agent-1" });
if (history.ok)
  console.log(history.value.recordings, history.value.nextPageToken);

record also accepts { action: "status" } and { action: "auto", enabled: true } (or false). Keep the UUID when retrying start or stop. listRecordings accepts optional recordingId and pageToken filters and returns one page, with stable platform URLs and expiring video URLs. The equivalent CLI commands are qawolf runner record start|stop|status|auto and qawolf runner list-recordings; see the runner reference.

Reference

• Commands — full command and flag reference
• Configuration — qawolf.config.ts fields
• Environment variables
• Exit codes
• Troubleshooting
• Known issues — current limitations and workarounds

Contributing

See CONTRIBUTING.md for development setup. To report a bug or request a feature, open an issue on GitHub.

Security

To report a vulnerability, see SECURITY.md.

License

Apache-2.0