Documentation
Start with one page.
Run an audit, inspect a finding, and decide what to change. The same analyzer works from your terminal, your code, or a build pipeline.
Your first audit
npx aiseo-audit https://example.comReplace the URL with a page you want to inspect. Requires Node.js 20.19+ and npm 10+. No account or AI API key.
The tool fetches the page and public site signals, then analyzes them locally. Add a question to check whether the page covers the subject your reader has in mind:
npx aiseo-audit https://example.com --query "your audience’s question"Follow the quickstartGuides and reference
Run the first page audit and add target queries.
Command-line referenceFind each command, option, output mode, and exit code.
ConfigurationConfigure queries, profiles, weights, and history.
TypeScript APICall the analyzer and renderers from TypeScript.
Report schemaUnderstand scores, stages, factors, and evidence fields.
GitHub ActionCheck preview deployments from continuous integration.
Assistant integrationLet compatible AI assistants run query-aware audits.
Reading the report
Start with access problems. Then review query alignment, the content itself, and source information. Each finding includes its measurement and evidence tier.
Use the score to compare runs with matching settings and evaluation dates. Read the evidence before changing a page: some checks have direct research support, while others are useful heuristics.
The audit cannot predict citations or see a search engine’s private index. Read the limitations or inspect the evidence map.