langchain-ai/openwiki

OpenWiki – コードベースのためのセルフホスト型・エージェント駆動ドキュメント

概要 – OpenWiki は、大規模言語モデルベースのコーディングエージェント（例：Claude Code、Codex、Cursor、GitHub Copilot、IBM Bob など）が、リポジトリ内にリンクされた Markdown ウィキを自動生成し、最新に保つための Node ベースのツールです。ウィキはあなたが所有するプレーンファイルとして保存され、エージェントは軽量でモデルフリーのツール（openwiki_search、openwiki_read）でクエリできます。

主な機能

• エージェント統合 – 多くの一般的なコーディングエージェント向けのワンクリックインストーラー。エージェントは自身の認証済みモデルセッションを使用するため、個別のプロバイダーを設定する必要はありません。
• 根拠のあるページ – 各ウィキページはソースの証拠（コード、テスト、ドキュメント）に結び付けられています。主張はバージョン管理されます。リポジトリが変更されると、OpenWiki は証拠がずれたページのみを書き換えます。
• 並列ページワーカー – CLI は複数のページを並行してドキュメント化できます（OPENWIKI_PAGE_CONCURRENCY で設定可能）。プロバイダーのレート制限を自動的に処理します。
• ワークスペース – openwiki link で関連リポジトリをグループ化します。エージェントはサービス全体を検索し、任意のメンバーウィキからセクションを読むことができます。
• ビジュアルエクスプローラー – openwiki visualize はローカルサーバーを起動し、ウィキをインタラクティブなノードグラフとして、ライブ Markdown ビューアと並べて表示します。GitHub Pages でホストするための静的ビジュアライザーをエクスポートすることもできます。
• スケジュールされた CI アップデート – 既製の GitHub Actions、GitLab CI、Bitbucket Pipelines のスニペットが、ウィキがコードと乖離したときに PR を開きます。
• パーソナルモード – リポジトリのドキュメントとは別に、接続されたソースを集約する個人用ナレッジウィキ（openwiki personal）を構築できます。

インストール

# Node 22.22+ が必要
npm install -g openwiki   # グローバルインストール（または Pi: pi install npm:openwiki）

次に、お使いのコーディングエージェント用の統合をインストールします（例）：

openwiki integrations install codex   # または claude、cursor、bob、kiro、omp、antigravity、copilot

一般的なワークフロー

1. 初期化 – リポジトリ内で、エージェントに「このリポジトリの OpenWiki を初期化してください…」と依頼します。エージェントは openwiki/ 配下にリンクされたウィキを作成します。
2. クエリ – 後続のセッションで、エージェントに openwiki_search でトピックを検索し、openwiki_read で関連セクションを読むよう依頼します。
3. 更新 – コード変更後、「このリポジトリの OpenWiki を更新してください…」と依頼します。OpenWiki は差分を検査し、既存の主張を検証し、必要なものだけを書き換えます。
4. 探索 – openwiki visualize を実行してグラフを閲覧するか、静的ビジュアライザーをエクスポートします。
5. 自動化 – 提供された CI ワークフロー（openwiki-update.yml）を追加して、ウィキを自動的に同期します。

設定

• 並行性: OPENWIKI_PAGE_CONCURRENCY=4
• 状態ディレクトリ: デフォルトは ~/.openwiki。OPENWIKI_CONFIG_DIR で上書きします。
• プロバイダー選択: CLI は初回実行時にモデルプロバイダーをプロンプト表示します。14 のプロバイダーがサポートされています。

なぜ重要なのか – ドキュメントがコードの近くに保たれ、それを書いたのと同じ LLM によって継続的に更新され、完全に編集可能な Markdown のままです。エージェントは追加の API 呼び出しなしで正確で根拠のあるコンテキストを取得でき、コード理解、デバッグ、オンボーディングが向上します。

---

クイックスタート

npm install -g openwiki
openwiki integrations install codex   # エージェントを選択
# リポジトリ内でエージェントチャットで:
Initialize this repository's OpenWiki from the current source and tests.

これで、検索可能で視覚化可能なウィキが手に入ります。