@qa-audit/cli
v0.2.1
Published
Thin CLI for QA Audit — audits and CLI bundles run on the hosted API (no engine shipped).
Readme
@qa-audit/cli
Free command-line tools for QA Audit.
What you get: inventory tests in your repo and run Test Coverage Review — compare a paid crawl to pages/routes, Application Map buttons and forms, and unit/component files. Crawls and scoring stay on the hosted API; this package is a thin client. API access needs a paid token from https://qa-audit.com/account.
Install the package, then run the qa-audit command.
Docs wiki: https://qa-audit.com/docs
Install
npm install -g @qa-audit/cliRequires Node 24+.
Setup
- Complete a paid audit at https://qa-audit.com/audit
- Create an API token at https://qa-audit.com/account
- Configure:
qa-audit config set --api-url https://qa-audit.com --token <your-token>Local API (dev server on port 3002):
# Either form works — bare host:port gets http:// automatically
export QA_AUDIT_API_URL=http://localhost:3002
# or: export QA_AUDIT_API_URL=localhost:3002
qa-audit whoamiCommands
qa-audit whoami
qa-audit audit https://example.com --tier essential --modules seo,links --json
qa-audit scan a11y https://example.com --tier launch
qa-audit scan map https://example.com --tier essential --pages 10
qa-audit scan flows https://example.com --tier engineering --json
qa-audit init
qa-audit run
# Test Coverage Review (Team+ token): compare crawl to local tests
qa-audit bundle --job-id <report-job-id> --path ./your-repo
# writes ./your-repo/qa-audit/ — start at report.md (plain overview), then:
# coverage.csv, per-page.md, bundle.json
# manual-test-cases.md, automation-snippets.md, jira-tickets.md
# tests/gaps.md, tests/unit.md, tests/controls.md, tests/app-routes.md, tests/hygiene.md
# tests/{smoke,a11y,performance,…}.md (Engineering+ drafts)
qa-audit bundle download --job-id <report-job-id> --path ./your-repoProject config (qa-audit.yml)
qa-audit initSee qa-audit.example.yml and https://qa-audit.com/docs/qa-audit-yml for every attribute (testDirs, fileCap, exclude, testRunner apply to bundle --path and repo-scan).
Full artifact table: https://qa-audit.com/docs/bundle-artifacts
Scan wrappers
qa-audit scans| Scan | Modules | Default tier |
|------|---------|--------------|
| seo | seo | — |
| links | links | — |
| a11y | accessibility | — |
| security | security | — |
| mobile | mobile | essential |
| social | social | essential |
| performance | performance | essential |
| map | seo+links+a11y+security+mobile+social | essential |
| flows | same as map (Engineering behavioral checks) | engineering |
| keyboard | accessibility | engineering |
| coverage | seo+links (then bundle --path) | team |
| all | all modules | engineering |
Aliases: discovery → map, behavioral → flows, test-map → coverage.
Local test inventory (no API token — package manager, runners, unit/component file matches):
qa-audit repo-scan --path .
qa-audit repo-scan --path . --json --out inventory.jsonFull attribute tables: https://qa-audit.com/docs/scan-types
