Open source · Docs & Knowledge

AI Readable Docs Indexer

Build a compact AI-readable docs index with scope, freshness and source links.

v0.1.0 · Node.js 22+ · MIT

Browse the public repository · View releases

TOOLID=llms-docs-indexer. Build a compact, deterministic JSON index of local documentation exports. Each entry contains only declared purpose, owner and scope, an explicit review date and freshness state, a SHA-256 content hash, and a local link that the CLI verifies inside the supplied root. The tool never invents a capability from document prose, claims its own authority, fetches a URL, or writes to a source system. It has no dependencies.

This walkthrough uses the tool's public README and checked-in example files. Run the command from a repository checkout with Node.js 22+; inspect the source before using it on your own files.

Run the checked-in example

node bin/llms-docs-indexer.mjs --root examples --manifest manifest.json --policy policy.json
node bin/llms-docs-indexer.mjs --root examples --manifest stale-manifest.json --policy policy.json
npm run check

Read the result

The first example exits 0/pass and omits the internal note from a public index. The second exits 1/fail because the source is one day beyond the freshness limit. JSON goes to stdout only. --help lists options. Inputs are relative to --root; resolving a symlink outside that real root makes the run incomplete or invalid. No output-file option exists, so evidence cannot be overwritten.

Where this check stops

This local walkthrough does not establish the state of a live production system or replace the limits documented in the repository.

Before adapting the command to your own workflow, review the accepted inputs, exit codes and safety boundaries in the README.

Compiled with AI assistance from checked-in public documentation and example scripts. Run the example and review the repository's current documentation before relying on its result.