Agentiqa Docs

Quickstart

From zero to a release gate on the free Community Edition, in about 7 minutes.

You'll explore your app, save a test plan, and run it the way CI will. This works on the free Community Edition. Once a plan is saved, each run from the CLI takes about a minute.

You need: Node.js 18+ (20 recommended) and a URL to test. localhost works, with no tunnel needed.

1. Sign in (1 min)

npx -y agentiqa@latest login
npx -y agentiqa@latest whoami

2. Create or choose a project (1 min)

A project is the URL under test plus everything the agent learns about it.

npx -y agentiqa@latest project create      # or: project list / project use <id-or-name>

3. Explore (3 min)

npx -y agentiqa@latest explore "Test the signup flow" --url http://localhost:3000

The agent maps the flow, runs it, and reports findings with screenshots and repro steps.

4. Save it as a test plan (1 min)

Save the explored flow as a plan (tp_…). See the CLI guide for the plan commands, or let your coding agent do it once you approve.

5. Run it like a gate (~1 min)

npx -y agentiqa@latest run --plan-id tp_… --json
echo $?   # 0 pass · 1 plan failed · 2 config/plan-limit · 3 infra (safe to retry)

That exit code is your gate.

Put it in CI

Create a service key under Project Settings → CLI Service Keys, store it as the AGENTIQA_SERVICE_KEY secret, then add:

- uses: agentiqa/qa-action@v1
  with:
    service-key: ${{ secrets.AGENTIQA_SERVICE_KEY }}

Details: Gate releases in CI.

Prefer a UI?

Open the web app, create a project with your URL, and ask the Assistant "What can you test here?". The web app runs in the cloud, so it can't reach localhost. Use the CLI or the desktop app for local targets.

If something fails

On this page