CLI 安装与使用

本指南面向 macOS 用户，介绍如何安装 Remy CLI、登录账号、在本地项目中执行任务、继续已有对话，以及更新和提交反馈。

flowchart LR
    A["准备 Node.js 与 npm"] --> B["安装 Remy CLI"]
    B --> C["登录账号"]
    C --> D["进入项目目录"]
    D --> E["发起任务"]
    E --> F["检查结果并继续"]

1. 使用前准备

1.1 系统与运行条件

CLI 需要 Node.js 和 npm。通过标准 npm 安装方式使用 Remy CLI，无需额外安装 Python 或 Rust；运行你自己的项目或测试时，仍需满足该项目的环境要求。

在终端中检查：

node --version
npm --version

两条命令都应能输出版本号。如果提示找不到命令，先从 Node.js 官网 获取适合 Mac 的安装包，完成安装后重新打开终端。建议选择官网当前的 LTS 版本，再继续安装 Remy。

1.2 模型访问

使用 Remy 账号登录后即可访问账号可用的模型，标准使用流程无需另外准备模型服务账号或 API Key。

桌面端和 CLI 需要分别登录。即使已经登录 Remy 桌面端，首次使用 CLI 时仍需执行 CLI 登录流程。

2. 安装与检查

2.1 安装 Remy CLI

在终端中运行：

npm install -g @corepassinc/remy

等待安装完成。安装过程会根据当前系统及 Node.js 运行架构选择对应组件，不需要手动选择 Apple 芯片或 Intel 的 CLI 包。

2.2 确认命令可用

安装完成后运行：

remy --version
remy --help

如果提示找不到 remy，先重新打开终端，再检查第 7 章的安装与命令路径问题。

3. 登录与账号检查

3.1 登录

在终端中运行：

remy login

1. 在打开的浏览器中完成账号登录。
2. 返回终端，等待登录结果。
3. 看到 Signed in as … 后，继续下一步。

如果登录失败，根据终端中的提示检查网络或重新发起登录。

3.2 查看当前账号

remy whoami

该命令可以帮助你确认当前登录账号、账号所属范围及工作目录。使用团队账号时，先确认当前显示的是预期的团队范围。

3.3 检查运行环境

remy doctor

根据检查结果判断是否需要处理：

运行环境检查通过后，仍需通过一次真实任务确认模型调用、项目访问和结果输出正常。

需要退出 CLI 账号时：

remy logout

4. 在项目中开始交互任务

4.1 进入项目目录

在终端中进入需要处理的项目，然后启动 Remy：

cd "/path/to/project"
remy

将 /path/to/project 替换为你自己的本地项目路径。

也可以在启动时指定项目目录：

remy --workspace "/path/to/project"

启动前先确认目录。CLI 会围绕当前工作目录处理任务；切换到另一个项目时，退出当前交互界面，再进入目标目录或通过 --workspace 启动。

4.2 选择模型并发送任务

进入 Remy 交互界面后：

1. 按 F2，或输入 /model，查看当前可用模型。
2. 按需要选择模型。提供推理设置的模型，可通过 Ctrl+U 调整。
3. 在输入区描述任务，按 Enter 发送。

在 macOS 终端中，Option+Enter 用于换行。快捷键显示和可用选项可通过 Ctrl+G 查看。

在任务开始前完成模型选择；具体可选模型以当前账号与 CLI 中显示的列表为准。

4.3 完成一个小改动

沿用你已有项目中的一个真实问题。下面以订单列表的筛选与分页为例，请替换成自己项目中的模块和行为。

先理解相关代码：

请先读取当前项目的说明与相关约定，
梳理订单列表涉及的文件、筛选逻辑、分页逻辑和相关测试。

只分析，不修改文件、安装依赖、提交或推送代码。

确认理解正确后，在同一对话中继续：

订单列表在第 3 页时切换状态筛选，结果显示为空，
回到第 1 页才有数据。

请定位并修复问题，让切换筛选时重置页码。
只修改相关逻辑，补充并运行相关测试。
最后说明改动文件、检查结果，以及无法完成的检查。

先不要提交或推送代码。

如果 Remy 请求补充信息或确认操作，阅读提示后再作答。可以通过 /permissions 查看当前对话的操作权限，按界面提示进行选择。

