https://github.com/qawolf/cli
Run QA Wolf flows from your terminal or in CI
https://github.com/qawolf/cli
automation bun cli e2e end-to-end-testing playwright qa qawolf test-automation testing typescript
Last synced: about 1 hour ago
JSON representation
Run QA Wolf flows from your terminal or in CI
- Host: GitHub
- URL: https://github.com/qawolf/cli
- Owner: qawolf
- License: apache-2.0
- Created: 2019-09-17T20:45:48.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2026-06-12T20:29:33.000Z (7 days ago)
- Last Synced: 2026-06-12T21:08:58.130Z (7 days ago)
- Topics: automation, bun, cli, e2e, end-to-end-testing, playwright, qa, qawolf, test-automation, testing, typescript
- Language: TypeScript
- Homepage: https://docs.qawolf.com
- Size: 1.6 MB
- Stars: 3,427
- Watchers: 13
- Forks: 140
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
- Agents: AGENTS.md
Awesome Lists containing this project
- awesome-github-projects - cli - QA Wolf from anywhere — your terminal, your CI, your AI agent. ⭐3,428 `TypeScript` 🔥 (🛠️ Developer Tools)
README
# QA Wolf CLI
[](https://www.npmjs.com/package/@qawolf/cli)
[](https://github.com/qawolf/cli/actions/workflows/ci.yml)
[](LICENSE)
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](https://docs.qawolf.com) for the full docs, or [qawolf.com](https://www.qawolf.com) to get started.
## Install
```bash
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:
```bash
npx @qawolf/cli --help
```
Supported Node versions: active LTS and newer (currently Node 22+). See [nodejs.org](https://nodejs.org).
### Standalone binaries
Precompiled binaries are attached to each [GitHub Release](https://github.com/qawolf/cli/releases) — no Node.js required: `qawolf-linux-x64`, `qawolf-linux-arm64`, `qawolf-darwin-x64`, `qawolf-darwin-arm64`, and `qawolf-windows-x64.exe`.
```bash
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](https://www.qawolf.com). The `` comes from the QA Wolf dashboard under **Settings → Environments**.
```bash
qawolf auth login # or set QAWOLF_API_KEY for CI
qawolf flows run --env
```
`qawolf flows run --env` runs your team's flows from the local `.qawolf/` 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 `; to author flows locally without the platform, run `qawolf init` first.
## Examples
The [`examples/`](examples) directory contains sample flows you can run directly:
```bash
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](https://docs.qawolf.com/qawolf/local-execution/authenticate) |
| `qawolf flows` | [Run flows locally](https://docs.qawolf.com/qawolf/local-execution/run-flows-locally), [pull flows](https://docs.qawolf.com/qawolf/local-execution/pull-flows) |
| `qawolf run` | Trigger and manage QA Wolf runs on the platform (public API) |
| `qawolf install` | [Install runtime dependencies](https://docs.qawolf.com/qawolf/local-execution/install-dependencies) |
| `qawolf init` | [Set up a local-only project](https://docs.qawolf.com/qawolf/local-execution/set-up-a-project) |
| `qawolf doctor` | [Diagnose problems](https://docs.qawolf.com/qawolf/local-execution/diagnose-problems) |
Run any command with `--help` for its flags and options.
## Agent integration
The npm package ships [`skills/qawolf-cli/SKILL.md`](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](https://docs.qawolf.com/qawolf/libraries/cli/api-reference/commands) — full command and flag reference
- [Configuration](https://docs.qawolf.com/qawolf/libraries/cli/api-reference/configuration) — `qawolf.config.ts` fields
- [Environment variables](https://docs.qawolf.com/qawolf/libraries/cli/api-reference/environment-variables)
- [Exit codes](https://docs.qawolf.com/qawolf/libraries/cli/api-reference/index#exit-codes)
- [Troubleshooting](https://docs.qawolf.com/qawolf/libraries/cli/troubleshooting)
- [Known issues](docs/known-issues.md) — current limitations and workarounds
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup. To report a bug or request a feature, open an issue on [GitHub](https://github.com/qawolf/cli/issues).
## Security
To report a vulnerability, see [SECURITY.md](SECURITY.md).
## License
[Apache-2.0](LICENSE)