Coderag

🚀 CodeRAG - 圖驅動的代碼分析工具

CodeRAG 是一款革命性的工具，它能將你的代碼庫轉化為智能知識圖譜，藉助人工智能為你提供深入的代碼洞察。通過使用 Neo4J 構建代碼結構的全面圖數據庫，CodeRAG 對類、方法、關係和依賴進行映射，讓 AI 助手能夠更深入地理解你的代碼庫，並提供更準確、具備上下文感知能力的輔助。

🚀 快速開始

只需 5 分鐘，即可讓 CodeRAG 啟動並運行：

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
   # 使用你的 Neo4J 憑證編輯 .env 文件
   

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 工具集成方法和高級用法。

✨ 主要特性

• 🔧 自動化掃描 - 解析 TypeScript、JavaScript、Java 和 Python 項目。
• 🎯 智能分析 - 識別類、方法、接口、繼承關係和依賴。
• 📈 質量指標 - 計算 CK 指標、包耦合度和檢測架構問題。
• 🤖 支持 AI - 可與 Claude Code、Windsurf、Cursor、VS Code Continue 等集成。
• 💡 引導式提示 - 提供用於代碼分析和探索的交互式工作流程。
• 🔄 雙模式 - 支持 STDIO 用於直接的 AI 集成，支持 HTTP 用於基於 Web 的工具。

📦 安裝指南

克隆項目

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

配置數據庫

使用 Docker 快速搭建 Neo4J 數據庫：

docker run --name neo4j-coderag -p 7474:7474 -p 7687:7687 -d \
  --env NEO4J_AUTH=neo4j/your_password neo4j:5.12

配置環境變量

cp .env.example .env
# 編輯 .env 文件，填入 Neo4J 憑證

💻 使用示例

基礎用法

快速掃描項目

npm run scan /path/to/project

啟動以集成 AI 助手

npm start

高級用法

運行質量分析

npm run scan /path/to/project -- --analyze

啟動 Web 服務器以支持 HTTP 訪問

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# (即將支持)

功能說明

• 🔍 智能代碼掃描 - 自動分析你的代碼庫，並構建所有類、方法、接口及其關係的詳細圖譜。
• 📊 質量洞察 - 計算行業標準指標（CK 指標、包耦合度、架構模式），以識別代碼異味和改進機會。
• 🤖 AI 集成 - 通過模型上下文協議（MCP）與 AI 編碼助手無縫連接，使其深入瞭解你的代碼結構。
• 🏗️ 架構分析 - 可視化繼承層次結構、依賴鏈和架構模式，幫助你理解複雜的代碼庫。

📄 許可證

本項目採用 MIT 許可證，詳情請參閱 LICENSE 文件。

適用場景

• 代碼審查 - 獲取能理解你整個代碼庫上下文的 AI 輔助。
• 新員工入職 - 幫助新團隊成員快速理解大型複雜項目。
• 代碼重構 - 識別緊密耦合的代碼、循環依賴和架構問題。
• 文檔生成 - 生成關於代碼關係和設計模式的洞察。
• 遺留代碼分析 - 映射和理解具有複雜結構的遺留代碼庫。