# @alibaba-group/open-code-review 中文文档

规范地址：https://npmcn.com/package/%40alibaba-group/open-code-review/

版本：1\.13\.6
npm 元数据更新时间：2026-11-05T11:53:19.126Z
中文译文更新时间：2026-11-05T17:24:34.363Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40alibaba-group/open-code-review
原文对照：https://npmcn.com/package/%40alibaba-group/open-code-review/?lang=original
项目主页：https://github.com/alibaba/open-code-review#readme
源码仓库：https://github.com/alibaba/open-code-review

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：2.6 MB，21 个文件
- TypeScript 类型：未声明
- Node.js 要求：\>=14
- 运行依赖：0 个
- 首次发布：2026-05-21T06:49:32.646Z
- 最新版本发布：2026-11-05T11:53:18.722Z
- 近 30 天下载量：554324（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：133（近 12 个月 133 个）

## 中文简介

OpenCodeReview CLI — AI动力代码审查工具

## 安装

```sh
npm install @alibaba-group/open-code-review
```

也可以使用：`pnpm add @alibaba-group/open-code-review`、`yarn add @alibaba-group/open-code-review`、`bun add @alibaba-group/open-code-review`

## README

[![OpenCodeReview logo](https://npmcn.com/package/%40alibaba-group/open-code-review/imgs/logo-core.svg)](https://open-codereview.ai/)

# 打开代码审查

[![alibaba%2Fopen-code-review | Trendshift](https://trendshift.io/api/badge/repositories/41087)](https://trendshift.io/repositories/41087?utm_source=repository-badge&utm_medium=badge&utm_campaign=badge-repository-41087)

 [![alibaba%2Fopen-code-review | Trendshift](https://trendshift.io/api/badge/trendshift/repositories/41087/weekly)](https://trendshift.io/repositories/41087)[![alibaba%2Fopen-code-review | Trendshift](https://trendshift.io/api/badge/trendshift/repositories/41087/monthly?language=Go)](https://trendshift.io/repositories/41087)

[![npm](https://img.shields.io/npm/v/@alibaba-group/open-code-review?style=flat-square)](https://www.npmjs.com/package/@alibaba-group/open-code-review) [![Build status](https://img.shields.io/github/actions/workflow/status/alibaba/open-code-review/release.yml?style=flat-square)](https://github.com/alibaba/open-code-review/actions/workflows/release.yml) [![License](https://img.shields.io/github/license/alibaba/open-code-review?style=flat-square)](https://github.com/alibaba/open-code-review/blob/main/LICENSE) [![Ask DeepWiki](https://img.shields.io/badge/Ask-DeepWiki-blue?style=flat-square)](https://deepwiki.com/alibaba/open-code-review) [![OpenSSF Best Practices](https://img.shields.io/badge/OpenSSF-Gold-D4AF37?style=flat-square)](https://www.bestpractices.dev/projects/13328)

[![Windows](https://img.shields.io/badge/Windows-supported-blue.svg)](https://npmcn.com/package/%40alibaba-group/open-code-review/#readme-supported-platforms) [![macOS](https://img.shields.io/badge/macOS-supported-blue.svg)](https://npmcn.com/package/%40alibaba-group/open-code-review/#readme-supported-platforms) [![Linux](https://img.shields.io/badge/Linux-supported-blue.svg)](https://npmcn.com/package/%40alibaba-group/open-code-review/#readme-supported-platforms) [![Claude Code](https://img.shields.io/badge/Claude_Code-supported-blueviolet.svg)](https://npmcn.com/package/%40alibaba-group/open-code-review/#readme-supported-agents) [![Codex](https://img.shields.io/badge/Codex-supported-blueviolet.svg)](https://npmcn.com/package/%40alibaba-group/open-code-review/#readme-supported-agents) [![Cursor](https://img.shields.io/badge/Cursor-supported-blueviolet.svg)](https://npmcn.com/package/%40alibaba-group/open-code-review/#readme-supported-agents) [![Kimi Code](https://img.shields.io/badge/Kimi_Code-supported-blueviolet.svg)](https://npmcn.com/package/%40alibaba-group/open-code-review/#readme-supported-agents)

页:1 [简体中文](https://npmcn.com/package/%40alibaba-group/open-code-review/docs/i18n/README.zh-CN.md) | [日本語](https://npmcn.com/package/%40alibaba-group/open-code-review/docs/i18n/README.ja-JP.md) | [한국어](https://npmcn.com/package/%40alibaba-group/open-code-review/docs/i18n/README.ko-KR.md) | [Русский](https://npmcn.com/package/%40alibaba-group/open-code-review/docs/i18n/README.ru-RU.md)

* * *

## 什么是公开代码评论?

Open Code Review是一个由AI驱动的代码审查CLI工具. 它起源于阿里巴巴集团的内部官方AI代码审查助理——在过去两年中,它为上万开发者服务并查明了上百万个代码缺陷. 经过大规模的彻底验证后,我们把它孵化成一个面向社区的开源项目. 只需配置一个模式端点即可启动 .

它读取了Git diffs,通过具有工具使用能力的代理将已修改的文件发送到可配置的LLM,并以行级精度生成结构化的评论. 代理可以读取完整的文件内容,搜索代码库,检查其他已更改的文件以了解上下文,并产生深层评论——而不仅仅是表层diff反馈. 除了评论之外, `ocr scan` 审查所有文件,以审计不熟悉的代码库或目录,这些目录没有意义.

访问 [官方网站 (简体中文)](https://open-codereview.ai/) 更多细节.

![Highlights](https://npmcn.com/package/%40alibaba-group/open-code-review/imgs/highlights-en.png)

## 基准

> 与通用制剂(Claude Code)相比,开放码审查的成绩要高得多 **精确度** 财务报告和审定财务报表 **F1 导弹** 使用相同的基本模型,但只消耗 **~1/9 个符号** 并更快地完成审查。 请注意,它的召回比普通用途剂要低——这是有意取舍,有利于精确而不是噪声.

以 **第50条** 流行的开源存储器, **200个** 真实拉动请求,以及 **10个** 编程语言——由80多位高级工程师交叉认证(**1 505个** 附加说明的地面真相问题).

 [![Hugging Face](https://huggingface.co/favicon.ico) 探索 Hugging Face 上的 AACR- Bench 数据集](https://huggingface.co/datasets/Alibaba-Aone/aacr-bench)。 。 。 .

| 度量衡 | 它测量什么 | 为什么这很重要 |
| --- | --- | --- |
| **F1 导弹** | 精确和召回的谐音 | 总体审查质量的最佳单数 |
| **精确度** | 报告的实际缺陷问题比例 | 较高 = 分解的假警报减少 |
| **回顾** | 发现的实际缺陷比例 | 较高 = 审查后出现的问题较少 |
| **Avg 时间** | 每次审查时长 | CI管道延迟的事项 |
| **Avg 托肯语Name** | 每次审查消费的证券总额 | 直接影响 API 成本 |

![Benchmark](https://npmcn.com/package/%40alibaba-group/open-code-review/imgs/benchmark-en.png)

## 为什么是公开代码评论?

### 通用代理人的问题

如果你使用通用的特工 比如Claude Code和Speechs 来进行代码审查 你可能会遇到这些疼痛点:

-   **覆盖面不完全** ——关于更大型的更动器,代理商往往会"割角",有选择地只审查一些文件而缺少其他文件.
-   **位置漂移** ——被报道的问题往往与实际的代码位置不相匹配,与行号或文件参考文献漂移出目标.
-   **质量不稳定** ——自然语言驱动的"技能"很难调试,审查质量有显著起伏并有轻微的即时变化.

根本原因:纯粹由语言驱动的架构对审查过程缺乏严格的制约.

### 核心设计:定型工程×代理混合

Open Code Review的核心理念是将定型工程与一个代理结合,每个代理都处理它最擅长的工作.

**决定性工程——硬制约因素**

用于审查步骤 _千万别出错_,工程逻辑——而不是语言模型——保证正确性:

-   **精确文件选择** ——准确确定哪些文件需要审查,哪些文件应当过滤,确保不会错过重要更改.
-   **智能文件捆绑** ——将相关文件分组为一个审查单位(如:, `message_en.properties` 财务报告和审定财务报表 `message_zh.properties` 被捆绑在一起。 每个捆绑作为子代理运行,背景孤立——一种分而相之的策略,在非常大的变化中保持稳定,并自然支持同时审查.
-   **精细规则匹配** ——将审查规则与每个文件的特性相匹配,使模型的注意力集中,并消除了源头的信息噪声. 与纯粹由语言驱动的规则指导相比,基于模板引擎的规则比对更加稳定和可预测.
-   **外部定位和反射模块** ——独立评论定位和评论反射模块系统提高AI反馈的位置准确度和内容准确度.

**代理-动态决策**

代理人的长处集中在最重要的地方——动态决定和动态上下文检索:

-   **情景调整的提示** ——快速模板深度优化代码审查,提高有效性并同时减少象征性消费.
-   **情景调整工具集** ——从深入分析大型生产数据中的工具调用痕迹——包括调用频率分布,每个工具的重复率,以及新工具对整个调用链的影响——中消退出,形成一个专用工具箱,比通用代理工具箱更稳定,更能预测代码审查.

## 如何使用

### 先决条件

-   **基特 >= 2.41** ——Open Code Review依赖Git进行diff生成,代码搜索,以及寄存器操作.

### 国 际

#### 安装

```bash
npm install -g @alibaba-group/open-code-review
```

安装后 `ocr` 命令可在全球范围内使用.

其他安装方法(安装脚本, GitHub Release 二进制, 来源) 见 [安装](https://open-codereview.ai/docs/installation)。 。 。 .

#### 快速启动

**1\. 配置 LLM**

您在检查代码前必须配置 LLM, 除非您使用 [代表团模式](https://open-codereview.ai/docs/delegate)。 。 。 .

```bash
ocr config provider          # Select a built-in provider or add a custom one
ocr config model             # Pick a model for the active provider
```

![Provider setup](https://npmcn.com/package/%40alibaba-group/open-code-review/imgs/providers.jpg)

交互式UI通过提供者选择,API密钥条目和模型配置来引导您,然后自动测试连接性.

关于CLI设置,环境变量,自定义提供者等高级配置,参见: [配置](https://open-codereview.ai/docs/configuration)。 。 。 .

**2\. 审查**

```bash
cd your-project

# Workspace mode — review all staged, unstaged, and untracked changes
ocr review

# Branch range — reviews feature-branch's changes since it diverged from main (merge-base mode)
ocr review --from main --to feature-branch

# Single commit
ocr review --commit abc123

# Resume an interrupted range or commit review
ocr session list
ocr review --from main --to feature-branch --resume <session-id>

# Full-file scan — review whole files instead of a diff (no git history needed)
ocr scan                          # scan the entire repository
ocr scan --path internal/agent    # scan a directory or specific files
ocr scan --resume <session-id>   # resume an interrupted full-file scan

# Save results to a file (recommended for AI host agents)
ocr review --format json --output result.json

# Delegation mode — let your AI coding agent perform the review itself
# OCR handles file selection and rule resolution; no LLM configuration needed
ocr delegate preview
ocr delegate rule src/main.go src/handler.go
```

## 文档

完整文档生活于 **[开放代码审查.ai/docs](https://open-codereview.ai/docs)**数字 :

-   [快速启动](https://open-codereview.ai/docs/quickstart) 安装和运行您的第一次审查
-   [安装](https://open-codereview.ai/docs/installation) ——所有平台和软件包管理器
-   [CLI 参考](https://open-codereview.ai/docs/cli-reference) 每个命令和旗帜
-   [审查规则](https://open-codereview.ai/docs/review-rules) ——自定义审查规则,并设置路径过滤和定向
-   [配置](https://open-codereview.ai/docs/configuration) ——配置密钥和环境变量
-   [MCP 服务器](https://open-codereview.ai/docs/mcp) 利用外部工具扩展审查代理
-   编码代理集成——选择您使用的平台
    -   [克劳德代码](https://npmcn.com/package/%40alibaba-group/open-code-review/plugins/open-code-review/README.md#claude-code) ——安装带有审查斜线命令的插件
    -   [代码](https://npmcn.com/package/%40alibaba-group/open-code-review/plugins/open-code-review/README.md#codex) ——安装具有可调用审查技能的插件
    -   [光标](https://npmcn.com/package/%40alibaba-group/open-code-review/plugins/open-code-review/README.md#cursor) ——安装具有可移植审查技能的插件
    -   [基米码](https://npmcn.com/package/%40alibaba-group/open-code-review/plugins/open-code-review/README.md#kimi-code) ——安装带有审查斜线命令和技能的插件
    -   [打开代码](https://npmcn.com/package/%40alibaba-group/open-code-review/plugins/open-code-review/opencode/README.md) 安装本地审查工具和斜线命令
    -   [QCA 前进](https://npmcn.com/package/%40alibaba-group/open-code-review/plugins/open-code-review/qca/README.md) 使用 QCA 主机模式和现成的模板运行授权模式
    -   [符合技能的代理人](https://open-codereview.ai/docs/agent-skill) 安装便携式代理技术
-   审查执行模式——整合后,选择哪个LLM进行审查
    -   [默认( OCR 管理)](https://open-codereview.ai/docs/configuration) ——OCR使用所配置的 LLM 运行审查
    -   [代表团模式](https://open-codereview.ai/docs/delegate) —— 您的编码代理使用自己的 LLM 运行审查; 没有需要 OCR API 密钥
-   [CI/CD 一体化](https://open-codereview.ai/docs/cicd) - GitHub Actions、GitLab CI、GitFlic CI和Gerrit整合
-   [会话查看器](https://open-codereview.ai/docs/viewer) ——浏览并重放浏览器中的审查会话,将评论标为固定或被忽略并隐藏在您通过结果工作时
-   [遥测](https://open-codereview.ai/docs/telemetry) ——可观察性开阔几何集成
-   [财务问题](https://open-codereview.ai/docs/faq) - 常见问题和解决问题

## 捐款

这个项目的存在要归功于所有作出贡献的人。 见 [捐款额](https://npmcn.com/package/%40alibaba-group/open-code-review/CONTRIBUTING.md) 用于开发设置、编码指南,以及如何提交拉动请求.

[![](https://contrib.rocks/image?repo=alibaba/open-code-review)](https://github.com/alibaba/open-code-review/graphs/contributors)

## 许可证

[阿帕奇 - 2.0](https://npmcn.com/package/%40alibaba-group/open-code-review/LICENSE) ——版权2026 Alibaba

## 常见问题

### @alibaba-group/open-code-review 是什么？

OpenCodeReview CLI — AI动力代码审查工具

### 如何安装 @alibaba-group/open-code-review？

在项目目录运行 npm install @alibaba-group/open-code-review，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 ocr，可以用 npx ocr 直接运行。

### @alibaba-group/open-code-review 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/alibaba-group\_\_open-code-review 是否存在。

### @alibaba-group/open-code-review 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=14。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @alibaba-group/open-code-review 可以商用吗？

@alibaba-group/open-code-review 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @alibaba-group/open-code-review 的下载量有多少？

根据 npm 官方下载统计，@alibaba-group/open-code-review 在 2026/10/06 – 2026/11/04 这 30 天内被下载 554,324 次，日均约 18,477 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @alibaba-group/open-code-review 还在维护吗？

最新版本 1\.13\.6 发布于 2026/11/05（今天）；至今共发布 133 个版本，其中过去 12 个月发布了 133 个；首次发布于 2026/05/21。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。