プログラミング
OpenWiki: コードベースのエージェントドキュメントを記述および維持するCLI
OpenWiki: CLI that writes and maintains agent documentation for your codebase (github.com)
要約
OpenWikiは、エージェントのために特別に構築された、コードベースのドキュメントを記述および維持するCLIツールです。GitHubアクションと連携してドキュメントを最新の状態に保ち、様々なLLMプロバイダーとモデルをサポートしています。このツールは、コードベースのコンテキストを検索する際に、コーディングエージェントが参照できるように設計されています。
全文翻訳
OpenWikiは、エージェントのために特別に構築された、コードベースのドキュメントを記述および維持するCLIです。
インストール
`npm install -g openwiki`
クイックスタート
OpenWikiを初期化し、モデルとAPIキーを設定してからドキュメントを生成します。
`openwiki --init`
次に、ドキュメントが常に最新の状態に保たれるように、GitHubアクションをリポジトリに追加して、ドキュメントの更新を含むPRを毎日自動的に開くようにします。
`openwiki-update.yml`
そのファイルの内容をリポジトリの`.github/workflows/openwiki-update.yml`にコピーします。
使用方法
インタラクティブCLIを開始します:
`openwiki`
最初のリクエストでOpenWikiを開始します:
`openwiki "Please generate documentation for this repository"`
単一のコマンドを実行して終了します:
`openwiki -p "Summarize what you can do"`
OpenWikiを初期化します:
`openwiki --init`
既存のドキュメントを更新します:
`openwiki --update`
ヘルプを表示します:
`openwiki --help`
wikiが存在しない場合、`openwiki`は`openwiki/`に初期ドキュメントを作成します。`openwiki/`がすでに存在する場合、リポジトリの変更からそのドキュメントを更新します。デフォルトでは、各実行後もCLIは開いたままであり、フォローアップメッセージを送信できます。`-p`または`--print`を使用して、最終アシスタント出力を出力するワンショットの非インタラクティブ実行を行います。
OpenWikiは、コーディングエージェントがコンテキストを検索する際に参照するように指示するために、`AGENTS.md`および/または`CLAUDE.md`ファイルに自動的にプロンプトを追加します。ファイルがリポジトリにまだ存在しない場合、OpenWikiが作成します。最初のインタラクティブ実行時に、OpenWikiは推論プロバイダー、APIキー、およびLLMを設定させます。OpenWikiの実行を「openwiki」という名前のLangSmithトレーシングプロジェクトにトレースするために、LangSmith APIキーを設定することもできます(オプション)。これらの設定オプションとシークレットは、ローカルマシンの`~/.openwiki/.env`に保存されます。
カスタマイズ
OpenWikiは、OpenRouter、Fireworks、Baseten、OpenAI、Anthropicをすぐにサポートしています。デフォルトでは、いくつかのモデルが事前に定義されています(GLM 5.2、Kimi K2.6、Sonnet 5など)が、各推論プロバイダーについて、OpenWikiは独自のカスタムモデルIDを指定できます。追加してほしい推論プロバイダーやモデルがある場合は、PRをオープンしてください!