OpenReview

一款开源、可自托管的 AI 代码审查机器人。部署到 Vercel，连接 GitHub 应用程序，即可获得由 Claude 提供支持的按需 PR 审查。

测试版：OpenReview 目前处于测试阶段。它最初是作为内部项目构建的，旨在帮助 Vercel 团队共同测试其技术。请做好应对不完善之处和可能破坏性变更的准备。

功能特性

• 按需审查 — 在任何 PR 评论中提及 @openreview 即可触发审查。由 Chat SDK 提供支持。
• 沙盒执行 — 在具有完整仓库访问权限的隔离 Vercel Sandbox 中运行，能够执行 linter、格式化工具和测试。
• 行级建议 — 发布带有 GitHub 建议块的行级评论，支持一键修复。
• 代码更改 — 可直接修复格式问题、linter 报错及简单 Bug，并提交推送到您的 PR 分支。
• 反应功能 — 使用 👍 或 ❤️ 表示批准建议，或使用 👎 或 😕 表示跳过。
• 持久工作流 — 基于 Vercel Workflow 构建，确保可靠且可恢复的执行。
• 可扩展技能 — 内置审查 skills，并支持通过 .agents/skills/ 添加自定义技能。
• 由 Claude 提供支持 — 通过 AI SDK 使用 Claude Sonnet 4.6 进行高质量的代码分析。
• 简单路由处理器 — 使用 Next.js 路由处理器 轻松定义自定义 API 端点和 Webhook 的路由处理逻辑。

工作原理

sequenceDiagram
    participant U as 开发者
    participant GH as GitHub
    participant WH as Webhook 处理器
    participant WF as Vercel 工作流
    participant SB as Vercel 沙盒
    participant AI as Claude 代理

    U->>GH: PR 评论中 @openreview
    GH->>WH: Webhook 事件
    WH->>WF: 启动工作流

    WF->>GH: 检查推送权限
    WF->>SB: 创建沙盒
    SB->>SB: 克隆 PR 分支上的仓库
    SB->>SB: 安装依赖
    SB->>SB: 配置 git

    WF->>AI: 使用 PR 上下文运行代理
    AI->>SB: 读取文件、运行 linter、探索代码
    SB-->>AI: 命令输出
    AI->>GH: 发布行内评论与建议
    AI-->>WF: 代理完成

    WF->>SB: 检查是否有未提交的更改
    alt 有更改
        WF->>SB: 提交并推送到 PR 分支
        SB->>GH: 推送更改
    end
    WF->>SB: 停止沙盒

    U->>GH: 对建议进行 👍 或 ❤️ 反应
    GH->>WH: 反应事件
    WH->>WF: 启动新的工作流运行

1. 在 PR 评论中提及 @openreview（可选附带具体指令）。
2. OpenReview 启动一个沙盒环境，并在 PR 分支上克隆仓库。
3. 由 Claude 提供支持的代理会审查差异、探索代码库并运行项目工具。
4. 代理将发现的结果以 PR 评论的形式发布，并附带行内建议。
5. 如果进行了更改（如格式修复、linter 修复等），这些更改会被提交并推送到分支。
6. 沙盒随后被清理。

设置步骤

1. 部署到 Vercel

点击上方按钮，或将此仓库克隆后部署到您的 Vercel 账户。

2. 创建 GitHub 应用程序

创建一个新的 GitHub 应用程序，配置如下：

Webhook URL：https://your-deployment.vercel.app/api/webhooks

仓库权限：

• 内容：读取与写入
• 问题：读取与写入
• 拉取请求：读取与写入
• 元数据：只读

订阅事件：

• 问题评论
• 拉取请求评审评论

生成私钥和 webhook 密钥，并记下您的应用 ID 和安装 ID。

3. 配置环境变量

将以下环境变量添加到您的 Vercel 项目中：

变量	描述
ANTHROPIC_API_KEY	Claude 的 API 密钥
GITHUB_APP_ID	您的 GitHub 应用程序 ID
GITHUB_APP_INSTALLATION_ID	您所监控仓库的安装 ID
GITHUB_APP_PRIVATE_KEY	为您的 GitHub 应用程序生成的私钥（换行符用 \n 表示）
GITHUB_APP_WEBHOOK_SECRET	您配置的 webhook 密钥
REDIS_URL	（可选）用于持久化状态的 Redis URL，若未设置则回退至内存存储

4. 安装 GitHub 应用程序

将 GitHub 应用程序安装到您希望 OpenReview 监控的仓库中。安装完成后，在任意 PR 评论中提及 @openreview 即可触发审查。

使用方法

触发审查：在任意 PR 上留言 @openreview。您还可以附带具体指令：

@openreview 检查安全漏洞
@openreview 运行 linter 并修复所有问题
@openreview 解释认证流程的工作原理

反应：对 OpenReview 的评论使用 👍 或 ❤️ 表示批准并应用其建议；使用 👎 或 😕 表示跳过。

技能

OpenReview 采用渐进式技能系统——代理仅在相关时加载特定指令，从而保持上下文聚焦并确保审查的彻底性。技能会在运行时从 .agents/skills/ 中自动发现。

内置技能

