User Manual

Get started with QAClan

From sign-up to your first test suite in minutes. Follow this guide to install the agent, record tests, and run them — no code required.

Quick Install

$ curl -fsSL https://raw.githubusercontent.com/qaclan/agent/master/install.sh | sh

Then run qaclan serve to launch the agent.

Record

Click through your app in a Playwright browser — we capture every interaction as code.

Organize

Group scripts into suites, features, and projects for clean test architecture.

Run & Sync

Execute locally, view results everywhere. Your team sees every run in the cloud dashboard.

Step-by-step guide

Everything you need, from first login to running test suites.

Step 01
Create your account

Sign in to QAClan

Head over to qaclan.com and sign in using your Google account. This creates your workspace and gives you access to the cloud dashboard.

Google OAuth keeps things fast — no passwords to remember.
Step 02
Settings page

Grab your Auth Key

After signing in you'll land on the Settings page. Your unique auth key is displayed here — copy it. You'll need this to connect the CLI agent to your cloud workspace.

Your key starts with qc_ and is stored securely as a SHA-256 hash.
Step 03
One-liner install

Install the Agent

Open your terminal and run the install command below. It downloads the QAClan CLI agent and sets everything up automatically.

$ curl -fsSL https://raw.githubusercontent.com/qaclan/agent/master/install.sh | sh
Works on macOS and Linux. Windows support via WSL.
Step 04
Start the local server

Launch the Agent

Run the serve command to start the QAClan agent. It will open the local application in your browser where you can manage everything.

$ qaclan serve
The agent runs locally — your tests never leave your machine.
Step 05
Organize your work

Create a Project

From the agent dashboard, create your first project. Projects are top-level containers that group all your features, scripts, suites, and runs together.

One project per application or service is the recommended pattern.
Step 06
Group related tests

Add a Feature

Inside your project, add a feature. Features represent functional areas of your application — like Authentication, Checkout, or Search.

Features help your team understand test coverage at a glance.
Step 07
No code required

Record Your First Script

Navigate to Scripts and click Record. Fill in the details on the record modal and hit Record — a Playwright browser will launch automatically.

  • Interact with your app as a real user would
  • Add assertions to validate expected behavior
  • Close the Playwright browser when you're done recording
Step 08
Review your test

Script Created

Once the Playwright browser closes, your new test script is saved automatically. You can view the generated Playwright code, edit it, or re-record.

Scripts are stored locally and synced to the cloud for team visibility.
Step 09
Build your test library

Record More Scripts

Record additional test cases following the same flow. For example, record a Logout test — just stop recording in Playwright for any steps you want to skip (like the login part), then start recording once you're ready.

  • Stop recording during setup steps you want to skip
  • Start recording again when the actual test begins
  • Close the browser to save the script
Step 10
Bundle tests together

Create a Suite

Click New Suite and give it a name — for example "Authentication". Suites let you run multiple test scripts together in a specific order.

Suites are perfect for end-to-end workflows that span multiple scripts.
Step 11
Add scripts in order

Configure the Suite

Click Edit on your new suite and add the test scripts in the order you want them to run. For our Authentication suite, that's Login first, then Logout.

Drag to reorder — execution follows the sequence you set.
Step 12
Execute your tests

Run the Suite

Click Run on your suite. You'll be asked to select an environment — if you haven't set one up yet, choose "None" and hit Run Suite. The agent executes each script in sequence.

Environments let you run the same tests against staging, dev, or production.
Step 13
Pass or fail, instantly

View Results

After execution completes, you'll see the results for every test in the suite — passed, failed, or partial. Each result includes detailed logs and timing.

Results sync to the cloud so your whole team can review them.
Step 14
Track over time

Run History

Head to the Runs section to browse your complete run history. Every suite and script execution is logged with timestamps, status, and environment details.

Use run history to spot regressions and track test reliability over time.

Ready to level up your testing?

Install the QAClan agent, record your first test, and see results in your cloud dashboard — all in under 5 minutes.