AFDocs CLI
AFDocs tests a documentation site for AI agent friendliness: 28 checks across seven categories and a score out of 100.
- 111 ★ on the repository
- Last commit
- MIT
Minimal access
Why this level
- The tool sends HTTP requests to the sites it checks, though it limits the rate.
Install
- Works in
In your terminal, with SkillFoxx CLI
npx skillfoxx add cli/afdocsDetects the agents on your machine, shows the access level and pins the version.
Other ways to install
Access and checks
How we reviewMinimal accessThe tool runs nothing and makes no network calls.
- The tool sends HTTP requests to the sites it checks, though it limits the rate.
This is third-party code. Review the repository files before installing.
What it does
A command-line tool that tests a documentation site against the Agent-Friendly Documentation spec. `npx afdocs check https://docs.example.com --format scorecard` produces an overall score and category scores: content discoverability, Markdown availability, page size and truncation risk and more, 28 checks in all. For failures it gives fix hints, for example about an `llms.txt` file and an HTML directive. Reports come as a scorecard, with vitest helpers for CI and a TypeScript API. AFDocs underlies Agent Score by Fern and several documentation scoring services. The tool makes HTTP requests to the tested site with a 200 ms delay between requests, a connection cap and respect for `Retry-After`.
Who it is for. Authors and owners of product and API documentation who want AI agents to find and read their pages.
Good fit when
- Before releasing docs you check whether an agent sees `llms.txt` and Markdown pages.
- You want to measure the docs score in CI and catch regressions.
- You want a prioritized fix list instead of general advice.
- Several documentation sites are compared on the same checks.
Not a fit when
- You need a check of human readability and docs design.
- Requests to someone else site without permission are not acceptable.
- You need a stable CLI: the project is at an early 0.x stage.
Example request
Run `afdocs check https://docs.example.com --format scorecard` and show the overall score and the three most important fixes.Limitations
The project is at an early 0.x stage, and check IDs, CLI flags and output format may change between minor versions. It implements spec version 0.6.0 of September 13, 2026. Node.js 22 or newer is required. The tool sends HTTP requests to the tested site, so check only your own sites or ones you have permission for. The score reflects only the spec criteria and does not replace a readability check for humans. The result depends on site availability at check time: closed sections, redirects and rate limits can lower the score.
How to disable. Remove the global package with `npm uninstall -g afdocs` or drop it from devDependencies. The tool does not change tested sites and leaves no background processes.
FAQ
How do I run a check?
Run `npx afdocs check https://docs.example.com --format scorecard`. No installation is needed.
How do I install globally or in a project?
`npm install -g afdocs` globally or `npm install -D afdocs` as a dev dependency for CI.
How many checks and categories?
28 checks across seven categories, for example content discoverability, Markdown availability, page size and truncation risk.
How much load does it put on a site?
A 200 ms delay between requests by default, a connection cap and respect for `Retry-After`.
What is Agent Score for?
The Fern service built on AFDocs rates documentation friendliness for agents.
Discussion
No questions or reviews yet.
Related
CLI toolsMulti-agent documentation generator: analyzes a repository and builds a README and AI assistant config files
A CLI and skill for an agent to publish reports and specs as HTML documents that a team comments on, with every version kept
A plugin helps agents maintain project documentation, decisions and verification evidence across development sessions
Python CLI where 13 AI agents read an M&A data room across nine domains and report with citations checked against the source
A skill set for academic work: paper review, pre-analysis plan check, grant proposal review, code audit and slide decks.
A CLI and skill that publish local HTML or Markdown at a stable link with versions and comments on quoted passages.
README in short
The README shows a quick run with a sample report, installation, links to full documentation on scores and checks, a list of services built on AFDocs and responsible use rules.