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 index,收集找到的 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 index。

結構化初稿輸出

建立符合規格的 `llms.txt` 骨架,包含網站標題、預留摘要,以及可在發布前編修的精選頁面清單。

stdout 或檔案輸出

可選擇將結果輸出到 stdout,或使用 `--output` 直接寫入檔案。

URL 限制與去重

接受 `--max` 來限制納入的 URL 數量,預設為 100,並在輸出前移除重複項目。

輕量執行負擔

不使用外部相依套件,且只需 Node 18+,因為它依賴內建的 `fetch`。

典型使用情境

  • 快速建立新的 llms.txt

    當你想快速發布一份面向 LLM 的精選摘要時,可從既有 sitemap 先建立第一版 `llms.txt`。

  • 整理網站重點頁面

    將既有 sitemap 轉成草稿,並在發布前縮減為最相關的頁面。

  • 準備供人工審核的檔案

    產生可在文字編輯器中檢視,之後再上傳至網站根目錄的本機輸出檔。

  • 支援 AI 搜尋可見性工作

    透過產生結構化且可人工編修的頁面清單,協助檢視網站頁面在 AI 搜尋工作流程中的呈現方式。

Pros and Cons

Pros

  • 零外部相依套件,使安裝與執行都更簡單。
  • 可透過 `npx` 執行,因此不需要完整專案設定。
  • 同時支援 sitemap index 與平面 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 index,且可用 `-o` 將產生的內容寫入檔案,或輸出到 stdout。

它需要什麼執行環境?

是的。套件中繼資料要求使用 Node 18 或更新版本,而程式碼也註明它依賴 Node 18+ 內建的 `fetch`。

它會產生什麼?

產生的輸出是一份根據 sitemap URL 建立的初始 `llms.txt` 檔案。README 顯示的是一個 Markdown 結構,包含網站標題、預留說明,以及一個 `Pages` 區段的連結 URL,預期你在發布前自行編修。

它可以免費使用嗎?

它被設計為零依賴的 CLI。此套件採用 MIT 授權並發佈於 GitHub,因此適合開源使用或快速評估,而無需安裝一整套相依性。

它會爬取 sitemap 以外的頁面嗎?

該儲存庫說明它採取保守的流程:抓取網站 sitemap、選擇性跟隨 sitemap index、去除重複 URL,並以 `--max` 選項限制清單長度。它不主張超出 sitemap 之外進行完整網站爬取。

Quick Facts

類別
開發者工具
平台
Node.js CLI
執行環境
Node 18+
授權
MIT
來源網域
github.com
輸出
Starter llms.txt Markdown