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 延伸閱讀