
2026/07/02 5:51
OpenWiki:コードベースのエイジェントドキュメントを作成・管理するための CLI ツール
RSS: https://news.ycombinator.com/rss
要約▶
Japanese Translation:
OpenWiki は、ソフトウェアプロジェクトに正確なドキュメントを生成・維持することを助けるために設計された特殊なコマンドラインツールです。その主な機能は、
openwiki/ ディレクトリを作成し、コードベースが変化すると自動的に更新されるようにすることであり、ドキュメントが存在しない場合は初期のものを作成するか、リポジトリの変更に基づいてそれを更新することで、エージェントが常に最新の情報を参照できるようにします。
OpenWiki を設定するには、まず推論プロバイダーと LLM を構成し(OpenAI、Anthropic、OpenRouter、Fireworks、Baseten のようなプロバイダーおよび Sonnet 5 や GLM 5.2 のようなモデルに开箱即用のサポートを提供)、API キーと秘密情報を
~/.openwiki/.env にローカルで保存します。このツールは、AGENTS.md および/または CLAUDE.md などのファイルにプロンプト指示を自動的に追加することで AI モデルがリポジトリを効果的にどのように扱うべきか案内し、エージェントの有用性を大幅に向上させます。また、ラン実行を追跡するために LangSmith の API キーをオプションで設定することもできます。
OpenWiki を操作するには、
-p フラグを使用してすぐに終了する単一のコマンドを実行したり(例:openwiki -p "Summarize what you can do")、続行メッセージのためにツールを対話的に初期化したりすることができます。継続的インテグレーションのためには、システムは GitHub Actions を使用して毎日に一度ドキュメントを更新し、更新を含んだ PR を作成する自動化をサポートしています。 궁極的には、OpenWiki はコードの変更とエージェントの理解の間のギャップを埋め、AI システムがより正確かつ最新の状態の文脈を持って複雑なコードベースを変更し理解することを可能にします。本文
OpenWiki: エージェント向けコードベース文書管理 CLI ツール
OpenWiki は、コードベースの文書作成および管理を担う CLI ツールです。特にエージェント向けに設計されています。
インストールと設定
クイックスタート
- OpenWiki を初期化し、モデルと API キーを設定します。
- 文書生成を実行した後、リポジトリへ以下の GitHub Actions を追加してください。これにより、毎日自動でドキュメントの更新内容を Pull Request (PR) で作成されます (
)。openwiki-update.yml- 設定ファイルは
にコピーして使用します。.github/workflows/openwiki-update.yml
- 設定ファイルは
使い方
コマンドラインから以下の操作が可能です:
-
インタラクティブ CLI の起動
openwiki "Please generate documentation for this repository" -
単一コマンドの実行と終了
- 指定したタスクを実行し、すぐにプロセスを閉じます。
openwiki -p "Summarize what you can do"
- 指定したタスクを実行し、すぐにプロセスを閉じます。
-
基本的な操作
- OpenWiki の初期化
- 既存文書の更新
- ヘルプ表示
動作の詳細
-
文書の自動作成・更新
コマンドを実行すると、未作成の場合はopenwiki
ディレクトリに新規文書を作成します。openwiki/- 既に存在する場合は、リポジトリの変更内容に応じて文書を刷新します。
- デフォルトでは各実行後に CLI が閉じず、フォローアップメッセージを送信できるようになっています。
- 一度限りで非インタラクティブな実行を行いたい場合は
または-p
フラグを使用し、アシスタントの最終出力を標準出力に印刷します。--print
-
エージェントへの自動プロンプト追加
- コーディングエージェントがコンテキスト検索時に文書を参照できるように、自動的に以下のファイルにプロンプトを追加します:
AGENTS.mdCLAUDE.md
- これらのファイルがリポジトリに存在しない場合は、OpenWiki が自動的に作成します。
- コーディングエージェントがコンテキスト検索時に文書を参照できるように、自動的に以下のファイルにプロンプトを追加します:
-
設定と追跡機能
- 初回のインタラクティブな実行時、以下の項目を設定するよう促されます:
- 推論プロバイダー
- API キー
- LLM
- オプションで LangSmith を使用して実行を追跡できます:
- LangSmith API キーの設定
- データ記録用プロジェクト名の指定(デフォルト:
)openwiki
- 初回のインタラクティブな実行時、以下の項目を設定するよう促されます:
-
設定ファイルの保存場所
- これらの設定オプションと機密情報は、ローカルマシンの以下パスに保存されます:
~/.openwiki/.env
- これらの設定オプションと機密情報は、ローカルマシンの以下パスに保存されます:
カスタマイズ
OpenWiki は以下の主要な推論プロバイダーを基本的な機能としてサポートしています:
-
OpenRouter
-
Fireworks
-
Baseten
-
OpenAI
-
Anthropic
-
デフォルトでは、GLM 5.2 や Kimi K2.6、Sonnet 5 などのモデルが事前定義されています。
-
各推論プロバイダーに対しては、独自のモデル ID を指定して設定できます。
-
より多くの推論プロバイダーやモデルを追加したい場合は、PR をご提出ください。