需要從終端機檢查或操作 Oysterun 時,請使用本指南。你會找到受支援的產品模組、確認預定的 Host、分辨唯讀命令與會改變狀態的命令,並對受保護變更使用正確的 dry-run 與確認界線。
起始畫面:在擁有或能連到預定 Host 的機器上開啟終端機。請勿從猜測 action 名稱開始。
oysterun --help 在乾淨終端機中顯示命令格式與目前受支援的模組。執行最上層說明命令:
oysterun --help
目前 CLI 會在 Product modules 下列出:
auth, sessions, chat, scheduler, mail, notifications, website, telegram
ok、sessions status,並在 result envelope 中顯示預定的確切 Session。有多個 Host 可用時,請提供明確的 --host。先從唯讀操作開始:
oysterun sessions list --host <HOST_ORIGIN> --json
如果你使用先前已核准的 dashboard CLI 存取權,可以在不變更 Session 的情況下檢查:
oysterun auth status --host <HOST_ORIGIN> --json
下列受支援的 action 會檢查目前狀態,不會要求產品變更:
| 模組 | 唯讀 action | 一般結果 |
|---|---|---|
| auth | status | 目前的 dashboard CLI 登入狀態 |
| sessions | list、status、url、profile get | Session 身分、狀態、URL 或 profile |
| chat | recent、messages、messages-around、search、loop list | 有界訊息、前後文、搜尋結果或 Loop 定義 |
| scheduler | list、get、runs、run-log | Schedules 及其已記錄的執行資訊 |
unread-count、list、get | Mail 計數、清單或單一項目 | |
| notifications | status | 目前的通知可用狀態 |
| website | status、url、validate、access get | Website 狀態、URL、驗證結果或存取模式 |
| telegram | status;sessions telegram get | Telegram 或每個 Session 的 Telegram 狀態 |
需要結構化 envelope 時加入 --json。其中包含 ok、command、contract、result 與 error。
下列 action 類別會在必要輸入與授權通過後改變產品狀態。沒有出現確認提示,並不會讓它們變安全:
| 模組 | 立即改變狀態的 action | 可能改變的內容 |
|---|---|---|
| auth | login、logout | CLI 登入狀態 |
| sessions | start、profile update、rename、resume、branch-resume、Telegram enable/disable/update | Sessions 或 Session profile 設定 |
| chat | send;Loop create、update、enable、disable | 訊息或 Loop 定義與狀態 |
| scheduler | create、update、enable、test-run | Schedules 或一次真正的測試執行 |
send、read、unread、archive、unarchive、update | Mail 傳送或項目狀態 | |
| notifications | send | 除非使用該 action 已記載的 dry run,否則會傳送通知 |
| website | init、enable | 除非使用該 action 已記載的 dry run,否則會改變 Website 檔案或啟用狀態 |
dry_run: true 和 POST /session/restart 預覽;受保護變更並未執行。下列目前操作具有強制確認界線:
| 範圍 | 受保護操作 | 界線 |
|---|---|---|
| Sessions | sessions stop、sessions interrupt、sessions restart | 單獨的 --confirm 或 --dry-run |
| Chat | chat loop delete | 單獨的 --confirm 或 --dry-run |
| Scheduler | scheduler disable、scheduler delete | 單獨的 --confirm 或 --dry-run |
mail delete | 單獨的 --confirm 或 --dry-run | |
| Website | website access set、website disable、website password set | 單獨的 --confirm 或 --dry-run |
先預覽確切操作。使用 --json,讓預定請求可見,而不是只看到簡短的人類可讀狀態:
oysterun sessions restart \
--host <HOST_ORIGIN> \
--session-id <SESSION_ID> \
--dry-run \
--json
dry_run: true。ok、command 與預期 result。失敗時,在修改命令前先閱讀 error。oysterun --help。不要嘗試相近的 action 名稱。dry_run: true:不要進入確認步驟。保留已遮蔽輸出並檢查目前的命令指南;切勿把未記載的 dry-run 當成安全測試。
active、alive 與 ready 是 lifecycle 與 readiness 欄位。這些欄位本身不能證明 provider 正在回應、輸入、被占用或產生有用進度。