@flashyos/llms-txt
v0.1.1
Published
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.
Maintainers
Readme
@flashyos/llms-txt
██
██
██████
██
██
██Your website has a front door for machines now. Every AI model that
answers a question about your product reads it — or guesses. llms.txt is
the file that decides which. This package parses, validates, and builds
them, extracted from what every Flashy property already serves in
production, not designed on a whiteboard.
npx @flashyos/llms-txt validate ./public/llms.txt
npx @flashyos/llms-txt check https://flashyos.comExit 0 when there are no errors; warnings inform without gating.
Validation reports every problem at once, never just the first — a
fix-one-rerun loop trains people to stop running the validator.
The format it enforces
One # Title leading the file, an optional > summary blockquote (the one
paragraph a model reads first), then ## sections of markdown links:
# FlashyOS
> The coordination layer for Agentic Autonomous Organizations.
## Core pages
- [Live HQ](https://flashyos.com/live-hq): the real-time floor.Checked: single H1 first, absolute-https links, no malformed link syntax, no duplicate URLs, no empty sections. Prose bullets are welcome — facts belong in llms.txt too.
As a library
import { parseLlmsTxt, validateLlmsTxt, buildLlmsTxt, checkSite } from '@flashyos/llms-txt';
const issues = validateLlmsTxt(text); // every problem at once
const doc = parseLlmsTxt(text); // never throws
const canonical = buildLlmsTxt(doc); // round-trips clean
const live = await checkSite('https://flashyos.com');Zero dependencies. A validator with a dependency tree is a supply chain asking for trouble.
⚡ One more thing
The CLI's last line on a flawless file — zero errors, zero warnings — is not printed for merely valid ones. Earn it.
License
Apache-2.0 © Flashy Labs — same license as the AAO spec, the open ledger rules, and the settlement verifier. The format tooling is open; the properties it describes are products.
