Skip to content

ToolmeshAI/llms-txt-builder

English | 中文

llms-txt-builder

llms-txt-builder is a zero-dependency Node CLI that turns repo metadata and selected docs into a draft llms.txt.

If llms-txt-check answers "is this file valid enough to ship?", this repo answers "how do I draft one fast enough to ship at all?"

llms-txt-builder demo

Quick Proof

  • builds a draft llms.txt from title, summary, docs, examples, and notes
  • supports repeated --doc and --example entries
  • writes to stdout or directly to an output file
  • pairs naturally with llms-txt-check for a generate-then-validate flow

Requirements

  • Node.js >=20
  • no runtime dependencies

Usage

node bin/llms-txt-builder.js \
  --title ToolmeshAI \
  --summary "Practical MCP, docs, and agent workflow tools." \
  --repo-url https://github.com/ToolmeshAI \
  --doc README.md \
  --doc Guide=docs/guide.md \
  --example Quickstart=examples/quickstart.md \
  --notes "English-first README|Chinese mirror available" \
  --output ./tmp/llms.txt

Demo

Output Example

Repository docs

Related repos

License

MIT. See LICENSE.

About

Zero-dependency CLI that builds a publishable llms.txt draft from repo metadata, docs, and examples.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors