项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-11-10 · 当前星标 ★ 49715
使用教程
环境要求
- 已安装 Node.js 与 npm(用于全局安装 npm 包)
- 具备 npm 全局安装权限(或可写入全局 bin 目录)
- 一个可用的 LLM 服务(兼容 OpenAI 或 Anthropic 接口)及对应 API Key
- 本地已克隆待审查的代码仓库
安装与启动步骤
-
1安装命令行工具
使用 npm 全局安装官方包,安装完成后 ocr 命令可直接在终端调用。
npm install -g @alibaba-group/open-code-review -
2配置模型提供方
执行后进入交互界面,选择内置提供方或自定义提供方,并按提示填写 API Key。
ocr config provider -
3选择模型
为当前启用的提供方指定具体模型,交互界面会自动测试连通性。
ocr config model -
4进入项目目录
切换到需要审查的代码仓库根目录,后续命令都在此目录下执行。
cd your-project -
5预览审查结果
OCR 自动完成文件选择与规则解析,先输出预览,便于确认范围是否符合预期。
ocr delegate preview -
6对指定文件跑规则
传入具体文件路径,只对这些文件应用规则检查并给出评论。
ocr delegate rule src/main.go src/handler.go
关键配置
| 配置项 | 必填 | 说明 | 示例 |
|---|---|---|---|
provider | 是 | 指定调用哪个模型服务商,可选内置项或自定义。 | openai |
model | 是 | 指定当前提供方下用于审查的具体模型。 | gpt-4o-mini |
API Key | 是 | 调用模型服务的凭据,在交互式配置中录入。 | sk-xxxxxxxx |
如何确认成功
配置模型时交互界面自动测试连通性并通过;运行 ocr delegate preview 能正常输出审查预览结果。
常见问题
Q:安装后提示找不到 ocr 命令怎么办?
A:确认 npm 全局 bin 目录已加入系统 PATH,重新打开终端后再试;必要时检查全局安装是否成功。
Q:必须配置 LLM 才能用吗?
A:使用 ocr review 等由 OCR 自己调模型的命令必须先配置;delegate 系列命令走宿主 agent 已配置的模型,无需在 OCR 中另配凭据。
Q:delegate 和普通 review 有什么区别?
A:review 使用 OCR 自身的提供方配置与认证;delegate-review 使用宿主 agent 的模型与认证,不再单独配置。
Q:还有别的安装方式吗?
A:README 提到还有安装脚本、GitHub Release 二进制和源码编译等方式,详见官方 Installation 文档。
注意事项
- 配置过程是交互式的,会引导完成提供方选择、API Key 录入与模型配置,并自动测试连通性。
- ocr review 使用 OCR 自己的提供方配置,不沿用宿主编辑器的团队或个人订阅登录。
- 命令中的文件路径请替换为你仓库中的真实文件。
- 更多高级配置(环境变量、自定义提供方)见官方 Configuration 文档。
核心亮点
- 确定性流水线与 LLM Agent 分工明确,规则检查结果稳定可复现,模型只做上下文理解和解释,降低误报波动
- 内置多语言规则集覆盖 NPE、线程安全、XSS、SQL 注入等高频缺陷,开箱即可用
- 支持行级精确评论,可直接对接代码托管平台的评审流程
不足之处
- LLM 环节依赖外部模型服务,离线或私有化部署需要自行准备兼容接口
- 规则集以常见缺陷为主,特定业务框架的深度规则需自行扩展
- 文档与社区生态相对新,二次开发资料待观察
适用场景
- CI 流水线中自动审查 Pull Request 并输出行级评论
- 团队代码合并前做安全缺陷扫描,拦截注入类问题
- 接入自有模型服务,为内部代码库提供仓库级上下文的审查建议
替代项目
reviewdog、SonarQube、Semgrep
下一篇:CometixCode
同类项目推荐
harmony-next.skills
开源
让 AI 助手离线学会鸿蒙开发,问答即出代码
Offline HarmonyOS NEXT developer skill library for AI coding assistants. Covers API ···
ai-code-helper
开源
跟着实战学 AI 编程,从入门到企业级应用开发
2025 年 AI 编程助手实战项目(作者:程序员鱼皮),基于 Spring Boot 3.5 + Java 21 + La···
repo2txt
开源
一键把 GitHub 仓库变成单个文本,直接喂给 AI 助手。
Web-based tool converts GitHub repository contents into a single formatted text file
twinny
开源
VS Code 里免费用 AI 补全和对话,本地模型也能跑
Open-source AI coding assistant for VS Code. Coding agent, code completion, chat, ed···
claude-ctrl
开源
早期浏览器自动化操控 Claude 的脚本工具,现已废弃
DEPRECATED / UNMAINTAINED — historical reference only. Do not install or rely on th···
code_puppy
开源
说句话,AI 代理自己动手把代码写完
Agentic AI for writing code
claudecode-best-practices
开源
照着做,让 Claude Code 干活更顺手
A collection of best practices and procedures for using Claude Code
Brokies-AI-Foundry
开源
一份清单,帮你挑免费AI开发工具,省时省力
Top Free AI Developer Tools for 2026
awesome-ai-plugins
开源
一站式找全 AI 编程助手插件,告别大海捞针
A curated list of the best awesome AI plugins for AI assistants including Claude Cod···
