CLI
ranklint audit
Crawl a deployed site or a local build and fail CI on error issues.
| Flag | Description |
|---|---|
--url | address of a live site |
--start | path to .output/server/index.mjs — starts Nitro itself and stops it after; the server origin overrides site.url, so zones match localhost |
--profile | profile from ranklint.config |
--reporter | markdown (default) | json | junit | gitlab | html | github | sarif — markdown groups issues by rule: errors first, biggest groups first; html is a single page with the report data embedded, grouped by page by default with a switch to grouping by rule; brand fonts load from Google Fonts (offline it falls back to system fonts) |
--output | report to a file instead of stdout |
--json-output | additionally the raw json (input for diff) |
--html-output | additionally an html report: a single page with the data embedded, grouped by page by default with a switch to grouping by rule; brand fonts load from Google Fonts, system fonts offline (e.g. for Pages) |
--cwd | where to look for ranklint.config |
--mode monitor | monitoring mode (below) |
Exit code 1 on error issues. Without a ranklint.config it runs with a minimal config from the URL origin. Flow: config → custom checks → seeds (crawl.entry paths or the audited URL; with strategy: 'sitemap+sample' — a sitemap sample: group by route pattern, up to 5 random URLs per group) → BFS crawl → checks → crawl-budget analysis (parametric URL groups: how many, how many with canonical/noindex — shows where crawl budget leaks) → Lighthouse → report.