Getting started

Takes

About 15 minutes

You need

A Google account and an app to test

You end with

One recorded test, run, with a result

The whole path

1. 1

   Sign up and copy your auth key.

   Google is the only way in, so there is no password to choose. The first screen shows a key beginning with qc_ and asks you to name your first project. The key is how software on your machine proves it belongs to your account.

   You can read it again any time under Settings → Auth Key. What you cannot undo is regenerating it — that stops the old key working everywhere.

2. 2

   Install the agent — one line in a terminal.

   Linux / macOS

   $

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

   Windows (PowerShell)

   >

   Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass -Force
   irm https://raw.githubusercontent.com/qaclan/agent/master/install.ps1 | iex

   It brings its own browser and runtime, so nothing else has to be installed first. Expect a few minutes. Open a fresh terminal afterwards, or the new qaclan command will not be found yet — that, and every other platform detail, is on Install and setup.

3. 3

   Start the app and paste the key in.

   $

   qaclan serve

   A tab opens at localhost:7823 — QAClan running on your own machine, private to your computer. It asks for your auth key; paste the one from step 1. From then on your work syncs in the background.

   Leave that terminal window open. Closing it stops the app; Ctrl + C stops it deliberately.

4. 4

   Make a feature to hold the test.

   A feature is a folder for one area of your application. Go to Features in the sidebar, choose + New Feature and name it — checkout, login. That is the only field.

5. 5

   Record a journey.

   Scripts → Record. Name the journey, pick the feature you just made, put in the address it starts from, then Start Recording. A browser opens — click through your application exactly as a person would, then close that browser window. Closing it is what ends the recording.

   QAClan then looks over what it captured and asks a few questions — mostly offering to replace hardcoded values with variables and to add waits where the page needs a moment. Accepting the suggestions is the right default on a first recording; all of it is editable later. Full walkthrough: Web testing.

6. 6

   Put it in a suite and run it.

   Scripts run as part of a suite — an ordered list executed in one browser session, so a sign-in at the top leaves everything after it signed in. Go to Suites, create one, add your script, then choose Run.

   Every default in the run dialog is right for a first run. Leave Headless off so you can watch the browser work — it is the quickest way to see whether the recording captured what you meant. Every option is explained on Suites, runs and reports.

7. 7

   Read the result.

   You get a pass or fail for the suite and for each item in it. A failure comes with a screenshot of the page at the moment it broke, a plain-language reason rather than a stack trace, and the browser console and network logs from the run.

   Past runs are listed under Runs. Everything you have made is on your machine under ~/.qaclan/ and is copied to your account in the background — there is no save button. See Sync, team and plans.

qaclan login --key <your_auth_key> && qaclan serve

qaclan project create "Checkout"

qaclan web feature create "checkout flow"

qaclan web record --feature <feature_id> --name "place order" --url https://your-app.test

qaclan web run --suite <suite_id_or_name> --headless

Where to go next