Overview
QAClan is a regression testing tool in two halves: an agent that runs on your machine, and an optional server that makes results visible to your team.
The two halves
The agent is a single binary called qaclan. It records browser tests with Playwright, captures or imports API requests, organises everything into projects and suites, runs them, and stores it all in ~/.qaclan/. It has a local web UI at localhost:7823. It works offline and it is free.
The server is qaclan.com. Once you log in, the agent syncs your projects, scripts, suites, runs, API collections and generated API docs to a shared workspace. The server adds run history across machines, six regression reports, AI script analysis and team seats. That is the Team plan.
They are complementary, not alternatives. The agent is the execution layer and is always required. The server is the visibility layer and is optional.
Quickstart
From nothing to a recorded test.
1. Get your auth key
Create an account, then copy the key from Settings → Auth Key. The agent uses it to identify you.
2. Install the agent
Linux / macOS
curl -fsSL https://raw.githubusercontent.com/qaclan/agent/master/install.sh | shOn Windows, download the binary for your CPU and run qaclan setup. Full detail, including the setup flags and what lands on disk, is on Install and setup.
3. Log in and start the local UI
qaclan login --key <your_auth_key> && qaclan serveYour browser opens at localhost:7823. If you are logged in, this also starts the background sync worker and triggers an immediate sync attempt.
4. Create a project and record something
qaclan project create "Checkout"qaclan web feature create "checkout flow"qaclan web record --feature <feature_id> --name "place order" --url https://your-app.testA browser opens. Click through the journey, then close the browser — the captured actions are wrapped in a run harness and saved as a script under that feature.
Recording needs a display
Codegen drives a real browser window, so recording does not work on a machine with no display server. Record on your desktop, then run the result headless anywhere.
5. Capture the APIs behind the journey
qaclan api record --url https://your-app.testA browser opens and records every HTTP call your application makes while you use it. When you finish, you choose which of the captured requests to save into a collection. This is the fastest way to get API coverage of a flow you were already testing by hand.
Where to go next
| Page | What it covers |
|---|---|
| Install and setup | Prerequisites, every platform, setup flags, the runtime, uninstalling |
| Web testing | Features, recording, script languages, importing existing Playwright scripts |
| API testing | Collections, imports, assertions, scripts, auth, generated API docs, exports |
| Environments and secrets | Variables, {{var}} resolution, masking secrets |
| Suites, runs and reports | Ordering, shared state, run flags, run history, offline HTML reports |
| Sync, team and plans | What syncs, push and pull, invites, seats, what the Team plan gates |
| CLI reference | Every command group and flag |
| FAQ and troubleshooting | Common questions, and what to do when something breaks |