Coderag

🚀 CodeRAG - グラフ駆動型コード分析

AIによる洞察を得るため、コードベースをインテリジェントな知識グラフに変換します

CodeRAGは、Neo4Jを使用してコード構造の包括的なグラフデータベースを構築する革新的なツールです。クラス、メソッド、関係、依存関係をマッピングすることで、AIアシスタントがコードベースをより深く理解し、より正確で文脈を考慮した支援を提供できるようになります。

🚀 クイックスタート

5分でセットアップして実行できます。

1. クローンとインストール

   git clone https://github.com/JonnoC/CodeRAG.git
   cd CodeRAG
   npm install
   

2. Neo4Jデータベースのセットアップ (詳細なガイドはこちらを参照)

   # Dockerを使用する場合（最も簡単）
   docker run --name neo4j-coderag -p 7474:7474 -p 7687:7687 -d \
     --env NEO4J_AUTH=neo4j/your_password neo4j:5.12
   

3. 環境の設定

   cp .env.example .env
   # .envを開き、Neo4Jの資格情報を編集します
   

4. 最初のプロジェクトをスキャンする

   npm run build
   npm run scan /path/to/your/project
   

5. AIアシスタントに接続する

   AIツールのMCP設定に以下を追加します。

   {
     "mcpServers": {
       "coderag": {
         "command": "node",
         "args": ["/path/to/CodeRAG/build/index.js"]
       }
     }
   }
   

📖 完全なユーザーガイドを読む 詳細なセットアップ手順、AIツールの統合、高度な使用方法について学びましょう。

✨ 主な機能

🔍 スマートコードスキャン

コードベースを自動的に分析し、すべてのクラス、メソッド、インターフェース、およびそれらの関係の詳細なグラフを構築します。

📊 品質洞察

業界標準のメトリクス（CKメトリクス、パッケージ結合度、アーキテクチャパターン）を計算して、コードの臭いや改善の機会を特定します。

🤖 AI統合

Model Context Protocol (MCP) を介してAIコーディングアシスタントとシームレスに接続し、コード構造を深く理解させます。

🏗️ アーキテクチャ分析

継承階層、依存関係チェーン、およびアーキテクチャパターンを視覚化して、複雑なコードベースを理解しやすくします。

💻 使用例

🔍 基本的な使用法

# プロジェクトをすばやくスキャンする
npm run scan /path/to/project

# AIアシスタントとの統合を開始する
npm start

# 品質分析を実行する
npm run scan /path/to/project -- --analyze

# HTTPアクセス用のWebサーバーを起動する
npm start -- --sse --port 3000

🚀 高度な使用法

🕵️ コード調査

"authenticateメソッドを呼び出すすべてのクラスを表示してください"

find_classes_calling_methodを使用して、method_name="authenticate"と指定します

🏗️ アーキテクチャレビュー

"このコードベースにはどのようなアーキテクチャ上の問題がありますか？"

find_architectural_issuesを使用して、循環依存関係、巨大クラス、および高い結合度を検出します

📊 品質評価

"UserServiceクラスはどれくらい複雑ですか？"

calculate_ck_metricsを使用して、class_id="com.example.UserService"と指定します

🔍 依存関係分析

"このクラスは何に依存しており、何がこのクラスに依存していますか？"

find_dependenciesプロンプトを使用して、対話的なガイダンスを得ます

📚 ドキュメント

📚 完全なユーザーガイド - 詳細なセットアップ、統合、およびワークフローについて説明されています。

🔧 技術詳細

対応言語

• TypeScriptとJavaScript
• Java
• Python
• C# (近日公開予定)

適用シーン

• コードレビュー - コードベース全体のコンテキストを理解したAI支援を受ける
• 新規メンバーのオンボーディング - 新しいチームメンバーが大規模で複雑なプロジェクトをすばやく理解できるように支援する
• リファクタリング - 緊密に結合されたコード、循環依存関係、およびアーキテクチャ上の問題を特定する
• ドキュメント作成 - コードの関係や設計パターンに関する洞察を生成する
• レガシーコード分析 - 複雑な構造を持つ継承されたコードベースをマッピングして理解する

📄 ライセンス

MITライセンス - 詳細はLICENSEを参照してください。