llms-txt-gen icon

llms-txt-gen

llms-txt-gen 是一款零依赖的 Node.js CLI,可根据网站 sitemap 生成入门级 `llms.txt` 文件。帮助站长快速创建可发布草稿,并在站点根目录编辑后发布。

llms-txt-gen

它是什么

llms-txt-gen 是一款零依赖的 Node.js CLI,可根据网站的 sitemap 生成入门级 `llms.txt` 文件。它面向希望快速创建可发布 `llms.txt` 草稿、而不必手工整理页面列表的站点所有者。

该工具读取 `/sitemap.xml`,包括 sitemap 索引,收集找到的 URL,并输出一个可供你在站点根目录发布前编辑的 Markdown 脚手架。它的输出本质上只是起点:README 会提示你替换占位说明、删减页面列表,然后自行发布该文件。

该仓库将工具定位在 answer engine optimization 和 AI 搜索可见性上,示例中引用了 ChatGPT、Perplexity、Gemini 和 Google AI Overviews。该包适合通过 `npx` 进行简单的本地使用,代码要求 Node 18+,以便使用内置的 `fetch`。

核心能力

一条命令即可使用的 CLI

通过 `npx` 从命令行运行,因此无需先把包添加到项目中,就能生成入门文件。

基于 sitemap 的 URL 收集

从站点获取 `/sitemap.xml`,并读取其中列出的 URL,包括指向子 sitemap 的 sitemap 索引。

结构化的入门输出

创建符合规范的 `llms.txt` 脚手架,包含站点标题、占位摘要和经过筛选的页面列表,便于在发布前编辑。

标准输出或文件输出

可选择将结果打印到 stdout,或使用 `--output` 直接写入文件。

URL 限制与去重

支持 `--max` 限制包含的 URL 数量,默认值为 100,并在输出前移除重复项。

轻量运行时占用

不使用外部依赖,只需 Node 18+,因为它依赖内置的 `fetch`。

典型用例

  • 快速生成新的 llms.txt

    当你想快速发布一份面向 LLM 的精选摘要时,可根据现有 sitemap 创建一个初始版 `llms.txt` 文件。

  • 整理站点关键页面

    将已有 sitemap 转成草稿,在发布前精简到最相关的页面。

  • 准备人工审阅文件

    生成一个本地输出文件,先在文本编辑器中审阅,再上传到站点根目录。

  • 支持 AI 搜索可见性工作

    通过生成结构化、可人工编辑的页面列表,检查站点页面可能如何在 AI 搜索工作流中被呈现。

Pros and Cons

Pros

  • 零外部依赖,使安装和执行都很简单。
  • 可通过 `npx` 运行,因此无需完整项目设置。
  • 同时支持 sitemap 索引和扁平的 sitemap 文件。
  • 既可以写入文件,也可以打印到 stdout,适合脚本化和交互式使用。
  • 会去重 URL,并允许你用 `--max` 限制列表长度。

Cons

  • 它依赖站点提供 `/sitemap.xml`;如果该端点缺失或无法访问,生成就会失败。
  • 生成的文件只是一个入门模板,因此在发布前仍需要人工编辑。
  • 它只使用 sitemap 数据,因此并不声称会进行更广泛的站点爬取或内容分析。

FAQ

如何运行 llms-txt-gen?

它作为一个 Node.js CLI 运行,可通过 `npx github:NitishSamurai/llms-txt-gen <site-url>` 调用。该工具会读取 `/sitemap.xml`,支持 sitemap 索引,并且可以使用 `-o` 将生成内容写入文件,或打印到 stdout。

它需要什么运行时?

是的。包元数据要求 Node 18 或更高版本,代码也说明它依赖 Node 18+ 内置的 `fetch`。

它会生成什么?

生成的输出是一个基于 sitemap URL 的入门级 `llms.txt` 文件。README 展示了一个 Markdown 结构,包括站点标题、占位说明,以及一个链接 URL 的 `Pages` 部分,发布前需要你自行编辑。

它可以免费使用吗?

它被设计为一个零依赖 CLI。该包使用 MIT 许可证并发布在 GitHub 上,适合开源使用或在不安装依赖树的情况下快速评估。

它会抓取 sitemap 之外的页面吗?

仓库说明它遵循的是保守工作流:抓取站点 sitemap,按需跟随 sitemap 索引,去重 URL,并通过 `--max` 选项限制列表长度。它并不声称会在 sitemap 之外抓取整个网站。

Quick Facts

类别
开发工具
平台
Node.js CLI
运行时
Node 18+
许可证
MIT
源域名
github.com
输出
入门级 llms.txt Markdown