一路给你指路的页面
状态页上的开通步骤只有五步:登录、安装 App、连接仓库、准备环境、交出第一个需求。第五步在交出需求时完成,不需要等合并。安装、连接和第一个需求有操作短片。发版与订阅不属于开通步骤。1. 用 GitHub 登录
打开 orbi.build/api/,点「使用 GitHub 登录」。 GitHub 会让你授权 Orbi Cloud。这一步只确认你是谁,此时还没有把任何仓库的权限给 Orbi。如果你的浏览器首选语言是中文,页面会以中文打开。在登录页右上角用 🇨🇳 ZH | 🇺🇸 EN 切换,登录后也可以在账户菜单(右上角你的头像)里切换。这个选择会记一年。
2. 安装 Orbi GitHub App
如果你已经在 GitHub 完成 App 安装并回到 Orbi,就跳到第 3 步;只看过安装表单还不算完成。否则在你落到的页面上点「安装 Orbi 的 GitHub App」,你会被送到 GitHub。 在 GitHub 的安装页上,选中拥有你那个仓库的账号或组织,选 Only select repositories,勾上你想让 Orbi 在里面干活的那个仓库,点 Install。 这个 App 需要 Issues、拉取请求和仓库内容的写权限才能干活:它要给 Issue 打标签、提交拉取请求、推送自己工作的那个分支。安装 GitHub App 逐条解释了每项权限,而且你随时可以在 GitHub 上撤销整个安装。 成功判据:GitHub 把你送回 Orbi。首次接入时,如果只授权了一个符合条件的仓库,Orbi 会按它的默认分支自动连接,直接进入状态页。授权了多个仓库则进入「连接仓库」页。若先看到「正在确认 GitHub App 安装」,等待刷新;1 分钟后还没进去,点「选择仓库」。3. 连接仓库
已经自动连接并进入状态页?直接跳到第 4 步。出现选择表单时,按下面操作。 在「仓库」列表里选你的仓库(仓库超过 8 个时,上面会多一个「搜索仓库」框,输入名字的一部分就能筛选)。然后看一下「基础分支」,也就是 Orbi 提交拉取请求的目标分支。选中仓库之后,页面会载入它真实的分支列表,并预选默认分支,所以多数情况下你只需要确认一下。点「连接仓库」。标着「(Issues 已关闭,需先开启)」的仓库,要先在仓库的 Settings → Features 里勾选 Issues。如果列表里压根没有你的仓库,展开「列表里没有您的仓库?」,里面有链接,可以把它加进 App 的安装范围。
4. 等待准备工作环境
连接仓库后,Orbi 会为你的仓库搭一个隔离的工作环境,并把交付用的标签装进去。一般 10–20 秒,页面会自己更新,你不用刷新,也不用做任何事。 成功判据:「准备工作环境」标成「✓ 已完成」。接着出现「Orbi 正在读…,挑能马上做的事」,列出最近读取的文件;建议一般 2 分钟,可以先离开。准备环境和读取建议是两个步骤。 如果准备失败,状态页会在状态主卡里告诉你,点「查看原因与处理方法」能看到原因和该怎么做。多数失败在平台一侧,会自行恢复,见准备工作环境。5. 交给 Orbi 第一个任务
建议就绪后,主卡写着「Orbi 读完了您的仓库,建议先做这一件」,下面列一件事:- 新任务:点「查看需求」,读已经写好的草稿;需要调整就在下面告诉 Orbi,确认后点「交给 Orbi 开始做」。打开草稿不会建 Issue,确认交付才会建。
- 已有 Issue:点「让 Orbi 做这个」,立即打上
ai-ready并派发。 - 自己定任务:同一张卡上还有「写需求」「去 GitHub 新建 Issue(直接开做)↗」和「选一个已有 Issue(N 条)」。
ai-in-progress 标签出现在这个 Issue 上,状态页的标题变成「Orbi 正在写代码」,这个任务出现在「任务记录」下面。
从这里开始,Orbi 写代码、提交拉取请求、在另一个会话里检查它、修掉检查发现的问题。评审和合并门禁通过、改动合并之后,Issue 走到 ai-merged。