用途:生成单份自包含的 llms.txt 约定 Markdown 文档,供 LLM 与 RAG 场景使用,例如 NotebookLM、向量数据库或智能体上下文。每个 H2 对应一个概念,是独立检索单元。
主要能力:按概念分节,每节 1-3 句说明加一个带注释的代码示例;控制 token 预算;结尾输出 Summary。支持远程模式(根据 GitHub URL 或 org/repo)与本地模式(在代码库中扫描当前目录文档)。若信号不明确会先询问。
使用方式:远程模式先做稀疏克隆,例如:git clone --depth 1 --filter=blob:none --sparse https://github.com/{org}/{repo}.git /tmp/llms-gen-{repo},随后执行 git sparse-checkout set docs/ README.md CHANGELOG.md;指定版本可执行 git fetch --depth 1 origin tag {version} && git checkout {version}。无 docs/ 时改用 README、wiki、pages、content、src 等。本地模式用 find 扫描 .md、.mdx、*.rst。之后提取主题、逐节合成、装配并输出。默认参数:token 预算 10000(5K 精简 / 20K 全面),版本 latest,语言自动检测,主题过滤 all,代码密度 balanced。命名默认 {library-name}.llms.txt,本地代码库为根目录 llms.txt。
适用场景:为库或项目生成 LLM 友好参考;在代码库内生成上下文文档;按主题和预算做聚焦输出。
限制:不含目录、元数据与前言,文档以 # 名称开头;每节仅一个主代码块,至多一个合理第二块;说明不超过 3 句;不含安装步骤(除非该节本身即安装)、外部链接与已弃用 API。无文档时依赖源码注释,需提示用户;自动生成的 API 参考需按概念归组;monorepo 需询问具体包或每包一份;非英文文档默认按源语言生成;预算不足时优先核心并说明被排除内容。收费、价格与平台信息暂未提供。