Get started
Getting started
Five minutes, three steps. Sign in, point a reporter at us, push. Then your dashboard fills in as runs land.
1. Sign in with GitHub
Go to qlens.dev and click Sign in with GitHub. We use GitHub OAuth and only request the public read scopes we need to associate runs with repos. No app installs at this stage — you can add the GitHub App later, when you turn on auto-fix.
2. Get an API key
From the dashboard, open /dashboard/keys and click Create API key. The plain key is shown once — we only store the SHA-256 hash. Copy the qlens_… value into your CI secrets as QLENS_API_KEY.
3. Install a reporter
Pick the reporter that matches your test framework — jest, playwright, cypress, or pytest — and follow the snippet on the install page. Each path is one package install plus one config block.
For most teams the smoke test is:
npm install --save-dev @qlens/jest-reporter
export QLENS_API_KEY=qlens_...
npx jestAt the end of the run you should see [qlens] uploaded N tests in CI logs. That's the signal you're wired up correctly.
4. Open the dashboard
Head to /dashboard. You'll see your repo, the latest run, the rolling test-health grade, and a flakiness panel. Three or four runs in, the trend chart starts showing direction — pass-rate, flakiness rate, and any new regressions worth a look.
5. Decide on auto-fix
This is the killer feature, and it's opt-in per repo. Read the auto-fix concept page before you turn it on — there are knobs (confidence floor, daily cap, opt-in scopes) that matter.
Where to next
- Concepts — the mental model behind the dashboard.
- Troubleshooting — what to check if no runs are showing up.
- REST API — script your own integrations.