aiseo-auditv2.0.1

Documentation

aiseo-audit docs: page audits, evidence, interfaces, and reports

In brief. This is the aiseo-audit documentation for one page audit, the command-line interface, TypeScript API, continuous integration, GitHub Action, JSON report schema, and Model Context Protocol server. Every interface uses the same analyzer, score, and evidence records.

Maintained by Jeff Patterson and Agency Enterprise · Updated August 30, 2026

How the aiseo-audit documentation works: overview

Audit one page before you set up a larger workflow.

The first result shows page fetching, target-query alignment, and the page-side change that deserves review.

npx aiseo-audit https://example.com

No account or external AI key is required. The tool fetches the page and public site signals, analyzes them locally, and reports the score, four pipeline stages, evidence tiers, and top recommendations. This order matters because a failed access check blocks every later stage. This means the first report becomes the baseline for the next measured change.

Requires Node.js 20.19 or later.

The default audit is engine-agnostic and uses the informational or product profile detected from the page.

aiseo-audit documentation terms

Command-line interface

A command-line interface refers to the terminal commands used to run an audit.

TypeScript API

A TypeScript API refers to the exported functions and types used in Node.js code.

Continuous integration

Continuous integration means that an automated audit runs when code changes.

Report schema

A report schema is defined as the documented structure of the JSON result.

Model Context Protocol

Model Context Protocol refers to the interface that lets a compatible AI client call the audit tool.

Evidence tier

An evidence tier is a type of label that states the strength and scope of a scored factor.

Choose your next step

Open only the guide you need. Use Quickstart for the first run. Use the reference pages when you need a flag, field, or code example.

Quickstart

Run the first page audit and add target queries.

Command-line reference

Find each command, option, output mode, and exit code.

Configuration

Configure queries, profiles, weights, and history.

TypeScript API

Call the analyzer and renderers from TypeScript.

Report schema

Understand scores, stages, factors, and evidence fields.

GitHub Action

Check preview deployments from continuous integration.

Assistant integration

Let compatible AI assistants run query-aware audits.

Key principles

  • Deterministic scoring: identical fetched inputs, version, and configuration produce the same audit result.
  • Evidence-tiered output: the report distinguishes supported factors from conditionals, heuristics, diagnostics, and experiments.
  • Pipeline-aware analysis: eligibility, retrieval, citation fitness, and provenance remain separate.
  • No citation promise: a score is a readiness measure, not a traffic or citation projection.
  • Inspectable data: JavaScript Object Notation (JSON) output contains every factor, citation, unscored observation, and raw measurement.
The score starts a review. It does not end one.

Check the measured value, inspect the cited evidence, and review the page as a person before you ship a change.

Key takeaways

  • The guide is the best entry point for a first audit.
  • The CLI is the direct interface for terminal and script use.
  • The API is the interface for Node.js applications.
  • The action is the interface for pull-request checks.
  • The server is the interface for compatible AI assistants.

Bottom line: run one page first, then open only the reference needed for the next workflow.

The result is one repeatable record of the page, query set, tool version, scores, and evidence.

This works by keeping every interface on the same analyzer. As a consequence, a command-line report and an API report remain comparable.

Official sources and verification

According to the npm package page, aiseo-audit publishes its current version and install command [1]. According to the GitHub repository, its source and documentation are public [2]. According to the evidence map, scored factors record a tier and pipeline stage[3].

According to the release history, major scoring changes receive migration notes [4]. According to the license, aiseo-audit uses the MIT license[5].

  1. aiseo-audit on npm: package and installation details.
  2. agencyenterprise/aiseo-audit: source and documentation.
  3. Evidence map: factor tiers and sources.
  4. Release history: version and migration records.
  5. MIT license: project license.