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 等 AI 工具集成。
• 💡 引导式提示 - 提供交互式工作流程，用于代码分析和探索。
• 🔄 双模式 - 支持 STDIO 直接与 AI 集成，支持 HTTP 供基于 Web 的工具使用。

📦 安装指南

支持的语言

• TypeScript & JavaScript
• Java
• Python
• C# (即将支持)

💻 使用示例

基础用法

🕵️ 代码调查

"显示所有调用 authenticate 方法的类"

使用 find_classes_calling_method 方法，参数 method_name="authenticate"

🏗️ 架构审查

"此代码库中存在哪些架构问题？"

使用 find_architectural_issues 方法检测循环依赖、上帝类和高耦合问题

📊 质量评估

"我的 UserService 类有多复杂？"

使用 calculate_ck_metrics 方法，参数 class_id="com.example.UserService"

🔍 依赖分析

"这个类依赖于哪些内容，哪些内容依赖于它？"

使用 find_dependencies 提示获取交互式指导

高级用法

常见命令

# 快速扫描项目
npm run scan /path/to/project

# 启动以集成 AI 助手
npm start

# 运行质量分析
npm run scan /path/to/project -- --analyze

# 启动 Web 服务器以支持 HTTP 访问
npm start -- --sse --port 3000

📚 详细文档

📚 完整用户指南 - 包含详细的设置步骤、集成方法和工作流程。

🔧 技术细节

CodeRAG 的功能

• 🔍 智能代码扫描 - 自动分析你的代码库，并构建所有类、方法、接口及其关系的详细图。
• 📊 质量洞察 - 计算行业标准指标（CK 指标、包耦合度、架构模式），以识别代码异味和改进机会。
• 🤖 AI 集成 - 通过模型上下文协议（MCP）与 AI 编码助手无缝连接，使它们能够深入理解你的代码结构。
• 🏗️ 架构分析 - 可视化继承层次结构、依赖链和架构模式，帮助你理解复杂的代码库。

适用场景

• 代码审查 - 获取能理解你整个代码库上下文的 AI 协助。
• 新员工入职 - 帮助新团队成员快速理解大型、复杂的项目。
• 代码重构 - 识别紧密耦合的代码、循环依赖和架构问题。
• 文档编写 - 生成有关代码关系和设计模式的洞察。
• 遗留代码分析 - 映射和理解具有复杂结构的遗留代码库。

📄 许可证

本项目采用 MIT 许可证，详情请参阅 LICENSE 文件。