GitHub/GitLabリポジトリを自動でWiki化！ DeepWikiでドキュメント作成を効率化

GitHub/GitLabリポジトリを自動でWiki化！ DeepWikiでドキュメント作成を効率化

DeepWikiは、GitHubやGitLabのリポジトリから、美しくインタラクティブなWikiを自動生成するツールです。煩雑なドキュメント作成作業から解放され、コードの理解を深め、チーム開発を促進します。

DeepWikiの魅力的な機能

• 瞬時にドキュメント作成: GitHub/GitLabリポジトリを数秒でWikiに変換。
• AIによるスマートな解析: コード構造と関係性をAIが解析し、理解を深めます。
• 美しい図の自動生成: Mermaid記法による図を自動生成し、アーキテクチャやデータフローを視覚化。
• 簡単な操作性: シンプルで直感的なインターフェースで、Wikiを簡単に探索。

DeepWikiを試してみよう！

Dockerを使う方法（推奨）

1. リポジトリをクローンします。

   git clone https://github.com/AsyncFuncAI/deepwiki-open.git
   cd deepwiki-open
   

2. APIキーを設定するための.envファイルを作成します。

   echo "GOOGLE_API_KEY=your_google_api_key" > .env
   echo "OPENAI_API_KEY=your_openai_api_key" >> .env
   

3. Docker Composeで実行します。

   docker-compose up
   

   APIキーの入手先:

   • Google APIキー: Google AI Studioから取得
   • OpenAI APIキー: OpenAI Platformから取得

手動で設定する方法

1. APIキーの設定

   プロジェクトルートディレクトリに.envファイルを作成し、APIキーを設定します。

   GOOGLE_API_KEY=your_google_api_key
   OPENAI_API_KEY=your_openai_api_key
   

2. バックエンドの起動

   pip install -r api/requirements.txt
   python -m api.main
   

3. フロントエンドの起動

   npm install
   # または
   yarn install
   npm run dev
   # または
   yarn dev
   

4. DeepWikiを使ってみよう！

   ブラウザで http://localhost:3000 を開いて、GitHub/GitLabリポジトリ名を入力し、「Generate Wiki」をクリック。

DeepWikiはどのように動くのか？

DeepWikiはAIを活用し、以下の手順で動作します。

1. GitHub/GitLabリポジトリをクローンして解析
2. コードの埋め込みを作成し、スマートな検索を実現
3. コンテキストを意識したAIでドキュメントを生成
4. コードの関係性を説明する図を生成
5. すべてを構造化されたWikiに編成

プロジェクトの構造

• api/: バックエンドのAPIサーバー
  • main.py: APIのエントリーポイント
  • api.py: FastAPI実装
  • rag.py: Retrieval Augmented Generation
  • data_pipeline.py: データ処理ユーティリティ
  • requirements.txt: Pythonの依存関係
• src/: フロントエンドのNext.jsアプリケーション
  • app/: Next.jsのアプリケーションディレクトリ
    • page.tsx: メインアプリケーションページ
  • components/: Reactコンポーネント
    • Mermaid.tsx: Mermaid図のレンダラー
• public/: 静的アセット
• package.json: JavaScriptの依存関係
• .env: 環境変数（自分で作成）

困ったときは？

• APIキーの問題：
  • "Missing environment variables": .envファイルがプロジェクトルートにあり、APIキーが正しく設定されているか確認。
  • "API key not valid": APIキーをコピーする際に、余分なスペースが入っていないか確認。
• 接続の問題：
  • "Cannot connect to API server": APIサーバーがポート8001で実行されているか確認。
  • "CORS error": フロントエンドとバックエンドを同じマシン上で実行してみてください。
• 生成の問題：
  • "Error generating wiki": 非常に大きなリポジトリの場合、まずより小さなリポジトリを試してください。
  • "Invalid repository format": 有効なGitHub/GitLab URL形式を使用しているか確認。
  • "Diagram rendering error": アプリが自動的に壊れた図を修正します。

コントリビューションしませんか？

バグ報告や機能リクエスト、コード改善のプルリクエストなど、貢献を歓迎しています！

ライセンス

MITライセンスで提供されています。詳細はLICENSEファイルをご覧ください。