# a14y

Score how well a documentation site can be consumed by AI agents. Two interchangeable surfaces back the same scorecard engine: a Node CLI and a Chrome extension.

## Installation

```sh
npm install -g a14y
```

Or load the Chrome extension unpacked from the latest release.

## Usage

```sh
# Single page
a14y check https://example.com/

# Whole site
a14y check https://example.com/ --mode site --max-pages 200

# JSON for scripting
a14y check https://example.com/ --output json | jq .summary
```

See `a14y check --help` for the full flag list.

## Configuration

All knobs are CLI flags or extension options. The most common:

- `--mode page|site`: single page (default) or full crawl.
- `--scorecard <version>`: pin to a historical scorecard for trend stability.
- `--max-pages <n>`: cap site mode at N pages (default 500).
- `--concurrency <n>`: parallel page fetches (default 8).
- `--page-check-concurrency <n>`: parallel page-check evaluations (default 4).
- `--polite-delay <ms>`: minimum delay between request starts (default 250).
- `--fail-under <score>`: exit non-zero if the score drops below a threshold.

## Reference

Full per-check documentation lives at https://a14y.dev/. Source: https://github.com/timothyjordan/a14y.