Documentation
Command-line reference
Commands, options, output formats, and exit codes for terminal and script use.
Jeff Patterson / Agency Enterprise. Updated August 30, 2026.
Usage
Provide a page URL or --sitemap. Omit both only when rendering cross-URL history with --diff --all.
aiseo-audit [options] [url]Analysis options
| Field or option | Description |
|---|---|
--query <query> | Target query; repeatable, with a maximum of ten. |
--domain <type> | auto, product, or informational page profile. |
--engine <preset> | Experimental generic, gemini, gpt, or perplexity weighting. |
--sitemap <url> | Audit every URL found in a sitemap or sitemap index. |
--signals-base <url> | Override the base used for robots.txt and llms files. |
--timeout <ms> | Per-request timeout; the default is 45000. |
Output and quality gates
| Field or option | Description |
|---|---|
--json / --md / --html | Select a report format. |
--out <path> | Write output and infer the format from the extension. |
--tldr | Emit only the score, stages, and top three fixes. |
--fail-under <score> | Exit with code 1 when the audit falls below the threshold. |
--diff | Record the run and compare it with the previous baseline. |
--baseline <path> | Compare against a specific JSON result without updating history. |
Exit codes
| Field or option | Description |
|---|---|
0 | Audit completed and any configured threshold passed. |
1 | The result fell below --fail-under. |
2 | Invalid usage, configuration, or runtime failure. |