llms-txt-generator

概述

llms-txt-generator是一个专业工具，为代码项目创建AI优化的文档文件。它生成简洁的llms.txt文件用于快速导航和全面的llms-full.txt文件用于深入理解项目。该工具利用AI能力创建符合AI语言而非传统人类语言的文档。

试试问 AI

装完之后，这里有 5 个你可以让 AI 做的事：

• generate-llms

  Generate llms.txt and llms-full.txt files for the current project based on user requirements

  试试:Generate llms.txt and llms-full.txt files for this project试试:Generate documentation files with these requirements: output to ./docs directory, include comprehensive project details, focus on TypeScript implementation试试:Create llms files with custom names: project-nav.txt and project-full.txt

可对比工具

安装

# 全局安装
npm install -g llms-txt-generator

# 或使用npx
npx llms-txt-generator init
npx llms-txt-generator build

{
  "mcpServers": {
    "llms-generator": {
      "command": "npx",
      "args": ["-y", "llms-txt-generator-mcp"]
    }
  }
}

{
  "mcpServers": {
    "llms-generator": {
      "command": "npx",
      "args": ["-y", "llms-txt-generator-mcp"]
    }
  }
}

FAQ

llms.txt和llms-full.txt有什么区别？

llms.txt提供简洁的导航视图和简短描述，而llms-full.txt包含全面的文档，包括详细的项目概述、安装说明、完整的项目结构和代码示例。

如何配置自定义输出路径？

使用init命令创建配置文件，然后在llms-txt-generator.yaml配置文件的output部分指定输出路径。

llms-txt-generator 对比