Quickstart

1. Install

You need Node.js 22.18 or later.

npx playwright install chromium
npx webqa-platform audit https://www.example.com/

audit detects the language versions and runs all checks in one step. To work from the repository instead, run npm install && npm run build and use npm run webauditlabs -- in place of webqa.

2. Quick audit of one page

npm run webauditlabs -- run https://www.example.com/

Without a configuration file, the http, overflow and clipping checks run on that single URL. For localhost or a staging server on a private network, add --allow-private.

3. Audit all language versions

npm run webauditlabs -- init https://www.example.nl/

init finds the language versions from hreflang tags, the language switcher or <html lang>, and writes webqa.json:

{
  "version": 1,
  "name": "www.example.nl",
  "locales": [
    { "code": "nl", "url": "https://www.example.nl/nl/" },
    { "code": "en", "url": "https://www.example.nl/en/" },
    { "code": "de", "url": "https://www.example.nl/de/" }
  ],
  "pages": { "urls": ["https://www.example.nl/nl/", "https://www.example.nl/en/", "https://www.example.nl/de/"] },
  "checks": ["http", "lang", "overflow", "links", "clipping"]
}

Review the locales and pages, then run:

npm run webauditlabs -- run webqa.json

4. Read the results

The terminal shows a summary with one entry per finding. The run folder contains everything:

.webqa/runs/<time>/
├── result.json               # validated against result.v1
├── p01-desktop.png
├── p01-mobile.png
└── p06-mobile.annotated.png  # problem elements outlined

Add --json to print the result to stdout for scripts and agents. The exit code is 0 when there are no findings and 1 when there are; see exit codes.