GitHub
Cursor GitHub 应用可连接你的仓库,让你使用 Cloud Agents 和 Bugbot 等功能。
设置
需要具备 Cursor 管理员权限和 GitHub 组织管理员权限。
- 前往仪表盘中的集成
- 点击 GitHub 旁的 连接 (如果已连接,则点击 管理连接)
- 选择 所有仓库 或 选定仓库
- 返回仪表盘,为您的仓库配置功能
要断开 GitHub 账户连接,请返回集成仪表盘,然后点击 断开账户连接。
IP 允许列表配置
如果你的组织使用 GitHub 的 IP 允许列表功能来限制对仓库的访问,可以将 Cursor 配置为使用 IP 地址范围有限的托管出站代理。
配置 IP 允许列表前,请联系 hi@cursor.com,为你的团队启用此功能。以下任一配置方法都需要先启用此功能。
为已安装的 GitHub 应用启用 IP 允许列表配置 (推荐)
Cursor GitHub 应用已预先配置好 IP 列表。您可以为已安装的应用启用允许列表,使其自动继承该列表。这是推荐做法,因为我们可以更新该列表,您的组织也会自动获得更新。
启用方法:
- 前往组织的安全设置
- 进入 IP 允许列表设置
- 勾选 “允许 GitHub 应用访问”
详细说明请参阅 GitHub 文档。
直接将 IP 添加到允许列表
如果你的组织在 GitHub 中使用由 IdP 定义的允许列表,或无法使用预先配置的允许列表,请将 Git 出站代理和 IP 允许列表 中列出的代理 IP 添加到允许列表。
高级网络
自托管实例除 IP 允许列表外,还支持多种连接方式。有关设置详情和支持的私有网络选项,请参阅私有网络连接。
仅适用于企业版客户。如果您的 GitHub Enterprise Server 部署在 AWS 中,或可置于 AWS 网络负载均衡器后方,请使用 AWS PrivateLink。PrivateLink 可让 Cursor 访问 GHES;如有需要,GHES 也可将 webhook 回传给 Cursor,全程无需通过公共互联网出站。
最适合: 托管在 AWS 上的 GHES 实例,以及需要通过私有 VPC 端点连接的团队
安全性: HTTPS 加密、AWS PrivateLink、VPC 端点策略、服务账户访问 token
缺点: 需要与 Cursor 协调,并设置 AWS 端点服务。
仅适用于企业版客户。当 AWS PrivateLink 不适用,或您需要仅出站的部署模式时,请使用 Cloudflare Tunnel。您的网络中需运行 cloudflared,Cursor 会提供隧道主机名和 token。
最适合: 不具备入站网络访问条件的环境
安全性: HTTPS 加密、Cloudflare Tunnel、服务账户访问 token
缺点: 需要在您的环境中运行和维护 cloudflared。
权限
GitHub 应用会请求以下权限,以支持 Cursor 功能:
| 权限 | 用途 |
|---|---|
| 代码仓库访问权限 | 克隆您的代码并创建工作分支 |
| PR | 创建 PR 并添加评审评论 |
| 问题 | 跟踪评审中发现的缺陷和任务 |
| 检查和状态 | 报告代码质量和测试结果 |
| 操作和工作流 | 监控 CI/CD 流水线,并通过 PR 触发重新运行 CI |
| 管理 | 读取分支保护和必需检查规则,以确定 PR 是否可以合并 |
| 自定义代码仓库角色 | 确定用户访问级别,以显示相应的合并和评审选项 |
| 组织自定义属性 | 在筛选时显示组织定义的代码仓库元数据 |
所有权限均遵循最小权限原则。
受保护的 Git 范围
将您的 GitHub 组织关联至 Cursor 组织,确保只有您的团队能通过 Cloud Agents、自动化和 Bugbot 使用其中的仓库。保护范围需要 GitHub 组织所有者或管理员权限。请参阅受保护的 Git 范围。
疑难排查
- 安装并授予代码仓库访问权限的 GitHub 应用
- 检查私有仓库的访问权限
- 验证您的 GitHub 账户权限
- 授予应用 PR 写入权限
- 检查分支保护规则
- 如果应用安装已过期,请重新安装
- 检查是否在组织级别安装
- 从 github.com/apps/cursor 重新安装
- 如果安装已损坏,请联系支持团队
后续步骤
连接 GitHub 集成后,配置使用该集成的功能:
- Bugbot — 自动化 PR 审查,可发现缺陷和安全问题
- Cloud Agents — 在云端运行、可处理您的仓库的 AI 智能体