英文 README | 中文 README

📚 官方文档

🔍 项目描述 • 🍭 功能预览 • 🔧 部署安装 • 📌 待办清单 🚗 联系我们

项目描述 📚

一个利用大模型帮助我们在 Gitlab 上进行 Code Review 提升研发效能的项目 💪🏻 (( 包括但不限于 GPT 、DeepSeek 等🎁))

这个项目有什么特点? ✨

🐶 针对于 Gitlab 定制 (计划支持 Github 、Gitlab 、Gitee 、Bitbucket 等)

🤖 我们正在开发 Multi-Agent 的插件，多个 Agent 协同工作，共同完成评审

🐱 结合了 多种大模型对接 的能力 🚀

🦊 能够接入私有化 LLM 代码安全问题

🦁 我们将一直关注效能研发 最新的Coder Review动态 融入这个项目

项目架构 🚗

前期架构

🚀 全新架构升级：更强大、更灵活、更高效！ 🌈

🌟 丰富的模型接入　支持轻松接入更多的模型，无论是经典模型还是最新的 AI 模型，都能轻松集成！

🔧 高度定制化　　　开发者可以便捷地自定义处理逻辑和回复机制，打造专属于你的解决方案！

🔗 扩展性强　　　　模块化设计使得功能扩展更加方便，未来可以轻松添加新功能，满足不断变化的需求！

🛠️ 高可维护性　　　代码结构清晰，注释详细，便于维护和二次开发，减少开发者的负担！

快来体验我们的新架构吧，享受前所未有的强大功能和极致体验！✨

功能预览 🌈

主页展示

Webhook 配置

Prompt 提示词配置

消息通知

详细信息

部署 📖

Docker 快速上手

cp .env.example .env
docker compose up -d
docker compose logs -f backend

按部署环境调整 .env 中的 VITE_API_BASE_URL / VITE_DEV_PROXY_TARGET，然后访问 http://localhost:3000 前端界面；停止可执行 docker compose down。

源代码运行 💻

后端启动

# 克隆仓库
git clone git@github.com:mimo-x/Code-Review-GPT-Gitlab.git
cd Code-Review-GPT-Gitlab/backend

# 安装依赖
pip install -r requirements.txt

# 数据库迁移
python manage.py migrate

# 启动服务
python manage.py runserver 0.0.0.0:8001
# 或使用: ./start.sh

前端启动

cd frontend

# 安装依赖
npm install

# 开发模式
npm run dev

# 生产构建
npm run build

配置Gitlab webhook

填写Webhook URL时，请在域名后添加路径/api/webhook/gitlab/，例如：http://example.com/api/webhook/gitlab/

尝试发起一个 Merge Request 吧🎉

交流 👨‍👨‍👦‍👦

👏🏻 很高兴你能向我们提出一些问题和修改建议（Issue，PR）, 欢迎 star 项目 ⭐️

📮 Email：mixuxin@163.com

📱 wx：isxuxin

👨‍👨‍👦‍👦 如果有任何使用问题，欢迎来这里交流（AI 研发效能领域） 👋

参考文献 📚

• (字节)基于大模型 + 知识库的 Code Review 实践
• (美团)代码变更风险可视化系统建设与实践

贡献者 👥

mimo-x

Robbings

vstars1

kexicui

andaoai

Star History

许可证 📑

本项目采用 MIT 许可证 许可。

Code-Review-GPT-Gitlab 快速上手指南

本项目是一个基于大语言模型（支持 GPT、DeepSeek 等）的 GitLab 代码评审工具，旨在通过 AI 自动化提升研发效能。它支持私有化部署以保障代码安全，并具备多 Agent 协同评审能力。

环境准备

在开始部署前，请确保您的服务器满足以下要求：

• 操作系统：Linux (推荐 Ubuntu/CentOS) 或 macOS
• 容器化部署（推荐）：
  • Docker (版本 20.10+)
  • Docker Compose (版本 2.0+)
• 源码部署：
  • Python 3.8+
  • Node.js 16+ & npm
  • Git
• 其他依赖：
  • 可用的 GitLab 实例账号及 Admin 权限（用于配置 Webhook）
  • 大模型 API Key（如 OpenAI, DeepSeek 或本地私有 LLM 地址）

安装步骤

您可以根据需求选择 Docker 快速部署 或 源代码运行。

方案一：Docker 快速部署（推荐）

这是最简便的启动方式，自动处理前后端依赖。

1. 克隆项目并配置环境变量

   git clone git@github.com:mimo-x/Code-Review-GPT-Gitlab.git
   cd Code-Review-GPT-Gitlab
   cp .env.example .env
   

   注意：请编辑 .env 文件，根据实际环境调整 VITE_API_BASE_URL 和 VITE_DEV_PROXY_TARGET，并填入您的大模型 API Key。

2. 启动服务

   docker compose up -d
   

3. 查看日志确认状态

   docker compose logs -f backend
   

   启动成功后，访问 http://localhost:3000 即可进入前端界面。

4. 停止服务

   docker compose down
   

方案二：源代码运行

适合需要二次开发或调试的场景。

1. 后端启动

# 克隆仓库
git clone git@github.com:mimo-x/Code-Review-GPT-Gitlab.git
cd Code-Review-GPT-Gitlab/backend

# 安装依赖 (国内用户可指定 pip 源加速)
pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple

# 数据库迁移
python manage.py migrate

# 启动服务
python manage.py runserver 0.0.0.0:8001
# 或使用脚本：./start.sh

2. 前端启动

cd ../frontend

# 安装依赖 (国内用户可指定 npm 源加速)
npm install --registry=https://registry.npmmirror.com

# 开发模式运行
npm run dev

# 生产环境构建
npm run build

基本使用

完成部署后，请按以下步骤配置以实现自动代码评审：

1. 登录系统 访问前端页面（默认 http://localhost:3000），使用管理员账号登录。

2. 配置模型与 Prompt 在系统设置中填入您的大模型 API Key，并根据团队规范自定义 Prompt 提示词（可在 "Prompt 提示词配置" 页面调整）。

3. 配置 GitLab Webhook

   • 进入 GitLab 项目 -> Settings -> Webhooks。
   • URL 填写：请输入您的部署域名并追加特定路径，格式如下：

     http://<您的域名>/api/webhook/gitlab/
     

     示例：http://example.com/api/webhook/gitlab/
   • 触发事件：勾选 Merge request events。
   • 点击 "Add webhook" 保存。

4. 体验自动评审 在 GitLab 中发起一个新的 Merge Request。系统将自动捕获变更，调用大模型进行分析，并将评审意见以评论形式反馈在 MR 页面中，同时可通过消息通知提醒开发者。