Open source · SEO & Search

llms.txt Auditor

Check llms.txt files, links and crawler-facing guidance for consistent scope.

v0.1.0 · Node.js 22+ · MIT

Browse the public repository · View releases

Audit a local llms.txt file and the documentation inventory it indexes: structure, link targets, descriptions and stated coverage, with a 1-based line number on every diagnostic.

This walkthrough uses the tool's public README and checked-in example files. Run the command from a repository checkout with Node.js 22+.

Run the checked-in example

node bin/llms-txt-auditor.mjs --file examples/clean/llms.txt \
  --inventory examples/clean/docs --capture examples/clean/capture.json   # exit 0

node bin/llms-txt-auditor.mjs --file examples/broken/llms.txt \
  --inventory examples/broken/docs --capture examples/broken/capture.json # exit 1

Read the result

The broken example reports, among others, a misspelled local target, an entry pointing at a directory, a target that resolves outside the declared root, a javascript: target, and a section that says "Every page of the handbook is listed here" while three inventoried documents are not in its list.