各端使用指南
Cloud 使用指南
创建云端任务、本地上云及 PR 交付。
Cloud 让任务在云端执行。你可以直接选择仓库创建任务,也可以将已有本地任务转到云端,再通过已开放、支持 Cloud 的客户端跟进结果。
本指南以桌面端为主要操作入口,另提供 CLI 发起本地任务上云和查询上云状态的命令。
查看流程图源码(Mermaid)
flowchart TD
A["确认账号与仓库授权"] --> B{"从哪里开始?"}
B --> C["选择仓库,直接创建云端任务"]
B --> D["打开已有本地任务"]
D --> E["确认会话与未提交改动的迁移范围"]
C --> F["云端准备并执行任务"]
E --> F
F --> G["跟进进度、补充要求、检查结果"]
G --> H["继续修改或通过 PR 交付"]
1. 使用前准备
1.1 账号与入口
| 准备项 | 需要确认 |
|---|---|
| Remy 账号 | • 已登录 Remy 账号 • 当前登录的账号及团队范围与任务一致 |
| 桌面端 | • 已安装并登录 Remy • 用于创建、查看和继续云端任务,以及打开 PR |
| CLI(可选) | • 用于将本地对话转到云端、查询上云过程 • 按 CLI 指南 完成安装,并单独登录 |
| 网络 | • 提交任务、查看进度及回复时需要连接网络 |
| GitHub | • 已完成连接授权 • 可以访问目标仓库;涉及推送和 PR 时,需要相应权限 |
本指南以 GitHub 代码仓库任务为例。安装及登录步骤参见桌面端指南。
1.2 选择使用路径
| 你的情况 | 使用路径 |
|---|---|
| 想直接在云端处理仓库中的任务 | • 选择 Cloud 仓库与分支,创建新任务 • 不要求先在本机准备该仓库的工作副本 |
| 已在本地分析或修改,希望交给云端继续 | • 打开本地对话,使用 Move to Cloud • 按提示决定是否携带未提交改动 |
| 已通过 CLI 开始本地任务 | • 使用 remy cloud handoff 发起上云 • 成功后在支持 Cloud 的桌面端跟进任务 |
2. 连接仓库与确认运行条件
2.1 连接 GitHub
- 打开桌面端的项目选择菜单,找到 Cloud。
- 如果 Cloud 尚不可用,点击旁边的设置按钮,进入 GitHub 连接页面。
- 按页面提示完成 GitHub 授权。
- 返回项目选择菜单,打开 Cloud,确认可以看到目标仓库。
仓库列表支持通过 Search repos 搜索。找不到仓库时,先检查连接的 GitHub 账号及授权范围。
2.2 确认仓库与分支
选择仓库后,Remy 会先使用该仓库的默认分支。需要其他分支时,点击分支选择入口,选择本次任务要基于的分支。
| 内容 | 检查方法 |
|---|---|
| 仓库 | • 确认仓库名称与本次任务一致 |
| 分支 | • 确认包含需要处理的代码 • 本地上云时,结合上云检查中的提交与分支信息确认 |
| 运行说明 | • 项目文档能够说明依赖、启动和测试方式 |
| 必要权限 | • 仓库可访问 • 推送及 PR 操作所需权限已具备 |
2.3 云端环境如何准备
提交任务后,云端会进行相应初始化,例如准备工作空间、获取仓库代码和启动任务。无需在这份流程中另外创建一个命名的“云端环境”。
本机已经安装的依赖、正在运行的开发服务或本机凭据,不应被视为云端环境已经具备。任务涉及特殊依赖时,在项目文档或任务说明中写清准备与检查方法。
请先阅读仓库的 README 和项目约定,确认依赖安装、启动及测试方式。
如果当前环境缺少必要条件,请说明具体缺少什么和对应错误。
能够执行的检查请实际运行;无法执行的检查请单独列出。
3. 直接创建云端任务
3.1 选择仓库并发送任务
- 新建对话,在项目选择菜单中打开 Cloud。
- 搜索并选择目标仓库,检查分支。
- 确认执行方式显示 Send to cloud。
- 选择可用模型,输入任务并发送。
- 等待初始化和任务执行,查看返回的进度与结果。
如果希望先审阅计划,可以在执行方式菜单中启用 Plan before editing,再提出任务。查看返回的计划后,在对话中说明确认或需要调整的内容。
3.2 提供明确的任务要求
下面的示例可以按实际项目修改:
请检查订单列表切换筛选条件后分页不正确的问题,并完成修复。
要求:
1. 先读取仓库说明和相关约定。
2. 只修改筛选、分页及直接相关的逻辑。
3. 沿用项目现有样式和测试方式。
4. 补充并运行相关测试。
5. 最后说明改动文件、检查结果和未完成事项。
不要合并 PR。
3.3 文本与本地附件的区别
直接发送给 Cloud 的任务消息目前只支持文本。本地附件、文件夹引用及本地代码引用不能随这类消息一起发送。
| 需要提供的内容 | 建议方式 |
|---|---|
| 已在仓库中的代码或文档 | • 在任务中写明仓库内路径及需要关注的内容 |
| 简短的需求或复现步骤 | • 直接写入任务消息 |
| 已有本地对话及未提交改动 | • 使用第 4 章的本地任务上云流程 |
| 输入区已附带本地文件或引用 | • 移除附件或引用后发送文本任务 • 或回到本地执行,按对应流程处理 |
4. 将本地任务转到云端
4.1 在桌面端发起上云
- 打开要继续处理的本地对话,确认当前项目和任务。
- 等待当前本地执行结束。
- 打开对话标签的菜单,选择 Move to Cloud。
- 如存在未提交文件,查看文件数量、清单及传输大小提示,选择是否携带。
- 核对出现的仓库、提交和其他确认信息,按界面提示继续。
- 等待上云成功,再在原任务中跟进云端执行。
GitHub 尚未授权时,先通过对应设置入口完成授权,再重试。
4.2 决定是否携带未提交改动
出现 Include uncommitted changes? 时:
| 选项 | 作用 |
|---|---|
| Include Changes | • 携带检查清单内允许迁移的未提交文件变更 |
| Exclude Changes | • 未提交文件保留在本机 • 云端从检查确认的已提交代码继续任务 |
| Cancel | • 取消此次上云操作 |
这一步是在“携带改动”和“不携带改动”之间选择。迁移前应核对提示中的文件范围,而不是假设整个本地目录都会上传。
4.3 上云前后有哪些变化
| 内容 | 上云后的处理 |
|---|---|
| 会话内容 | • 将支持迁移的会话内容带到云端,用于接续任务 |
| 已提交代码 | • 云端基于确认的仓库与提交准备工作副本 |
| 未提交文件 | • 根据 Include Changes/Exclude Changes 的选择处理 • 受到路径、大小、数量及内容检查约束 |
| 忽略文件、凭据和登录状态 | • 不默认作为整个本地环境一起上传 |
| 执行分支 | • 在云端创建新的分支开展工作 |
| 本机文件 | • 云端结果不会自动写回本地工作目录 |
| 后续交付 | • 查看任务结果,并按需要通过 PR 交付 |
上云成功与任务完成是两件事。任务转到云端后,还需要等待执行、检查结果,并处理后续问题。
4.4 通过 CLI 发起上云
在已登录 CLI 的终端中,先查看目标项目的对话:
remy --workspace "/path/to/project" history list
将 /path/to/project 替换为真实项目路径,将下面的 CHAT_ID 替换为对应的对话 ID。
携带未提交改动:
remy --workspace "/path/to/project" cloud handoff --chat-id "CHAT_ID" --include-workspace --message "请在云端继续处理剩余检查,并说明结果。"
保留未提交改动在本机:
remy --workspace "/path/to/project" cloud handoff --chat-id "CHAT_ID" --exclude-workspace --message "请在云端基于已提交代码继续处理任务。"
根据需要选择其中一条命令。目录没有未提交改动时,可以省略 --include-workspace 和 --exclude-workspace。
CLI 会展示迁移预览。核对账号范围、仓库、分支、提交及文件范围后,输入 yes 确认。
4.5 查询或取消上云过程
如果上云过程尚未完成,可以查询:
remy --workspace "/path/to/project" cloud status --chat-id "CHAT_ID"
如果已经获得上云记录 ID,也可以明确指定:
remy --workspace "/path/to/project" cloud status --chat-id "CHAT_ID" --handoff-id "HANDOFF_ID"
将 HANDOFF_ID 替换为该次操作返回的记录 ID。上传后连接断开、结果未知时,先查询同一次上云记录,不要直接重复发起新的上云。
需要取消尚未激活的上云过程时:
remy --workspace "/path/to/project" cloud cancel --chat-id "CHAT_ID" --handoff-id "HANDOFF_ID"
该命令只用于取消尚未激活的上云过程,不能取消已经激活的云端任务。已进入云端执行的任务,应在桌面端查看并通过任务的停止操作处理。
CLI 的 cloud status 查询的是上云过程。完整的任务进度、继续对话与 PR 操作,以桌面端任务界面为主。
5. 跟进任务与跨设备使用
5.1 查看当前阶段
| 阶段 | 需要做什么 |
|---|---|
| 准备或传输中 | • 等待工作空间和任务准备完成 • 留意具体错误提示,避免重复提交 |
| 执行中 | • 查看任务输出和当前进度 • 按需要补充背景或要求 |
| 等待输入或确认 | • 打开原任务,阅读问题或计划 • 补充信息、确认要求或说明调整意见 |
| 已返回结果 | • 查看修改与检查结果 • 决定继续修改还是交付 |
| 失败或取消 | • 先核对最终状态和错误信息 • 处理原因后再决定是否继续或重新发起 |
停止请求发出后,等待任务状态更新,确认云端执行已经结束。
5.2 在原任务中继续
需要调整结果时,打开同一云端任务继续说明:
筛选条件变化后已经能回到第 1 页,但列表没有刷新。
请只修复刷新逻辑,保留此前已经完成的改动,
补充并运行相关测试,最后说明结果。
不要合并 PR。
网络中断后,先重新打开原任务查看当前状态和最新回复,再决定是否补发消息。任务列表刷新失败时,界面可能仍显示上次取得的记录。
5.3 换一台设备跟进
- 在另一台已安装 Remy 桌面端的设备上登录相同账号,并确认团队范围一致。
- 在侧栏找到对应的云端任务。
- 打开任务,等待最新消息和状态加载。
- 继续查看结果,或在同一任务中补充要求。
云端任务不依赖发起它的电脑持续在线。关闭桌面应用、电脑离线或关机后,云端任务仍可继续;需要你回复的问题会等待后续处理。
跨设备操作以支持 Cloud 的客户端为准。
6. 查看结果与交付
6.1 检查任务结果
| 检查项 | 查看位置与要点 |
|---|---|
| 任务结论 | • 查看对话中的结果说明,确认原需求是否完成 |
| 代码改动 | • 阅读任务列出的文件和改动说明 • 已生成 PR 时,在 PR 页面查看实际差异 |
| 测试与验证 | • 确认检查是否实际执行、是否通过 • 未运行或失败的检查应说明原因 |
| 剩余事项 | • 记录需要继续修改、补充环境或人工确认的内容 |
任务返回结果或生成 PR,都不能替代对测试结果和实际功能的检查。
6.2 通过 PR 交付
需要 PR 时,在任务中明确说明交付要求。例如:
请为已完成的改动准备 PR:
说明解决的问题、主要改动、已运行的检查和剩余事项。
如果已有本任务的 PR,请更新原 PR。
不要合并。
任务生成 PR 后,界面会显示 Draft PR 或 PR 卡片。点击卡片中的链接,在浏览器中打开对应 PR,检查工作分支、目标分支和实际差异。
需要在 Remy 中合并时,先审阅 PR,再使用卡片中的 Merge PR,核对确认窗口中的源分支和目标分支后执行。合并会修改远端仓库,具体结果以返回状态为准。
6.3 本地目录不会自动更新
Cloud 的执行结果不会自动同步回本地工作目录。通过 PR 合并或准备继续本地工作时,按项目正常的 Git 流程拉取和检查代码。
不要将本地 Changes 面板中的内容直接当作云端任务的最新改动。
7. 常见问题与已知限制
7.1 入口、执行与结果问题
| 现象 | 建议先检查 |
|---|---|
| Cloud 或 Send to cloud 不可用 | • GitHub 连接是否完成 • 按入口旁的提示完成授权 |
| 找不到目标仓库 | • GitHub 账号是否正确 • 目标仓库是否在授权范围内 • 使用仓库名称重新搜索 |
| 云端初始化失败 | • 仓库和分支是否可访问 • 查看失败阶段及具体错误 • 核对项目运行说明,必要时联系支持人员 |
| 本地任务无法上云 | • 当前本地执行是否已结束 • 项目、仓库和提交信息是否有效 • 未提交文件的选择及内容检查是否通过 |
| 上云后连接断开或结果未知 | • 先重新查看原任务或查询同一上云记录 • 避免重复创建云端任务 |
| Cloud 消息带附件时无法发送 | • 直接 Cloud 消息只支持文本 • 移除本地附件、文件夹及代码引用,或改用对应本地流程 |
| 换设备后找不到任务 | • 登录账号和团队范围是否一致 • 检查任务列表是否刷新成功 |
| 显示没有任务访问权限 | • 核对账号、团队范围与任务归属 • 按提示重新登录或联系支持人员 |
| PR 无法合并 | • 核对目标分支、权限及冲突等返回信息 • 在 PR 页面确认需要处理的事项 |
| 本地文件没有出现云端改动 | • 云端结果不会自动写回本地 • 通过 PR 或项目正常 Git 流程处理 |
7.2 当前需要注意的边界
- 本地上云按预览和选择的范围执行,不是将整台电脑或整个运行环境复制到云端。
- 直接发起和继续 Cloud 任务的消息当前只支持文本。
- 本机未提交文件是否带到云端,由上云时的选择决定。
- CLI 上云过程查询与云端任务本身的进度不同。
- 云端结果不自动同步回本地;是否完成交付,要看实际代码、检查结果及 PR 状态。
8. 获取帮助与继续阅读
8.1 提交问题反馈
通过对应任务的 Send feedback 入口反馈问题。CLI 的反馈提交方法参见 CLI 指南。
说明问题发生在创建任务、本地上云、跟进任务还是 PR 交付阶段,并补充仓库与分支、任务或上云记录 ID(如有)及错误提示。
无法进入任务或使用反馈入口时,可以联系运营支持:support@corepass.com。
8.2 继续阅读
| 你想做什么 | 对应资料 |
|---|---|
| 完成首次编程任务 | • Quick Start |
| 安装和使用桌面端 | • 桌面端安装与使用指南 |
| 使用 CLI 或提交 CLI 反馈 | • CLI 安装与使用指南 |
| 查看更多操作说明和常见问题 | • Remy 官网 Docs 文档中心 |