6.4 KiB

Raw Blame History

XCodeReviewer - 您的智能代码审计伙伴 🚀

多Agent、PR批量自动审计版本正在开发中，敬请期待......

XCodeReviewer 是一个由大型语言模型（LLM）驱动的现代化代码审计平台，采用前后端分离架构，旨在为开发者提供智能、全面且极具深度的代码质量分析和审查服务。

📚 文档导航

文档	说明
部署指南	Docker 和本地开发部署说明
配置说明	后端配置、数据库模式、API 中转站
LLM 平台支持	10+ LLM 平台配置和 API Key 获取
常见问题	常见问题解答
贡献指南	如何参与项目贡献
安全政策	代码隐私与安全说明
免责声明	使用条款与免责声明

🌟 为什么选择 XCodeReviewer？

AI 驱动的深度分析：超越传统静态分析，理解代码意图，发现深层逻辑问题
多维度、全方位评估：从安全性、性能、可维护性到代码风格，提供 360 度无死角的质量评估
清晰、可行的修复建议：独创 What-Why-How 模式，不仅告诉您"是什么"问题，还解释"为什么"，并提供"如何修复"的具体代码示例
多平台 LLM 支持: 已实现 10+ 主流平台 API 调用功能（Gemini、OpenAI、Claude、通义千问、DeepSeek、智谱AI、Kimi、文心一言、MiniMax、豆包、Ollama 本地大模型）
前后端分离架构：采用 React + FastAPI 现代化架构，后端使用 LiteLLM 统一适配多种 LLM 平台
可视化运行时配置：无需重新构建镜像，直接在浏览器中配置所有 LLM 参数和 API Keys

🎬 项目演示

智能仪表盘

实时展示项目统计、质量趋势和系统性能

即时分析

支持代码片段快速分析，提供详细的 What-Why-How 解释和修复建议

项目管理

集成 GitHub/GitLab 仓库，支持多语言项目审计和批量代码分析

审计报告

专业的代码审计报告，支持导出 PDF/JSON 格式

🚀 快速开始

Docker Compose 部署（推荐）

# 克隆项目
git clone https://github.com/lintsinghua/XCodeReviewer.git
cd XCodeReviewer

# 配置后端环境变量
cp backend/env.example backend/.env
# 编辑 backend/.env 文件，配置 LLM API Key 等参数

# 启动所有服务
docker-compose up -d

# 访问应用
# 前端: http://localhost:5173
# 后端 API: http://localhost:8000
# API 文档: http://localhost:8000/docs

更多部署方式请参考部署指南。

✨ 核心功能

🚀 项目管理：一键集成 GitHub/GitLab，支持多语言项目审计，ZIP 文件上传
⚡ 即时分析：代码片段快速分析，10+ 种语言支持，历史记录和报告导出
🧠 智能审计：五大核心维度检测（Bug、安全、性能、风格、可维护性）
💡 可解释性分析：What-Why-How 模式，精准代码定位
📊 可视化报告：质量仪表盘、趋势分析、JSON/PDF 导出
⚙️ 系统管理：运行时配置、数据库管理、用户认证

🎯 未来计划

✅ 多平台 LLM 支持: 已实现 10+ 主流平台 API 调用功能
✅ 本地模型支持: 已加入对 Ollama 本地大模型的调用功能
✅ 可视化配置管理: 已实现运行时配置系统
✅ 专业报告文件生成: 支持 JSON 和 PDF 格式导出
✅ 前后端分离架构: 采用 FastAPI + React 现代化架构
✅ 用户认证系统: JWT Token 认证和用户管理
🚧 CI/CD 集成与 PR 自动审查: 计划实现 GitHub/GitLab CI 集成
Multi-Agent Collaboration: 考虑引入多智能体协作架构
审计标准自定义: 支持通过 YAML/JSON 定义团队特定的编码规范

🤝 贡献

我们欢迎所有形式的贡献！详情请参考贡献指南。

📞 联系我们

项目链接: https://github.com/lintsinghua/XCodeReviewer
问题反馈: Issues
作者邮箱: lintsinghua@qq.com（合作请注明来意）

⭐ 如果这个项目对您有帮助，请给我们一个 Star！

⚠️ 重要提示：使用本工具前，请务必阅读安全政策和免责声明。

6.4 KiB Raw Blame History Unescape Escape