llms-txt-gen icon

llms-txt-gen

llms-txt-genは、サイトマップからスターター用の`llms.txt`を生成するNode.js CLIです。編集・公開しやすい下書きをすばやく作成できます。

llms-txt-gen

概要

llms-txt-genは、サイトマップからスターター用の`llms.txt`ファイルを生成するゼロ依存のNode.js CLIです。手作業でページ一覧をまとめずに、公開可能な`llms.txt`の下書きをすばやく作成したいサイト運営者向けに作られています。

このツールは`sitemap.xml`を読み込み、サイトマップインデックスも含めて見つかったURLを収集し、サイトのルートに公開する前に編集できるMarkdownの雛形を出力します。出力はあくまで出発点として意図されており、READMEではプレースホルダーの説明文を置き換え、ページ一覧を絞り込み、自分でファイルを公開するよう案内しています。

リポジトリは、このツールをAnswer Engine OptimizationとAI検索での可視性に位置づけており、ChatGPT、Perplexity、Gemini、Google AI Overviewsを参照する例が含まれています。パッケージは`npx`によるシンプルなローカル利用向けに設計されており、組み込みの`fetch`を使うためにNode 18以上が必要です。

主な機能

ワンコマンドのCLI利用

`npx`でコマンドラインから実行できるため、プロジェクトに事前追加せずにスターターファイルを生成できます。

サイトマップベースのURL収集

サイトの`/sitemap.xml`を取得し、子サイトマップを指すサイトマップインデックスを含むURLを読み込みます。

構造化されたスターター出力

サイト見出し、プレースホルダーの概要、編集してから公開できる厳選済みページ一覧を備えた、仕様に沿った`llms.txt`の雛形を作成します。

標準出力またはファイル出力

結果を標準出力に表示するか、`--output`で直接ファイルに書き出すかを選べます。

URL制限と重複排除

含めるURL数の`--max`制限を受け付け、既定値は100で、出力前に重複を削除します。

軽量な実行環境

外部依存を使わず、Node 18+の組み込み`fetch`に依存するだけなので、軽量に動作します。

代表的な使用例

  • 新しいllms.txtを立ち上げる

    既存のサイトマップから初版の`llms.txt`を作成し、LLM向けの要点をすばやくまとめた公開用ドラフトを作ります。

  • サイトの重要ページを選別する

    既存のサイトマップを、公開前に最も関連性の高いページへ絞り込める下書きに変換します。

  • 手動レビュー用のファイルを準備する

    ローカルの出力ファイルを生成し、テキストエディタで確認してからサイトのルートにアップロードします。

  • AI検索での可視性作業を支援する

    構造化された、手で編集しやすいページ一覧を生成することで、AI検索ワークフローでサイトのページがどのように表示されるかを確認します。

Pros and Cons

Pros

  • 外部依存がゼロなので、インストールと実行が簡単です。
  • `npx`で動作するため、フルセットアップなしで実行できます。
  • フラットなサイトマップだけでなく、サイトマップインデックスにも対応しています。
  • ファイルへの書き出しと標準出力への表示の両方に対応しており、スクリプト利用にも対話的利用にも向いています。
  • URLを重複排除し、`--max`で件数を制限できます。

Cons

  • サイトが`/sitemap.xml`を公開していることに依存するため、そのエンドポイントがない、またはアクセスできない場合は生成に失敗します。
  • 生成されるファイルはスターターテンプレートなので、公開前に人手で編集する必要があります。
  • サイトマップデータのみを使用するため、より広範なサイトクロールやコンテンツ分析はうたっていません。

FAQ

llms-txt-genはどのように実行しますか?

Node.js CLIとして動作し、`npx github:NitishSamurai/llms-txt-gen <site-url>` で実行できます。ツールは`/sitemap.xml`を読み込み、サイトマップインデックスにも対応し、生成した内容を`-o`でファイルに書き出すか、標準出力に表示できます。

どのランタイムが必要ですか?

はい。パッケージのメタデータではNode 18以上が必要とされており、コードもNode 18+で利用できる組み込みの`fetch`に依存することが記されています。

何を生成しますか?

サイトマップURLをもとにしたスターター用の`llms.txt`ファイルを生成します。READMEでは、サイト見出し、プレースホルダーの説明文、そして公開前に編集することを想定したリンク付きURLの`Pages`セクションを含むMarkdown構成が示されています。

無料で使えますか?

ゼロ依存のCLIとして設計されています。パッケージはMITライセンスで、GitHubで公開されているため、依存ツリーをインストールせずにオープンソース用途や簡単な評価に使いやすいです。

サイトマップ以外のページもクロールしますか?

リポジトリでは慎重な手順が説明されています。サイトのサイトマップを取得し、必要に応じてサイトマップインデックスをたどり、URLを重複排除し、`--max`オプションで件数を制限します。サイトマップを超えてWebサイト全体をクロールするとまでは述べていません。

Quick Facts

カテゴリ
開発者ツール
プラットフォーム
Node.js CLI
ランタイム
Node 18+
ライセンス
MIT
ソースドメイン
github.com
出力
スターターllms.txtのMarkdown

llms-txt-genの代替品

ByteAsk icon

ByteAsk

ByteAskは、C/C++向けのターミナル起点AIコーディングエージェント。リポジトリを編集し、コンパイラやデバッガ、サニタイザ、テストで変更を検証してから差分を表示。無料枠あり。

hob icon

hob

hobは、エージェントのセッション、ターミナル、履歴、後続作業を、既存のツールやプロバイダーに合わせて整理できる独立したコーディングエージェント向けワークスペース。ローカルでの制御を重視する開発者に最適。

Ably Chat icon

Ably Chat

Ably Chatは、カスタムのリアルタイムチャットアプリを構築できるチャットAPIプラットフォームです。ルーム単位のメッセージ、入力中表示、プレゼンス、リアクション、メッセージ更新に対応し、利用量ベースの料金も選べます。

Manta AI icon

Manta AI

Manta AIは、URLからアプリの挙動を把握し、回帰を検出し、スクリプトやセレクタ管理なしでテストを生成できる自律型Webアプリテストツールです。

SonOf icon

SonOf

SonOfは、リポジトリとPMツールに接続し、コードベースと周辺の製品コンテキストを監査して、承認済みの作業をシニアエンジニアのレビュー付きで公開済みチケットに変えます。

Ghost icon

Ghost

Ghostは、チャット、コード生成、コマンドラインでのタスク実行に対応したターミナル向けAIアシスタントです。無料モデルを同梱し、Linux、macOS、Windowsで使えます。オープンソースです。