コーディングエージェント向けのオープンソースリポジトリドキュメント「OpenWiki」を公開

本日、コードベースのドキュメント生成と維持のためのオープンソースエージェントおよび CLI である OpenWiki をリリースいたします。 エージェントは、自分が作業しているリポジトリを理解することで、より良いコードを書けるようになります。重要なロジックがどこに存在するか、ファイル間の接続関係、そしてコードベースが期待するパターンを知る必要があります。優れたドキュメントは、その文脈を提供し、より情報に基づいたコード変更と、回避可能なミスの減少につながります。 問題は、ドキュメントを最新の状態に保つことが難しいことです。初期のドキュメント作成には時間がかかりますが、コードの変更ごとに更新するのはさらに困難です。頻繁なプルリクエスト（PR）が行われる大規模なリポジトリでは、ドキュメントはすぐに古くなってしまいます。 OpenWiki はこの作業を自動的に処理します。リポジトリ用のウィキを作成し、そのウィキをコーディングエージェントに接続し、コードが変更されるたびに自動で更新し続けます。 ## エージェントのためのウィキについて 私たちは、既存のコードベース用ウィキに関する取り組み、例えば [DeepWiki](https://deepwiki.com/)、[AutoWiki](https://docs.factory.ai/cli/features/wiki/overview)、そして Karpathy の LLM Wiki（LLM ウィキ）コンセプトに触発されました。共通する考え方はシンプルです。ウィキは、すべてのコンテキストを一つの巨大なファイルに押し込むことなく、人間とエージェントがコードベースを理解するための構造化された手段を提供します。 それが重要なのは、ほとんどのコーディングエージェントがすでに AGENTS.md や CLAUDE.md といったファイルを読み込んで指示に従っているからです。これらのファイルは有用ですが、数百ページにわたるリポジトリのドキュメントを保存する適切な場所ではありません。これらはエージェントに対して正しいコンテキストへと誘導し、必要な情報を取得させるべきです。 OpenWiki はそのモデルに従っています。リポジトリ用のウィキを生成し、その後、そのウィキへの参照を含むエージェントの指示ファイルを更新します。そこから、コーディングエージェントはドキュメントを自動的に発見して利用できるようになります。 ## 始め方 OpenWiki はコマンドラインから簡単に実行できるように設計されています。 npm を使ってインストールしてください: npm install -g openwiki その後、以下を実行します: openwiki --init ![image](https://cdn.prod.website-files.com/65c81e88c254bb0f97633a71/6a45549cd89555f7e03154f8_image%20(49).png) init コマンドはモデルプロバイダーと API キーの入力を求め、その後リポジトリのドキュメントを生成します。 OpenWiki は OpenRouter、Fireworks、Baseten、OpenAI、Anthropic を含む、オープンおよびクローズド型の両方のモデルプロバイダーをサポートしています。デフォルトではオープンなモデルを持つ OpenRouter が使用されますが、設定に合わせて最適なプロバイダーを構成することも可能です。 OpenWiki は [DeepAgents](https://docs.langchain.com/oss/python/deepagents/overview) をベースに構築されているため、[LangSmith](https://langsmith.com/) へのトレーシングもサポートしています。LangSmith の API キーを提供すれば、OpenWiki は実行を LangSmith プロジェクトにトレースし、ドキュメントの生成や更新中にエージェントが何を行ったかを詳細に確認できるようになります。 ## OpenWiki がコーディングエージェントにどのように接続するか ウィキを生成した後、OpenWiki はリポジトリのエージェント設定ファイルを更新します。リポジトリが AGENTS.md または CLAUDE.md（またはその両方）を使用している場合、OpenWiki は生成されたウィキへの参照を追加し、エージェントがいつそれを使用すべきかを説明します。 このアプローチを選んだのは、ウィキ全体を指示ファイル内に配置するとコンテキスト量が膨大になりすぎるからです。大規模なリポジトリでは、ウィキは数百のファイルにまたがることもあります。そのようなすべてをすべてのエージェント実行時に読み込むのは非効率的であり、維持管理も困難です。 短い参照の方が効果的です。コーディングエージェントはすでに指示ファイルを読み込んでいます。OpenWiki が参照を追加すれば、エージェントはリポジトリのコンテキストが必要になった際にウィキを検出でき、ワークフローを変更する必要はありません。 ## ウィキを最新の状態に保つ ドキュメントを一度生成するだけでは有用ですが、それらを最新の状態に保つことで OpenWiki の価値がさらに高まります。 OpenWiki には [スケジュール実行可能な GitHub Action](https://github.com/langchain-ai/openwiki/blob/main/examples/openwiki-update.yml) が含まれており（例：1 日 1 回など）、このアクションは更新フラグを指定して OpenWiki を実行します。OpenWiki は前回の実行以降にマージされたコミットを確認し、git の差分（diff）を使用して変更箇所を理解した上で、関連するコンテキストでウィキを更新します。 つまり、このワークフローはバックグラウンドで実行可能です。コードベースが変化するにつれて OpenWiki がドキュメントを更新し、既存の指示ファイル経由での参照を通じて、コーディングエージェントは常に最新のウィキを把握し続けます。 ## コードベースを第一に設計 今回の最初のリリースは、コードベース向けのウィキ機能に焦点を当てています。開発者が手動で詳細なドキュメントを作成・維持する必要なく、エージェントが作業対象のリポジトリを理解しやすくすることを目指しています。 将来的には、OpenWiki の概念はより広範な分野にも適用できると考えています。エージェントはコーディングだけでなく、さまざまな種類の業務において永続的な文脈を必要とします。コードベースのドキュメンテーションは最初のユースケースですが、同じパターンは他のワークフローにおいても、エージェントが有用な文脈を維持する手助けとなります。 ## 試してみる OpenWiki はオープンソースであり、現在利用可能です。 インストールして `openwiki --init` を実行すれば、数分でリポジトリ用のウィキを生成できます。 リポジトリはこちらで確認できます：[https://github.com/langchain-ai/openwiki](https://github.com/langchain-ai/openwiki)

コーディングエージェント向けのオープンソースリポジトリドキュメント「OpenWiki」を公開

背景や根拠まで確認しますか？

関連記事

調べる

選ぶ

サイト