4.4 检查结果并继续

如果项目使用 Git，可在另一个终端窗口进入同一项目，查看未提交改动：

git status --short
git diff

git diff 默认显示已跟踪文件的未暂存差异，不包括新增文件内容或已暂存差异。查看暂存内容使用 git diff --cached；新增文件需要直接打开检查。这些改动也可能包含任务开始前已有的工作。

需要继续调整时，在原对话中描述实际结果、预期结果和修改范围：

现在页码已重置，但列表没有刷新。
预期是切换筛选条件后立即请求新数据。

请只修复这一问题，补充并运行相关测试，
最后说明修改与检查结果。先不要提交或推送代码。

4.5 常用快捷键

5. 常用命令与会话接续

5.1 区分两类命令

不要把 npm install 等安装命令作为任务提示词发送给 Remy。

5.2 常用交互命令

开始新对话或继续历史对话前，确认当前任务已经结束，并检查项目中的实际文件状态。

5.3 查看历史对话

在系统终端中执行：

remy history list

该命令列出当前账号范围下、当前项目的历史对话。进入交互界面后，可以使用 /resume 或 Ctrl+R 选择对话并继续。

历史记录的可见范围与登录账号、团队范围和项目目录有关。不要将本机历史记录的可见性理解为所有设备自动同步。

5.4 执行一次性任务

对于目标清楚、无需持续往返沟通的任务，可以直接使用：

remy exec "阅读当前项目的 README，概括启动和测试方法。只分析，不修改文件。"

命令会执行该次任务并输出结果。需要持续补充要求时，使用 remy 进入交互模式。

需要提供本地资料时，可以附加文件：

remy exec --attach "./requirements.md" "阅读这份需求，结合当前项目列出涉及的模块和实施步骤。先不修改文件。"

将文件路径替换为真实存在的文件。更多参数可以通过以下命令查看：

remy exec --help

6. 更新 Remy CLI

6.1 查看版本

remy --version

6.2 更新默认版本

先完成当前任务并退出 Remy 交互界面，再运行：

npm install -g @corepassinc/remy

完成后重新检查：

remy --version
remy --help

如果更新后仍显示旧版本，检查系统实际找到的命令路径：

command -v remy
npm prefix -g

使用 Node.js 版本管理工具时，不同 Node.js 环境可能使用不同的全局安装目录；切换环境后，应在当前环境中确认 Remy 的安装和路径。

7. 常见问题与已知限制

7.1 安装与运行问题

7.2 使用范围

• 本指南覆盖 macOS 的 Apple 芯片和 Intel 版本。
• 本地任务依赖当前电脑、终端会话和项目环境；保持任务所需环境可用。
• 不同端的工具入口有所区别。CLI 中的可选工具是否可用，以诊断结果和实际配置为准。
• CLI 当前不支持对单条回复提交赞／踩；产品问题使用下一章的反馈命令。
• 对话接续不等于文件回滚，继续工作前检查实际文件状态。

8. 获取帮助与提交反馈

8.1 查看帮助

remy --help
remy doctor --help
remy feedback send --help

在 Remy 交互界面中，使用 /help 查看命令，使用 Ctrl+G 查看快捷键。

8.2 准备问题描述

将问题描述保存为 UTF-8 文本文件，例如 feedback.txt，说明复现步骤、预期与实际结果，并附上错误提示及版本信息。

8.3 预览并提交

先预览：

remy feedback send --type bug --impact moderate --description-file "./feedback.txt" --dry-run

--dry-run 只展示预览，不发送报告。确认描述和反馈选项正确后，去掉该参数再次执行：

remy feedback send --type bug --impact moderate --description-file "./feedback.txt"

CLI 会先显示预览，再要求输入 send 确认提交。输入其他内容可以取消。

请根据真实问题选择类型和影响程度，不必沿用示例中的 bug 与 moderate。

以命令明确返回提交成功及反馈编号为准。如果返回 Result unknown，说明没有取得可靠的提交结果；先向支持人员核对，避免重复提交。

CLI 无法启动、登录或使用反馈命令时，可以联系运营支持：support@corepass.com。

8.4 继续阅读