Cli
QA Wolf from anywhere — your terminal, your CI, your AI agent.
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](https://docs.qawolf.com) for the full docs, or [qawolf.com](https://www.qawolf.com) to get started. The project is written primarily in TypeScript, distributed under the Apache License 2.0 license, first published in 2019. It has gained significant community traction with 3,432 stars and 140 forks on GitHub. Key topics include: automation, cli, e2e, end-to-end-testing, playwright.
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
bashnpm 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:
bashnpx @qawolf/cli --help
Supported Node versions: active LTS and newer (currently Node 22+). See nodejs.org.
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.
bashcurl -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.
bashqawolf 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:
bashqawolf 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
The npm package ships skills/qawolf-cli/SKILL.md, a Claude Code agent skill that describes the CLI's command surface for AI agents. It is auto-generated from the command tree (bun run generate) and kept in sync by the test suite.
Reference
- Commands — full command and flag reference
- Configuration —
qawolf.config.tsfields - 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
Contributors
Showing top 5 contributors by commit count.
