Skip to content

ToolmeshAI/llms-txt-check

English | 中文

llms-txt-check

llms-txt-check social preview

llms-txt-check is a zero-dependency Node CLI that validates a repo's llms.txt before you publish broken links, weak summaries, or messy section structure.

If you want a quick answer to "is this llms.txt credible enough to ship?", this repo gives it in one command.

Quick Proof

  • validates the required H1 title and summary paragraph
  • catches duplicate headings and malformed Markdown links
  • flags unusual ordering for common sections such as Docs and Examples
  • prints human-readable text or JSON for CI and tooling

Requirements

  • Node.js >=20
  • no runtime dependencies

Install

npm install

Usage

node bin/llms-txt-check.js --file examples/good/llms.txt --format text

JSON mode:

node bin/llms-txt-check.js --file examples/bad/llms.txt --format json

Demo

Examples

Output

llms.txt check passed
title: ToolmeshAI
summary: Practical MCP, docs, and agent workflow tools for builders who want reusable open-source utilities.

Development

npm test

Repository docs

Related repos

License

MIT. See LICENSE.

About

Zero-dependency CLI that validates llms.txt structure before broken links, weak summaries, or messy sections go public.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors