跳转到主要内容
登录、安装 GitHub App、连接仓库。Orbi 随后会读仓库并给出建议,由你选定第一个任务。也可以自己写需求或派发已有 Issue。 这是最短的完整路径。每一步结尾都有一条成功判据,你据此判断该继续往下走,还是停下来先修点什么。整条路径都在浏览器和 GitHub 里完成:你不会拿到 runner 上的 shell,也不用在本地装任何东西。 开始之前你需要一个 GitHub 账号,和一个你能在上面安装 GitHub App 的仓库(你得是它的所有者,或者组织的 owner/admin)。这个仓库必须开启了 Issues。Orbi 靠读 Issue 和给 Issue 打标签工作,关掉了 Issues 的仓库连不上。
试用不需要一个又大又重要的仓库。装在一个小仓库上就足够看完整个循环,以后还可以再加别的。

一路给你指路的页面

状态页上的开通步骤只有五步:登录、安装 App、连接仓库、准备环境、交出第一个需求。第五步在交出需求时完成,不需要等合并。安装、连接和第一个需求有操作短片。发版与订阅不属于开通步骤。

1. 用 GitHub 登录

打开 orbi.build/api/,点「使用 GitHub 登录」。 GitHub 会让你授权 Orbi Cloud。这一步只确认你是谁,此时还没有把任何仓库的权限给 Orbi。
如果你的浏览器首选语言是中文,页面会以中文打开。在登录页右上角用 🇨🇳 ZH | 🇺🇸 EN 切换,登录后也可以在账户菜单(右上角你的头像)里切换。这个选择会记一年。
成功判据:你已登录,右上角是你的 GitHub 头像和登录名。如果还没装 App,你落到的页面标题是「连接仓库」,上面写着「还没有安装 Orbi 的 GitHub App。」;否则就是状态页,浏览器标签页上写着「Orbi Cloud 状态」。

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 的安装范围。
成功判据:连接完成后直接进入这个项目的状态页,Orbi 开始准备工作环境。

4. 等待准备工作环境

连接仓库后,Orbi 会为你的仓库搭一个隔离的工作环境,并把交付用的标签装进去。一般 10–20 秒,页面会自己更新,你不用刷新,也不用做任何事。 成功判据:「准备工作环境」标成「✓ 已完成」。接着出现「Orbi 正在读…,挑能马上做的事」,列出最近读取的文件;建议一般 2 分钟,可以先离开。准备环境和读取建议是两个步骤。 如果准备失败,状态页会在状态主卡里告诉你,点「查看原因与处理方法」能看到原因和该怎么做。多数失败在平台一侧,会自行恢复,见准备工作环境。

5. 交给 Orbi 第一个任务

建议就绪后,主卡写着「Orbi 读完了您的仓库,建议先做这一件」,下面列一件事:
  • 新任务:点「查看需求」,读已经写好的草稿;需要调整就在下面告诉 Orbi,确认后点「交给 Orbi 开始做」。打开草稿不会建 Issue,确认交付才会建。
  • 已有 Issue:点「让 Orbi 做这个」,立即打上 ai-ready 并派发。
  • 自己定任务:同一张卡上还有「写需求」「去 GitHub 新建 Issue(直接开做)↗」和「选一个已有 Issue(N 条)」。
「看其他 N 个建议」展开其余建议,列表末尾的「换一批」会重新读一批。没有建议时可点「获取建议」,也可直接写需求。
开工靠的是 ai-ready 标签。「交给 Orbi 开始做」和「让 Orbi 做这个」会替你打上它;自己在 GitHub 上写 Issue 时,要自己打。没有这个标签的 Issue 等多久都不会被认领。
环境就绪、额度可用时,任务通常一分钟左右开始;排队或版本范围限制会让它继续等待。常规定时认领每五分钟运行一次。 成功判据:几分钟内,ai-in-progress 标签出现在这个 Issue 上,状态页的标题变成「Orbi 正在写代码」,这个任务出现在「任务记录」下面。 从这里开始,Orbi 写代码、提交拉取请求、在另一个会话里检查它、修掉检查发现的问题。评审和合并门禁通过、改动合并之后,Issue 走到 ai-merged。

先试官方示例

在连接页用官方示例创建自己的仓库副本,再授权并连接。所有套餐都可以在真实项目之外连接一个经核实的示例副本;示例交付不占三次免费交付,副本也不占仓库名额。 示例有三个预写任务:加一个「Clear completed」按钮、显示剩余待办数量、刷新后保留列表。点一个任务就会直接创建并派发 Issue。合并后,有预览就用「打开您的网页 ↗」;也可以展开「运行自己的最新副本」,照这个副本给出的命令运行。合并代码不会更新你以前下载的文件或本地正在运行的网页。「查看 Issue、PR 与检查结果」可看交付证据。 点「连接自己的项目」转到自己的仓库。普通仓库仅名称相似,不会得到示例的额度豁免。

跑的时候

你不用干等。如果你发现 Issue 漏写了什么,直接在 Issue 下面评论,正在跑的会话通常一分钟内就会接上这条修正。见交付生命周期里讲转向的部分。

接下来做什么

  • 交下一个任务。排队的任务出现在「任务记录」下面,状态是「排队中」。
  • 合并的改动攒到值得记一个版本时,见发版。发版是可选操作,不是开通步骤。
  • 想搞清楚每个标签的含义、以及什么会让 Issue 在它们之间移动,读交付生命周期。
  • 如果 Issue 走到了 ai-blocked,读问题排查,这个状态在等你做决定。
  • 五分钟过去了什么都没发生?从问题排查开始看。