DeepWiki-Open: コードリポジトリからインタラクティブなWikiを生成するオープンソースツール

リポジトリURLからWikiを生成

DeepWiki-Openは、GitHub、GitLab、BitbucketでホストされているコードリポジトリのインタラクティブなWikiページを自動生成するオープンソースツールです。リポジトリのURLを指定すると、コードをクローンし、構造を分析し、アーキテクチャとデータフローを説明するMermaid図を含むナビゲート可能なWikiを生成します。プロジェクトはPythonで書かれており、フロントエンドはNext.js、バックエンドはFastAPIです。READMEによると、個人用アクセストークンを提供すればプライベートリポジトリもサポートされます。READMEには、インスタントドキュメント、プライベートリポジトリのサポート、AI駆動の分析、自動図生成、簡単なナビゲーション、RAGベースのQ&A機能、ディープリサーチ機能、複数のモデルプロバイダーのサポートなどの機能も記載されています。プロジェクトはMITライセンスの下で配布されています。

実行方法: Dockerまたは手動セットアップ

DeepWiki-Openをローカルで実行するには、READMEに2つの方法が記載されています。1つ目はDockerです。リポジトリをクローンした後、必要なAPIキーを含む.envファイルを作成し、docker-compose upを実行します。これにより、ホストディレクトリがマウントされ、クローンしたリポジトリ、埋め込み、キャッシュされたWikiコンテンツがコンテナ再起動後も保持されます。2つ目は手動セットアップです。poetryを使用してPython依存関係をインストールし（python -m pip install poetry==2.0.1 && poetry install -C api）、次にpython -m api.mainでAPIサーバーを起動します。フロントエンドには、npm installまたはyarn installでJavaScript依存関係をインストールし、npm run devまたはyarn devを実行します。Webアプリはhttp://localhost:3000でアクセスできます。READMEは環境変数も指定しており、GOOGLE_API_KEY、OPENAI_API_KEY、OPENROUTER_API_KEYが含まれ、Ollamaを使用しない場合でも埋め込み用にOpenAI APIキーが必要であると注記しています。

バックエンドとフロントエンドの連携

プロジェクトはバックエンドAPIとフロントエンドWebアプリケーションに分かれています。バックエンドはapi/ディレクトリにあり、FastAPIサーバーで、リポジトリのクローン、コード分析、埋め込み作成、ドキュメント生成を処理します。また、検索拡張生成（rag.py）とデータ処理（data_pipeline.py）のモジュールも含まれています。フロントエンドはsrc/ディレクトリにあり、Next.jsアプリケーションで、ユーザーインターフェースを提供し、専用コンポーネント（Mermaid.tsx）を介してMermaid図をレンダリングします。READMEのフローチャートは処理パイプラインを示しています：ユーザーがリポジトリURLを送信し、ツールがプライベートかどうかを確認し、コードをクローンし、構造を分析し、埋め込みを作成し、モデルプロバイダー（Google、OpenAI、OpenRouter、Ollama）を選択し、ドキュメントと図を生成し、最終的にインタラクティブなWikiにまとめます。

質問とディープリサーチ機能

DeepWiki-Openには、リポジトリ内の実際のコードスニペットに基づいて質問に答えるために検索拡張生成（RAG）を使用するQ&A機能が含まれています。応答をリアルタイムでストリーミングし、会話履歴を保持して、より一貫性のある対話を可能にします。別のディープリサーチ機能は、多段階の調査を実行します：まず調査計画を作成し、次に反復ごとに更新を提供し、最後に包括的な結論を提供します。AIは結論に達するまで自動的に調査を続行し、最大5回の反復が可能です。ディープリサーチを使用するには、質問を送信する前にインターフェースの「ディープリサーチ」スイッチを切り替えます。READMEは調査段階も説明しています：調査計画、調査更新、最終結論。

モデルプロバイダー、環境変数、設定ファイル

DeepWiki-Openは、Google Gemini、OpenAI、OpenRouter、ローカルOllamaモデルなど、複数の言語モデルプロバイダーをサポートしています。READMEにはデフォルトモデルがリストされています：Googleはgemini-2.5-flash、OpenAIはgpt-5-nano、Ollamaはllama3です。各プロバイダーには.envファイルにAPIキーが必要です。システムは、DEEPWIKI_AUTH_MODE環境変数で有効になる認証モードもサポートしており、有効なコードを持つユーザーにWiki生成を制限します。ただし、READMEはこのモードが直接APIアクセスを完全にブロックできないため、セキュリティ境界ではないと述べています。api/config/の設定ファイルは、ジェネレーター、エンベッダー、リポジトリ設定を制御し、その場所はDEEPWIKI_CONFIG_DIR環境変数で変更できます。OpenAI互換の埋め込みモデル（Alibaba Qwenなど）の場合、READMEは代替設定ファイルとOPENAI_BASE_URLの設定手順を提供しています。

トラブルシューティングとMITライセンス

READMEには、一般的な問題を扱うトラブルシューティングセクションが含まれています。.envファイルがプロジェクトルートにあり、必要なAPIキーが含まれていることを確認し、APIサーバーがポート8001で実行されていることを確認し、問題が続く場合は両方のサーバーを再起動することを推奨しています。大きなリポジトリの場合は、最初に小さなリポジトリを試すことを提案しています。また、認証モードは完全なセキュリティ対策ではないため、直接APIアクセスが可能であると指摘しています。プロジェクトが配布されているMITライセンスは、ソフトウェアの使用、コピー、変更、統合、公開、配布、再ライセンス、販売の権利を許可しますが、ソフトウェアは「現状のまま」提供され、いかなる種類の保証もありません。READMEは、パフォーマンスベンチマーク、本番環境への準備、ライセンスに記載されている以外の具体的なセキュリティ保証については言及していません。

編集部の結論

DeepWiki-Openは、ソースコードから豊富なドキュメントとインタラクティブなWikiを生成できるセルフホストツールで、複数のAIプロバイダーとプライベートリポジトリをサポートしています。READMEにはパフォーマンスベンチマークやセキュリティ保証は記載されていないため、これらの点は検証が必要です。

公式情報源

1. Official documentation
2. Official README
3. Project repository