getting started

Quick Start

Run your first audits against a URL, a local file, a folder, or a sitemap.

The CLI supports four common inputs: a live URL, a local Markdown or HTML file, a directory of content files, or a sitemap for batch work.

Audit a live URL

Command

answerlint audit --url "https://example.com/docs/article" --output html --output-path ./report.html

Compare against a competitor URL

Command

answerlint audit --url "https://example.com/docs/article" --compare "https://competitor.example/docs/article" --output html --output-path ./compare-report.html

Audit a local Markdown or HTML file

Command

answerlint audit --file ./content/post.md --output json --output-path ./report.json

Audit a directory

Command

answerlint audit --dir ./content --output csv --output-path ./batch.csv

Audit a sitemap

Command

answerlint audit --sitemap "https://example.com/sitemap.xml" --output csv --output-path ./site.csv

Quoting URLs

If your URL contains `&` or other shell-sensitive characters, wrap it in quotes so your shell passes the whole string correctly.