Home / Security tooling

llms-txt-gen

Generate llms.txt for any docs site or repository.

Python · MIT · latest v0.1.0

What it is

Generate llms.txt for any docs site or repository: point llms-txt-gen at a directory of Markdown or HTML, or at a sitemap URL, and it writes an llms.txt (and, with --full, an llms-full.txt) that follows the convention published at llmstxt.org. It also checks an existing file against that convention and prints the HTML tag that tells crawlers where the file lives. Standard library only, no model in the loop, deterministic output, runs in CI.

Install

pipx install git+https://github.com/basitalisandhu/llms-txt-gen

llms-txt-gen generate docs/ --out llms.txt --base-url https://docs.example.com
llms-txt-gen generate https://docs.example.com/sitemap.xml --out llms.txt --full
llms-txt-gen check llms.txt
llms-txt-gen serve-snippet

From the README; see the full README for every option.

Releases

Topics: ai-readiness, cli, developer-tools, docs, docs-as-code, documentation, github-actions, hacktoberfest, llm, llms-txt, llmstxt, markdown, pre-commit, python, seo, sitemap, static-site