Getting started
Install the Webtrax CLI, check a website, and read the report it writes. Needs Node.js 22.19 or newer.
Run a check
You need Node.js 22.19 or newer. There is nothing else to install:
npx @webtrax/cli check https://your-site.example
The runner crawls the site (300 pages by default), checks every link it finds once, and runs three suites: links, passive security and SEO basics. It prints a summary:
Webtrax https://your-site.example/
completed · 42 pages · 310 links checked · 18.2 s
1 high, 3 medium, 9 low
HIGH Broken internal link: https://your-site.example/old-pricing (on 3 pages) [3e4ca28b45]
MEDIUM Content-Security-Policy missing: https://your-site.example/ [62c08acc47]
…
Report: .webtrax/runs/2026-11-16T10-00-00-000Z/report.html
Each finding has a short id in brackets. webtrax explain <id> prints why it matters and how to fix it.
Read the report
Every run gets its own directory under .webtrax/runs/:
| File | What it is |
|---|---|
report.html |
The full report: findings by severity, evidence, every page each problem was seen on, and the fix. Works offline. |
report.md |
The same in Markdown, for a pull request or an AI chat. |
run.ndjson |
Every record of the run (pages, findings, summary), for scripts. See Reports. |
Accessibility and performance
Add --browser to also load a sample of pages in Chromium: the a11y suite runs axe-core’s WCAG 2.x A and AA rules (25 pages by default), and the performance suite measures Largest Contentful Paint, layout shift, time to first byte and page weight (10 pages). They need Chromium, which you install once:
npx playwright@1.57.0 install chromium # or have Google Chrome installed
npx @webtrax/cli check https://your-site.example --browser
webtrax doctor tells you whether a browser is available. The browser goes through the same safety checks as the crawler: it cannot reach private networks or cloud metadata unless the crawler could.
Check a local dev server
npx @webtrax/cli check http://localhost:3000
Local addresses (localhost, private IPs) are allowed automatically. HTTPS and HSTS rules are skipped for them, so a dev server is not flagged for lacking a certificate.
Make it yours
webtrax init writes a webtrax.yml with the defaults spelled out; edit it to set your site, page limit, suites and the severity that fails a check. See Configuration. Then add it to CI (CI) or to your coding agent (MCP).