Quick Start
import { Steps, Aside } from ‘@astrojs/starlight/components’;
This walks through scanning a real local React app end to end.
1. Start your app (or don’t — frontend-qa can do it for you)
Section titled “1. Start your app (or don’t — frontend-qa can do it for you)”If you already have a Vite or Next.js dev server running, skip to step 2.
Otherwise, frontend-qa will detect a Vite or Next.js project in the current
directory and launch its dev server for you automatically when you don’t
pass --url.
2. Run a scan
Section titled “2. Run a scan”-
From the root of the project you want to check:
Terminal window npx frontend-qa scanWith no
--url,frontend-qalooks for a running dev server first; if none is found, it detects your package manager and project type and launches one itself. -
Or, against an already-running server or a deployed URL:
Terminal window npx frontend-qa scan --url http://localhost:5173 -
Scan more than one route:
Terminal window npx frontend-qa scan --url http://localhost:5173 --route / --route /about
3. Read the output
Section titled “3. Read the output”The CLI prints a summary as it finishes:
[frontend-qa] project: react (vite=true)[frontend-qa] scanning http://localhost:5173 routes=["/"]
[frontend-qa] report: .local/frontend-qa/runs/01J.../report.json[frontend-qa] issues: 4 (critical=1 high=2 medium=1 low=0 info=0) - [critical] browser.console: Uncaught exception on click - [high] browser.console: console.error on mount - [high] browser.network: GET /api/data → 500 - [medium] browser.network: img src 404The full report — every issue plus evidence, a screenshot per route, and
config used — is on disk at .local/frontend-qa/runs/<runId>/report.json
and .local/frontend-qa/runs/<runId>/screenshots/.
4. Turn on the opt-in engines
Section titled “4. Turn on the opt-in engines”Runtime scanning (console, network, screenshot, timing) always runs. Add flags for the rest:
npx frontend-qa scan --url http://localhost:5173 --a11y --perf --visual--a11y— axe-core accessibility audit--perf— Lighthouse performance audit--visual— pixel-diff against a stored baseline screenshot
5. Fail CI on real issues
Section titled “5. Fail CI on real issues”npx frontend-qa scan --url http://localhost:5173 --fail-on highExits non-zero if any issue at or above high severity was found (default),
never to always exit 0.
6. Try static and bundle analysis (no browser needed)
Section titled “6. Try static and bundle analysis (no browser needed)”npx frontend-qa static --dir srcnpx frontend-qa bundle --dir dist- Core Concepts — the
Report/Issuemodel and evidence types - Configuration — every flag and its default
- CLI Reference — full command reference