open-code-review Codex 插件教程:对话式调用评审技能指南
【免费下载链接】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 Codex 插件教程,教你在 Codex 中通过对话式方式调用 open-code-review 的 AI 代码评审技能。open-code-review 是阿里巴巴开源的 AI 代码评审工具,采用"确定性流水线 + LLM Agent"混合架构,内置多语言评审规则(NPE、线程安全、XSS、SQL 注入等),可在 Codex 里用一句自然语言发起精准的行级代码评审。
一、Codex 插件架构:30秒理解工作原理
🔍 在动手安装前,先搞懂插件是怎么工作的——这能帮你快速排查问题:
Codex(对话入口) └─ Open Code Review 插件(评审技能) └─ 本地 ocr CLI(真正执行评审)三个关键点,避免常见误解:
- ✅ 插件不会替换Codex 自身的模型后端,它只是让 Codex 学会调用本地
ocr命令行; - ✅ 评审质量由 open-code-review 的确定性工程保障:精确文件选择、智能文件分组、细粒度规则匹配;
- ✅ Codex 只负责"听懂你的话",把"评审当前改动"这类请求翻译成正确的
ocr review命令。
二、一键安装:Codex 插件三步配置
第 1 步:安装 ocr CLI
所有集成都依赖本地的ocr命令(需要 Git ≥ 2.41):
npm install -g @alibaba-group/open-code-review command -v ocr && ocr version第 2 步:配置模型并测试连通性
open-code-review 支持 Anthropic、OpenAI 及多种兼容接口,交互界面会自动测试连通性(若使用委派模式可跳过此步):
ocr config provider ocr config model ocr llm test第 3 步:在 Codex 中添加插件市场并启用
codex plugin marketplace add alibaba/open-code-review codex启动后打开/plugins,安装并启用Open Code Review,插件即可暴露可调用的评审技能。如果你先克隆了本仓库(git clone https://gitcode.com/GitHub_Trending/op/open-code-review),也可以进入仓库目录执行codex plugin marketplace add .来本地测试。
插件总览见 plugins/open-code-review/README.md,Codex 专属说明见 CODEX.ko-KR.md。
三、对话式调用:3 种最常用的评审技能
安装完成后,在新会话中用@Open Code Review唤起技能即可:
| 你说的话 | 插件内部执行的命令 | 适用场景 |
|---|---|---|
@Open Code Review review my current changes | ocr review --audience agent | 评审工作区全部改动(已暂存/未暂存/未跟踪) |
@Open Code Review review this branch against main | ocr review --audience agent --from main --to <分支> | 分支对比,适合合并前检查 |
@Open Code Review review and fix high-confidence issues | 评审 + 自动修复高置信度问题 | 评审并修复,文件修改仅在明确请求时执行 |
💡小技巧:评审单个提交时,可以直接说"review commit abc123",插件会翻译为ocr review --audience agent --commit abc123;不确定会评审哪些文件时,可要求先--preview预览,不消耗任何模型调用。
评审结果按critical / high / medium / low四级严重度和 bug、security、performance 等分类输出,附带精确行号,便于 Codex 直接定位修复。
四、进阶玩法:自定义评审规则与委派模式
让评审更懂你的项目
open-code-review 按优先级解析评审规则:--rule参数 > 项目根目录.opencodereview/rule.json> 用户目录~/.opencodereview/rule.json> 内置系统默认规则。在项目中放一个 rule.json,就能为 Java、SQL 映射文件等指定专属检查项,详见 skills/open-code-review/SKILL.md 中的规则文件格式说明。
委派模式:不配置 LLM 也能跑
如果你希望"用 Codex 自己的模型来评审",可启用委派模式(Delegation Mode):open-code-review 只负责确定性的文件筛选与规则解析(ocr delegate preview/ocr delegate rule),实际评审由 Codex 完成,无需为 OCR 配置任何 API Key。完整技能定义见 skills/open-code-review-delegate/SKILL.md。
更多命令细节可查阅仓库内的官方文档:pages/src/content/docs/en/quickstart.md、pages/src/content/docs/en/review-rules.md。
五、避坑清单:新手最常踩的 3 个问题
- ❗
ocr: command not found—— Codex 找不到 CLI,回到"第 1 步"重装并确认ocr在全局 PATH 中; - ❗评审时报 LLM 连接错误—— 与插件无关,先单独执行
ocr llm test修复模型配置后再试,不要盲目重试; - ❗评审范围和预期不符——
ocr review只作用于当前目录的 Git 仓库,且工作区模式会包含未跟踪文件;想缩小范围就git add选择性暂存。
📌 大改动可能触发"规划阶段"(变更超 50 行时额外做风险分析),评审耗时略增但质量更高,属正常现象。
六、总结
回到本文开头的目标:open-code-review Codex 插件教程到此完成。整个流程只需三步——安装 CLI、配置模型、启用插件,之后在 Codex 中一句"review my current changes"即可得到行级精准、按严重度分组的 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
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考