The agentic network · a Gord Holdings companyRoadmap
← All packages
The spec · v0.1.1 · Apache-2.0

@flashyos/llms-txt

The machine-readable front door, parsed and checked

Parse, validate, and build llms.txt files — machine-readable site metadata for the DeAI web, extracted from the tooling every Flashy property ships in production.

npx @flashyos/llms-txt check https://flashyos.comnpm ↗source ↗

Why it exists

Parse, validate and build llms.txt — the file that tells a model what a site is and where its real documents live. Extracted from what every Flashy property already ships, so it is the working implementation rather than a reading of the spec.

How it works

`@flashyos/llms-txt` parses, validates and builds `llms.txt` — the file that tells a model what a site is and where its real documents live. It is extracted from what every Flashy property already serves in production, so it is the working implementation rather than a reading of the spec.

The format is one `# Title`, an optional `> summary` blockquote a model reads first, then `##` sections of markdown links. `validate` checks a local file and `check` fetches a live URL; both report every problem at once, never just the first, because a fix-one-rerun loop trains people to stop running the validator.

Exit 0 when there are no errors; warnings inform without gating.

Related concepts
IntentMeshagentic autonomous organizationmachine-readable organizational trustAI agent trust register

Use it

Check any site’s front door
npx @flashyos/llms-txt check https://flashyos.com

Installing it puts this command on your path — read from the package’s own manifest, so this list cannot drift from what you actually get.

llms-txt

In practice

Give your site a machine front door
A team runs `npx @flashyos/llms-txt build` from its real pages and serves the result at /llms.txt, so a model answering a question about the product reads what the site says instead of guessing.
Catch a broken front door in CI
`npx @flashyos/llms-txt validate ./public/llms.txt` reports every structural problem at once and exits non-zero on an error, so a malformed file fails a check rather than silently misleading a model.

How it stays honest

The validator is extracted from what every Flashy property already serves in production, not designed on a whiteboard, so the rules it enforces are the rules real files already pass. It reports every problem at once rather than the first, so a fix-one-rerun loop cannot train people to stop checking. Verify any site’s front door yourself with `npx @flashyos/llms-txt check https://flashyos.com`.

Questions

What is an llms.txt file?
llms.txt is a machine-readable file that tells an AI model what a site is and where its real documents live — a leading title, an optional summary a model reads first, then sections of markdown links.
How do I validate an llms.txt file?
Run `npx @flashyos/llms-txt validate ./public/llms.txt` for a local file or `check <url>` for a live one. Both report every problem at once and exit 0 only when there are no errors; warnings inform without gating.
Why report every error at once instead of the first?
Because a fix-one-rerun loop trains people to stop running the validator. Reporting every problem in one pass means one edit cycle fixes the file, so the check keeps getting run.

The licence

Apache-2.0, read from the package’s own manifest. Embed it in anything, including closed software — that is what makes a spec adoptable and a verifier worth running. FlashyOS’s server side is AGPL-3.0-only instead, and a test in the monorepo asserts the direction between them: AGPL code may consume this, this may never consume AGPL code.

Keep reading

Our llms.txt
Also in the spec
@flashyos/aao@flashyos/conformance@flashyos/dialects