技能	描述
next-best-practices	文件规范、RSC 边界、数据模式、异步 API、元数据、错误处理
next-cache-components	PPR、use cache 指令、cacheLife、cacheTag、updateTag
next-upgrade	按照官方迁移指南和代码改造工具升级 Next.js
vercel-composition-patterns	可扩展的 React 组合模式，适用于组件重构
vercel-react-best-practices	React 和 Next.js 性能优化指南
vercel-react-native-skills	React Native 和 Expo 的最佳实践，用于构建高性能移动应用
web-design-guidelines	审查 UI 代码，确保符合 Web 界面指南和无障碍访问要求

添加自定义技能

在 .agents/skills/ 目录下创建一个文件夹，并在其中放置一个包含 YAML 前置元数据的 SKILL.md 文件：

.agents/skills/
└── my-custom-skill/
    └── SKILL.md

---
name: my-custom-skill
description: 何时使用此技能 — 代理会读取这段描述来决定是否加载它。
---

# 我的自定义技能

在此处填写您的专业评审说明……

代理仅在其系统提示中看到技能名称和描述。当请求匹配某项技能时，它会调用 loadSkill 来获取完整的指导说明，从而保持上下文窗口的简洁。

技术栈

• Next.js — 应用框架
• Vercel Workflow — 长效执行
• Vercel Sandbox — 隔离的代码执行
• AI SDK — AI 模型集成
• Chat SDK — GitHub webhook 处理
• Octokit — GitHub API 客户端

开发

bun install
bun dev

许可证

MIT

OpenReview 快速上手指南

OpenReview 是一个开源、可自托管的 AI 代码审查机器人。部署到 Vercel 后，连接 GitHub App，即可利用 Claude 大模型对 Pull Request (PR) 进行按需自动审查、修复格式错误甚至提交代码。

环境准备

在开始之前，请确保你拥有以下账号和权限：

• Vercel 账号：用于部署应用和管理 Workflow/Sandbox 环境。
• GitHub 账号：需要拥有创建 GitHub App 的权限，以及目标仓库的管理员权限（用于安装 App）。
• Anthropic API Key：用于调用 Claude 模型（OpenReview 默认使用 Claude Sonnet）。
• 开发工具：本地建议安装 Bun 用于开发和调试（项目基于 Bun 构建），若仅需部署则无需本地环境。

安装步骤

1. 部署到 Vercel

点击下方的部署按钮，将项目克隆并部署到你的 Vercel 账户中。系统会自动配置部分依赖（如 Upstash KV）。

2. 创建 GitHub App

访问 GitHub App 创建页面，按以下配置填写：

• Webhook URL: https://<你的 Vercel 域名>/api/webhooks
  • 注： <你的 Vercel 域名> 替换为你第一步部署生成的实际域名。
• Repository permissions (仓库权限):
  • Contents: Read & write
  • Issues: Read & write
  • Pull requests: Read & write
  • Metadata: Read-only
• Subscribe to events (订阅事件):
  • Issue comment
  • Pull request review comment

创建完成后：

1. 生成 Private key (私钥) 并下载。
2. 生成 Webhook secret (Webhook 密钥)。
3. 记录 App ID。
4. 安装该 App 到你的目标仓库后，获取 Installation ID (可在 https://github.com/settings/installations 查看)。

3. 配置环境变量

回到 Vercel 项目控制台，进入 Settings > Environment Variables，添加以下变量：

变量名	说明
ANTHROPIC_API_KEY	你的 Anthropic API 密钥
GITHUB_APP_ID	GitHub App 的 ID
GITHUB_APP_INSTALLATION_ID	仓库对应的 Installation ID
GITHUB_APP_PRIVATE_KEY	下载的私钥内容 (注意：换行符需保留，通常直接粘贴完整内容，若报错可尝试将换行符替换为 \n)
GITHUB_APP_WEBHOOK_SECRET	创建的 Webhook 密钥
REDIS_URL	(可选) Redis 连接地址，若不填则使用内存存储

保存后，Vercel 会自动重新部署以生效配置。

4. 本地开发（可选）

如果你需要修改源码或添加自定义技能，可克隆仓库并在本地运行：

git clone https://github.com/vercel-labs/openreview.git
cd openreview
bun install
bun dev

基本使用

配置完成后，OpenReview 即可在你的 GitHub 仓库中工作。

触发代码审查

在任意 Pull Request 的评论框中提及 @openreview 即可触发审查。你可以附带具体指令：

@openreview check for security vulnerabilities

@openreview run the linter and fix any issues

@openreview explain how the authentication flow works

交互与修复

1. 查看建议：机器人会以行内评论（Inline comments）的形式提出建议，并提供一键修复的代码块。
2. 批准更改：对机器人的建议评论点击 👍 或 ❤️，机器人将自动提交修复代码并推送到当前 PR 分支。
3. 忽略建议：点击 👎 或 😕，机器人将跳过该建议。

扩展自定义技能

你可以在项目根目录的 .agents/skills/ 文件夹中添加自定义审查规则。创建一个新文件夹（例如 my-custom-skill），并在其中添加 SKILL.md：

---
name: my-custom-skill
description: 当用户请求检查数据库连接规范时使用此技能。
---

# My Custom Skill

在此处编写具体的审查指令和规则...

机器人会在运行时自动发现并加载这些技能。