heydeer 登录
开始使用

快速入门

将 HeyDeer 连接到 GitHub,审查一个打开的 PR,然后开启自动审查。发起审查需要拥有仓库的写权限。

1. 登录并选择账号

在 heydeer.ai 上选择“登录”,然后选择“使用 GitHub 继续”。在“选择 GitHub 账户”页面,选择你的个人账号或某个组织,然后选择“设置”;如果队友已经设置过,则选择“打开”。

2. 安装 GitHub App

在 GitHub 上选择“Only select repositories”(仅选择部分仓库),挑选要审查的仓库并安装。如果你不是组织所有者,GitHub 会请所有者批准;HeyDeer 会显示“正在等待 GitHub 所有者批准”,并在他们批准后自动连接。参见 GitHub App 与权限。

3. 发起首次 PR 审查

你的“审查记录”页面会列出可供审查的打开的 PR,并默认选中第一个。选择“选择其他 PR”可按仓库搜索或筛选,然后选择“审查此 PR”。HeyDeer 会使用仓库默认的审查深度和反馈范围,审查运行期间你可以离开此页面。

4. 在 GitHub 上查看结果

HeyDeer 会发布一个带有行内评论的审查,HeyDeer Review 检查会显示结果。之后的审查会检查新的推送,并将你已处理的讨论标记为已解决。参见解读审查结果。

5. 开启自动审查

新工作区默认使用“仅手动”。管理员可以在“仓库”中选择仓库,选择“修改审查时机”,然后选择“每个 PR 审查一次”或“每次推送时审查”;也可以在“组织设置 → 审查规则”中为整个组织设置。参见自动审查。

6. 让 HeyDeer 了解你的代码库

添加包含团队约定的 AGENTS.md,并在 .agents/checks/ 中添加仓库检查来定义聚焦的规则。

7. 设置通知邮箱

管理员可以在“组织设置 → 通知”中设置工作区邮箱,用于接收试用、积分和付款提醒。参见通知。

免费试用

新工作区可获得 14 天免费试用和 1,200 积分,从首次成功审查开始计算。试用期间最多可同时运行 2 个审查,且无需信用卡。试用结束或积分用完后,新的审查会暂停,直到管理员选择套餐。参见套餐与加购积分。