OpenCodeReview · 技术教程

OpenCodeReview · 技术教程

从 git diff 到行级精准的 AI 评审意见:把代码审查自动化

这本教程讲什么

本教程是阿里巴巴开源项目「OpenCodeReview(OCR)」的体系化中文教程。OCR 是一个 AI 代码审查 CLI 工具(ocr 命令),脱胎于阿里内部用了两年、审查过百万级缺陷的 AI 代码审查助手——它读 git diff,把变更文件发给可配置的 LLM agent,产出带行级精度的结构化评审意见。

它的核心价值是把「人工 code review」这件耗时、依赖经验、容易遗漏的事,变成可复现、可配置、可集成进 CI/CD 的自动化流程。

六章学习路径一览

本教程按「装起来 → 配好它 → 懂规则与架构 → 用工具 → 接工作流 → 进阶」的递进逻辑组织:

第 1 章 快速上手 ── 几分钟跑通第一次评审
   安装 · 配置 LLM · 第一次评审
        │
第 2 章 配置与命令行 ── 把工具调到顺手
   配置 · CLI 参考
        │
第 3 章 评审规则与架构 ── 它怎么知道哪里有缺陷(核心)
   评审规则 · 架构
        │
第 4 章 工具、MCP 与会话 ── 扩展能力与回看
   工具 · MCP 服务器 · 会话查看器 · 遥测
        │
第 5 章 集成与工作流 ── 接进你的开发链路
   Agent Skill · Claude Code 插件 · CI/CD · 委托模式
        │
第 6 章 贡献与常见问题 ── 进阶与排错
   贡献 · FAQ
​

如果你只想快速试用,直接看第 1 章;想理解 OCR 为什么能审出缺陷,重点看第 3 章;想接进 CI 或 Claude Code,看第 5 章。

章节目录

第 1 章 快速上手
安装 CLI(npm 全局安装)、配置 LLM provider、测试连通性、运行第一次代码评审。读完你能把 OCR 跑起来并得到第一份评审报告。

第 2 章 配置与命令行
完整配置项(provider/model/api_key 等)、非交互式 ocr config set(CI 友好)、CLI 全部参数详解。读完你能把 OCR 调到适合自己项目的状态。

第 3 章 评审规则与架构(核心)
评审规则体系(OCR 内置的缺陷检测规则集)、整体架构(读 diff → 发 agent → 结构化意见)。读完你能解释「OCR 凭什么知道这里有缺陷」,并理解它的能力边界。

第 4 章 工具、MCP 与会话
agent 可用的工具、MCP 服务器(把 OCR 暴露给 MCP 客户端)、会话查看器(浏览器回看历次评审)、遥测。读完你能扩展 OCR 的能力并回看历史。

第 5 章 集成与工作流
Agent Skill(可移植技能包)、Claude Code 插件、CI/CD 集成(GitHub Actions/GitLab/Bitbucket 等)、委托模式(宿主 agent 提供模型,OCR 只管审查逻辑)。读完你能把 OCR 接进你的完整开发链路。

第 6 章 贡献与常见问题
如何贡献(规则、文档、插件)、FAQ 排错。读完你能参与社区并解决常见问题。

适合读者

本教程适合有代码审查需求、想用 AI 自动化的开发者与团队:

• 想在提交前快速过一遍常见缺陷的后端/前端工程师
• 负责团队代码质量、想接入 CI 的 DevOps / 平台工程师
• 用 Claude Code / Cursor 等 coding agent、想加上自动审查能力的开发者
• 对「AI 如何做代码审查」感兴趣、想读懂一个工业实现的人

前置知识:

• 基本的 Git 与命令行经验(能跑 git diff 和 CLI 命令)
• 一个 LLM API key(或使用委托模式,由宿主 agent 提供)
• Node.js ≥ 18

关于原文版本

本教程对照的原文来自阿里巴巴开源项目「OpenCodeReview」(MIT 协议)。原项目已提供完整的中文版文档,本教程在其基础上重组;若你使用的版本与本教程有差异,请以本地源码与原中文文档为最终依据。