open-code-review 快速上手从安装 CLI 到跑通第一次 AI 代码评审【免费下载链接】open-code-reviewFast, efficient, battle-tested at Alibabas 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-reviewCLI 命令ocr的官方快速入门文档为主线带你用几分钟时间完成一次真实的 AI 代码评审先安装 CLI、再配置 LLM 提供方与模型、验证连通性最后以工作区、分支区间、单个提交三种模式跑通ocr review并掌握--preview预览与--format json机器可读输出等关键实操技能。读完你即可在本地仓库、CI 脚本乃至 Agent 工作流中直接复用这些命令。前置要求在开始之前请确认环境满足以下条件依赖要求说明Git≥ 2.41ocr review依赖 Git 解析 diff、计算 merge-base、读取工作区改动Node.js≥ 18使用推荐的 NPM 方式安装 CLI 时需要LLM API Key视模式而定使用普通模式评审时必须若使用委派模式例如在 Claude Code 内部运行模型由宿主 Agent 提供无需配置 API Key可直接跳到第四步快速验证 Git 与 Node 版本git --version node --version第一步安装 CLI最推荐的方式是通过 NPM 全局安装npm install -g alibaba-group/open-code-review安装完成后用version子命令确认可执行文件已就位ocr version该命令会打印构建时写入的版本号、Git 短提交、平台GOOS/GOARCH与构建日期。若输出command not found请检查安装目录是否在$PATH中which ocr、echo $PATH。除 NPM 外项目还支持 Homebrewbrew install open-code-review、MacPorts、curl | sh安装脚本、GitHub Release 静态二进制以及make build源码构建等多种安装方式通过 NPM 安装时ocr默认还会在后台自动检查并升级可用OCR_NO_UPDATE关闭、OCR_UPDATE_INTERVAL调整检查间隔。完整清单与状态目录说明见安装指南。数据存储位置OCR 的配置与评审记录统一存放在~/.opencodereview/目录下其中~/.opencodereview/config.json—— LLM 端点、语言等全局配置由ocr config set管理~/.opencodereview/sessions/编码后的仓库路径/session-id.jsonl—— 每次评审的流式 JSONL 会话记录供ocr viewer回放仓库/.opencodereview/rule.json—— 可提交进仓库的项目级评审规则。第二步配置 LLM如果你使用委派模式例如运行在 Claude Code、Codex 等订阅制 AI 编码 Agent 内宿主 Agent 自带模型额度OCR 侧不会发起任何 LLM 调用无需执行本节直接跳到第四步。交互式配置推荐运行ocr config provider该命令会启动交互式 TUI你可以从内置提供方列表或自定义提供方中选择一个输入 API Key、选定模型命令随后将全部配置写入~/.opencodereview/config.json并自动执行一次ocr llm test验证端点可用。之后想更换模型无需重走整个流程ocr config model非交互式配置CI / 无 TUI 环境在 CI 流水线或没有终端交互界面的环境中用ocr config set直接写入同样的配置键ocr config set provider anthropic ocr config set model claude-opus-4-6 ocr config set providers.anthropic.api_key sk-ant-xxxxxxxxxx从源码实现看cmd/opencodereview/config_cmd.goconfig set支持provider、model、max_tokens、effort、providers.name.field、custom_providers.name.field、mcp_servers.name.field、llm.*、language、telemetry.*等键其中api_key/auth_token类密钥在回显时会被自动脱敏shouldMaskConfigValue避免密钥泄露到终端日志。OCR 内置了anthropic、openai、openai-responses、gemini、dashscope、deepseek、kimi、minimax、baidu-qianfan、siliconflow、xai、bedrock等二十余个提供方Base URL 与协议均已预置选中后只需补 API Key若providers.name.api_key未设置OCR 会回退读取对应的环境变量如ANTHROPIC_API_KEY、OPENAI_API_KEY。完整提供方表格、自定义提供方custom_providers.*需至少提供url与protocol、AWS Bedrock 签名认证、api_key_cmd密钥命令等进阶配置见配置指南。第三步验证 LLM 连通性ocr llm test该命令与ocr review使用完全相同的端点解析逻辑cmd/opencodereview/llm_cmd.go加载配置 → 解析端点 → 发送一次固定的短对话请求然后打印解析来源、URL、生效模型与模型回复最后输出✓ Connection test successful。常见报错排查no valid LLM endpoint configured—— 端点未解析成功请回头检查第二步的配置是否完整provider / model / api_key 是否齐全HTTP401 / 403—— API Key 错误或已过期请更换密钥后重试。第四步运行第一次代码评审进入任意 Git 仓库目录即可开始评审cd path/to/your-repo # 工作区模式默认评审暂存 未暂存 未跟踪的全部本地改动 ocr review # 分支区间评审 feature-branch 相对 main 引入的改动基于 merge-base 计算 ocr review --from main --to feature-branch # 单个提交评审 abc123 这个提交引入的 diff ocr review --commit abc123三种模式的语义在源码中有明确对应cmd/opencodereview/review_cmd.go 的reviewModeFromOptions模式判定条件底层行为工作区默认不带--from/--to/--commit用git diff HEAD汇总已跟踪文件的改动若为空则回退git diff --staged用git ls-files --others --exclude-standard收集未跟踪新文件并当作整文件新增读取分支区间同时指定--from与--to计算merge-base(from, to)..to只评审该分支自身引入的改动不掺入main上后来新增的无关变更单个提交指定--commit别名-c评审git show commit产生的 diff模式互斥--from/--to与--commit混用属于硬错误。此外出于安全考虑issue #112所有 ref 参数都会先经过校验validateReviewRefsref 不能以-开头、必须是真实的 commit refgit rev-parse --verify ref^{commit}防止在 git 子进程调用中注入任意选项。完整评审流程是解析 Git diff → 用一次轻量元数据调用把改动文件按语义分组成文件组如 handler service test 归入同一组→ 为每个组派发一个子 Agent按--concurrency默认 8 并行→ 收集评论并按--format输出。--concurrency、--timeout、--effort、--max-tokens、--background需求上下文等全部ocr review旗标与其余子命令见CLI 参考手册。先预览哪些文件会进入评审评审真正调用 LLM 之前可以先跑过滤管线预览文件清单与排除原因ocr review --preview # 工作区改动预览 ocr review -c abc123 --preview # 单个提交预览-c 是 --commit 的短别名--preview只执行过滤管线、跳过 LLM源码路径为 runPreviewContext →agent.Preview支持--format json由于没有完成的评审结论不支持--format sarif。面向系统的 JSON 输出--audience agent会隐藏面向人类的进度界面让标准输出stdout上只剩 JSON 文档与最终摘要——这正是上游 Agent 或 CI 脚本想要的纯净格式ocr review --format json --audience agent review.jsonJSON 文档顶层字段包括statussuccess/completed_with_warnings/completed_with_errors/skippedllm实际解析到的提供方与模型summaryfiles_reviewed、comments、total_tokens、input_tokens、output_tokens、elapsed等运行聚合comments按文件路径、行号区间start_line/end_line、原始代码与建议代码suggestion_code结构化的评论数组warnings可选部分子 Agent 失败时的逐文件错误说明session_id可选持久化会话 ID可用于--resume断点续跑。细节提示--format json单独使用时[ocr]进度行会走stderr因此你仍可以ocr review --format json | jq .summary边观察进度边解析标准输出只有再加上--audience agent或 shell 层2/dev/null才会彻底静音进度。常见问题速查评审前如何确认改动范围用ocr review --preview或-c sha -p先看文件清单与排除原因确认无误再正式评审。如何把评审交给 Agent / CI 消费用ocr review --format json --audience agent review.json标准输出只含 JSON且已包含session_id便于追溯。想要更严格或更省成本的评审用--effort low|medium|high调节每组的评审轮数默认medium 2 轮或用ocr config set effort high持久化--background 需求描述是提升评审质量性价比最高的旗标之一。评审中途被打断区间与提交模式可用ocr session list找到会话再用ocr review --from main --to feature-branch --resume session-id断点续跑工作区模式不支持 resume且 resume 会严格校验输入一致性。不想给 OCR 配模型走委派模式OCR 只做文件筛选与规则解析等确定性工程评审推理由宿主 Agent 完成OCR 侧零 LLM 配置。进一步阅读安装指南全部安装方式与 OCR 数据目录说明。配置指南全部环境变量、配置键与内置提供方。CLI 参考手册全部子命令、旗标与输出模式。评审规则自定义评审什么内容进入评审范围。集成指南把 OCR 嵌入 Claude Code、Agent Skill 或 CI。FAQ已知错误与解决办法。【免费下载链接】open-code-reviewFast, efficient, battle-tested at Alibabas 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），仅供参考 open-code-review 快速上手：从安装 CLI 到跑通第一次 AI 代码评审
open-code-review 快速上手从安装 CLI 到跑通第一次 AI 代码评审【免费下载链接】open-code-reviewFast, efficient, battle-tested at Alibabas 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-reviewCLI 命令ocr的官方快速入门文档为主线带你用几分钟时间完成一次真实的 AI 代码评审先安装 CLI、再配置 LLM 提供方与模型、验证连通性最后以工作区、分支区间、单个提交三种模式跑通ocr review并掌握--preview预览与--format json机器可读输出等关键实操技能。读完你即可在本地仓库、CI 脚本乃至 Agent 工作流中直接复用这些命令。前置要求在开始之前请确认环境满足以下条件依赖要求说明Git≥ 2.41ocr review依赖 Git 解析 diff、计算 merge-base、读取工作区改动Node.js≥ 18使用推荐的 NPM 方式安装 CLI 时需要LLM API Key视模式而定使用普通模式评审时必须若使用委派模式例如在 Claude Code 内部运行模型由宿主 Agent 提供无需配置 API Key可直接跳到第四步快速验证 Git 与 Node 版本git --version node --version第一步安装 CLI最推荐的方式是通过 NPM 全局安装npm install -g alibaba-group/open-code-review安装完成后用version子命令确认可执行文件已就位ocr version该命令会打印构建时写入的版本号、Git 短提交、平台GOOS/GOARCH与构建日期。若输出command not found请检查安装目录是否在$PATH中which ocr、echo $PATH。除 NPM 外项目还支持 Homebrewbrew install open-code-review、MacPorts、curl | sh安装脚本、GitHub Release 静态二进制以及make build源码构建等多种安装方式通过 NPM 安装时ocr默认还会在后台自动检查并升级可用OCR_NO_UPDATE关闭、OCR_UPDATE_INTERVAL调整检查间隔。完整清单与状态目录说明见安装指南。数据存储位置OCR 的配置与评审记录统一存放在~/.opencodereview/目录下其中~/.opencodereview/config.json—— LLM 端点、语言等全局配置由ocr config set管理~/.opencodereview/sessions/编码后的仓库路径/session-id.jsonl—— 每次评审的流式 JSONL 会话记录供ocr viewer回放仓库/.opencodereview/rule.json—— 可提交进仓库的项目级评审规则。第二步配置 LLM如果你使用委派模式例如运行在 Claude Code、Codex 等订阅制 AI 编码 Agent 内宿主 Agent 自带模型额度OCR 侧不会发起任何 LLM 调用无需执行本节直接跳到第四步。交互式配置推荐运行ocr config provider该命令会启动交互式 TUI你可以从内置提供方列表或自定义提供方中选择一个输入 API Key、选定模型命令随后将全部配置写入~/.opencodereview/config.json并自动执行一次ocr llm test验证端点可用。之后想更换模型无需重走整个流程ocr config model非交互式配置CI / 无 TUI 环境在 CI 流水线或没有终端交互界面的环境中用ocr config set直接写入同样的配置键ocr config set provider anthropic ocr config set model claude-opus-4-6 ocr config set providers.anthropic.api_key sk-ant-xxxxxxxxxx从源码实现看cmd/opencodereview/config_cmd.goconfig set支持provider、model、max_tokens、effort、providers.name.field、custom_providers.name.field、mcp_servers.name.field、llm.*、language、telemetry.*等键其中api_key/auth_token类密钥在回显时会被自动脱敏shouldMaskConfigValue避免密钥泄露到终端日志。OCR 内置了anthropic、openai、openai-responses、gemini、dashscope、deepseek、kimi、minimax、baidu-qianfan、siliconflow、xai、bedrock等二十余个提供方Base URL 与协议均已预置选中后只需补 API Key若providers.name.api_key未设置OCR 会回退读取对应的环境变量如ANTHROPIC_API_KEY、OPENAI_API_KEY。完整提供方表格、自定义提供方custom_providers.*需至少提供url与protocol、AWS Bedrock 签名认证、api_key_cmd密钥命令等进阶配置见配置指南。第三步验证 LLM 连通性ocr llm test该命令与ocr review使用完全相同的端点解析逻辑cmd/opencodereview/llm_cmd.go加载配置 → 解析端点 → 发送一次固定的短对话请求然后打印解析来源、URL、生效模型与模型回复最后输出✓ Connection test successful。常见报错排查no valid LLM endpoint configured—— 端点未解析成功请回头检查第二步的配置是否完整provider / model / api_key 是否齐全HTTP401 / 403—— API Key 错误或已过期请更换密钥后重试。第四步运行第一次代码评审进入任意 Git 仓库目录即可开始评审cd path/to/your-repo # 工作区模式默认评审暂存 未暂存 未跟踪的全部本地改动 ocr review # 分支区间评审 feature-branch 相对 main 引入的改动基于 merge-base 计算 ocr review --from main --to feature-branch # 单个提交评审 abc123 这个提交引入的 diff ocr review --commit abc123三种模式的语义在源码中有明确对应cmd/opencodereview/review_cmd.go 的reviewModeFromOptions模式判定条件底层行为工作区默认不带--from/--to/--commit用git diff HEAD汇总已跟踪文件的改动若为空则回退git diff --staged用git ls-files --others --exclude-standard收集未跟踪新文件并当作整文件新增读取分支区间同时指定--from与--to计算merge-base(from, to)..to只评审该分支自身引入的改动不掺入main上后来新增的无关变更单个提交指定--commit别名-c评审git show commit产生的 diff模式互斥--from/--to与--commit混用属于硬错误。此外出于安全考虑issue #112所有 ref 参数都会先经过校验validateReviewRefsref 不能以-开头、必须是真实的 commit refgit rev-parse --verify ref^{commit}防止在 git 子进程调用中注入任意选项。完整评审流程是解析 Git diff → 用一次轻量元数据调用把改动文件按语义分组成文件组如 handler service test 归入同一组→ 为每个组派发一个子 Agent按--concurrency默认 8 并行→ 收集评论并按--format输出。--concurrency、--timeout、--effort、--max-tokens、--background需求上下文等全部ocr review旗标与其余子命令见CLI 参考手册。先预览哪些文件会进入评审评审真正调用 LLM 之前可以先跑过滤管线预览文件清单与排除原因ocr review --preview # 工作区改动预览 ocr review -c abc123 --preview # 单个提交预览-c 是 --commit 的短别名--preview只执行过滤管线、跳过 LLM源码路径为 runPreviewContext →agent.Preview支持--format json由于没有完成的评审结论不支持--format sarif。面向系统的 JSON 输出--audience agent会隐藏面向人类的进度界面让标准输出stdout上只剩 JSON 文档与最终摘要——这正是上游 Agent 或 CI 脚本想要的纯净格式ocr review --format json --audience agent review.jsonJSON 文档顶层字段包括statussuccess/completed_with_warnings/completed_with_errors/skippedllm实际解析到的提供方与模型summaryfiles_reviewed、comments、total_tokens、input_tokens、output_tokens、elapsed等运行聚合comments按文件路径、行号区间start_line/end_line、原始代码与建议代码suggestion_code结构化的评论数组warnings可选部分子 Agent 失败时的逐文件错误说明session_id可选持久化会话 ID可用于--resume断点续跑。细节提示--format json单独使用时[ocr]进度行会走stderr因此你仍可以ocr review --format json | jq .summary边观察进度边解析标准输出只有再加上--audience agent或 shell 层2/dev/null才会彻底静音进度。常见问题速查评审前如何确认改动范围用ocr review --preview或-c sha -p先看文件清单与排除原因确认无误再正式评审。如何把评审交给 Agent / CI 消费用ocr review --format json --audience agent review.json标准输出只含 JSON且已包含session_id便于追溯。想要更严格或更省成本的评审用--effort low|medium|high调节每组的评审轮数默认medium 2 轮或用ocr config set effort high持久化--background 需求描述是提升评审质量性价比最高的旗标之一。评审中途被打断区间与提交模式可用ocr session list找到会话再用ocr review --from main --to feature-branch --resume session-id断点续跑工作区模式不支持 resume且 resume 会严格校验输入一致性。不想给 OCR 配模型走委派模式OCR 只做文件筛选与规则解析等确定性工程评审推理由宿主 Agent 完成OCR 侧零 LLM 配置。进一步阅读安装指南全部安装方式与 OCR 数据目录说明。配置指南全部环境变量、配置键与内置提供方。CLI 参考手册全部子命令、旗标与输出模式。评审规则自定义评审什么内容进入评审范围。集成指南把 OCR 嵌入 Claude Code、Agent Skill 或 CI。FAQ已知错误与解决办法。【免费下载链接】open-code-reviewFast, efficient, battle-tested at Alibabas 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），仅供参考