open-code-review团队引入指南:30分钟让团队用起AI代码评审
【免费下载链接】open-code-reviewFast, efficient, battle-tested at Alibaba's scale. Hybrid architecture code review tool: deterministic pipelines + LLM Agent, precise line-level comments, built-in multi-language ruleset (NPE, thread-safety, XSS, SQL injection), OpenAI & Anthropic compatible.项目地址: https://gitcode.com/GitHub_Trending/op/open-code-review
open-code-review是阿里开源的 AI 代码评审 CLI 工具,内部代号 OpenCodeReview,已在阿里巴巴内部服务数万开发者、沉淀千万级代码缺陷经验。它读取 Git diff,调用 LLM 生成行级精确的结构化评审意见,内置 NPE、线程安全、XSS、SQL 注入等多语言规则集,兼容 OpenAI 与 Anthropic 两种 API 格式。本指南带你用 30 分钟完成团队引入:装 CLI → 配模型 → 跑首次评审 → 接入 CI。
为什么选这款 AI 代码评审工具?
通用 Agent(如直接让 Claude Code 看 diff)做评审时,常见问题是:大改动"偷工减料"只审部分文件、行号定位漂移、质量随提示词波动。open-code-review 采用确定性工程 × Agent 混合架构:
- 确定性管线:精确文件筛选、相关文件智能打包成子任务、按文件特征匹配规则模板——保证"必须不出错"的环节不交给模型发挥;
- Agent 动态决策:场景化调优的提示词与工具集,负责上下文检索与深度评审;
- 外部定位与反思模块:系统性提升评审意见的定位准确率与内容准确率。
在覆盖 50 个开源仓库、200 个真实 PR、10 种语言的 AACR-Bench 基准中(80+ 位资深工程师交叉标注 1505 个问题),同一模型下它的精确率与 F1 显著领先,平均 Token 消耗仅为通用 Agent 的约 1/9,评审速度更快——对团队而言意味着更低的 API 账单和更短的 CI 排队时间:
30 分钟落地路线图
| 阶段 | 耗时 | 你要做的事 |
|---|---|---|
| ① 安装 CLI | 5 min | npm 一行命令装好ocr |
| ② 配置 LLM | 10 min | 交互式选供应商、填 Key、测连通 |
| ③ 首次评审 | 10 min | 跑通工作区 / 分支 / commit 三种模式 |
| ④ 团队定制 | 5 min | 加项目级规则、接入 CI 与编辑器 |
详细步骤见官方中文文档 quickstart.md。
第 1 步:一键安装 ocr CLI(5 分钟)
前置要求:Git ≥ 2.41,npm 方式需 Node.js ≥ 18。推荐 npm 全局安装(官方文档见 installation.md):
npm install -g @alibaba-group/open-code-review ocr versionmacOS/Linux 也可brew install open-code-review,Windows 用 PowerShell 安装脚本。npm 安装版会在后台静默自动升级,团队无需操心版本;CI 环境想锁版本可固定@<version>或设OCR_NO_UPDATE=1。
第 2 步:交互式配置 LLM,零门槛上手(10 分钟)
ocr config provider # 选择内置供应商或添加自定义供应商 ocr config model # 为当前供应商挑选模型界面内置 DashScope、Anthropic Claude、DeepSeek、OpenAI、GLM、Kimi 等十余家供应商,选好后填入 API Key,工具会自动执行一次连通性测试,配置写入~/.opencodereview/config.json。
👉团队 Tip:CI / 无界面环境用非交互命令下发同一份配置,便于统一纳管:
ocr config set provider anthropic ocr config set model claude-opus-4-6 ocr llm test # 验证端点,401/403 即 Key 错误第 3 步:让每位成员跑通第一次 AI 代码评审(10 分钟)
进入任意 Git 仓库:
ocr review # 工作区模式:staged + unstaged + untracked 全审 ocr review --from main --to feature-x # 分支区间:评审 feature 分支自 main 分叉后的变更 ocr review --commit abc123 # 单个 commit ocr review --preview # 先看看哪些文件会被评审,不花 token三个实用点:
- 中断可恢复:
ocr session list找到会话 id,加--resume <id>续跑; - 结果可落盘:
--format json --output result.json,供脚本或 AI 宿主 Agent 消费(--audience agent时 stdout 只剩纯 JSON); - 无 diff 也能审:
ocr scan --path internal/agent对整个目录做全文件扫描,适合接手陌生代码库时做安全审计。
评审会话会以 JSONL 存于本地,ocr viewer可在浏览器中浏览与回放,方便新人复盘评审过程(见 viewer.md)。
第 4 步(可选):为团队定制评审规则(5 分钟)
规则按四层优先级链解析:--rule参数 > 项目配置 > 全局配置 > 系统内置规则。团队只需在仓库里提交一份 rule.json 同风格的.opencodereview/rule.json,即可按路径注入团队规范:
{ "rules": [ { "path": "src/api/**/*.go", "rule": "所有导出的 handler 必须先校验请求体" }, { "path": "**/*mapper*.xml", "rule": "检查 SQL 注入风险、参数错误与未闭合标签" } ] }内置系统规则集已按语言分门别类(Go、Java、Python、TS/JS 等 40+ 类),文档见 review-rules.md,规则示例库在 rule_docs/。项目级规则可安全提交进仓库——规则即团队规范的一部分。
进阶:接入 CI,让 PR 自动过 AI 代码评审
仓库自带 ocr-review.yml 工作流模板与可复用 action.yml,覆盖 GitHub Actions、GitLab CI、GitLab/Gerrit 等场景(示例见 examples/):
- 把
ocr-review.yml拷入.github/workflows/; - 在仓库 Secrets 配置
OCR_LLM_URL、OCR_LLM_AUTH_TOKEN,Variables 配置OCR_LLM_MODEL、OCR_LLM_USE_ANTHROPIC; - PR 打开/更新即自动评审,行内评论 + 汇总评论直接贴到 PR 上,还支持在 PR 评论
/open-code-review按需重审。
Action 支持 sticky 汇总评论、增量评论、checkpoint 断点评审等能力,细节见 action.yml。
编辑器与编码 Agent 集成
- VS Code 扩展:侧边栏发起评审、实时流式日志、评审意见可直接 Apply / 忽略 / 标记误报,源码在 extensions/vscode/;
- Claude Code / Codex / Cursor 插件:提供评审斜杠命令与可移植 Skill,见 plugins/open-code-review/;
- 委托模式(Delegation Mode):
ocr delegate preview让宿主 Agent 用自己的模型跑评审,OCR 只负责文件筛选与规则解析——团队成员无需再配一份 API Key,这是降低推广阻力最实用的一招。
常见问题
| 问题 | 解答 |
|---|---|
| 不配 LLM 能用吗? | 可以,走委托模式由宿主 Agent 提供模型 |
| 数据会出公司吗? | 端点完全可配,可指向自托管 vLLM / Ollama,数据不出内网 |
| 评审太贵怎么办? | 精确率优先设计,Token 约为通用 Agent 的 1/9;--preview可先看筛选结果再决定 |
| 怎么卸载? | npm uninstall -g并删除~/.opencodereview/目录即可 |
更多细节参考 FAQ 与 CLI 完整参数。
总结
30 分钟后,你的团队将拥有:一条命令的本地评审、可按路径定制的规则体系、CI 自动 PR 评审、以及浏览器可回放的评审会话。open-code-review 用确定性管线锁住"不出错"的底线,把 Agent 的精力留给真正的深度评审——这正是它能从阿里内部大规模实战中沉淀出来、并被开发者真正采纳的原因。
【免费下载链接】open-code-reviewFast, efficient, battle-tested at Alibaba's scale. Hybrid architecture code review tool: deterministic pipelines + LLM Agent, precise line-level comments, built-in multi-language ruleset (NPE, thread-safety, XSS, SQL injection), OpenAI & Anthropic compatible.项目地址: https://gitcode.com/GitHub_Trending/op/open-code-review
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考