跳轉到主要內容

Documentation Index

Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
快速開始

​
Gateway 模式

  1. 啟動 Gateway。
openclaw gateway
  1. 開啟 TUI。
openclaw tui
  1. 輸入訊息並按 Enter。
遠端 Gateway： 
openclaw tui --url ws://<host>:<port> --token <gateway-token>
如果你的 Gateway 使用密碼驗證，請使用 --password。

​
本機模式

不透過 Gateway 執行 TUI： 
openclaw chat
# or
openclaw tui --local
注意事項：
  • openclaw chat 和 openclaw terminal 是 openclaw tui --local 的別名。
  • --local 不能與 --url、--token 或 --password 合併使用。
  • 本機模式會直接使用嵌入式代理程式執行階段。大多數本機工具都可使用，但僅限 Gateway 的功能無法使用。
  • openclaw 和 openclaw crestodian 也使用這個 TUI shell，其中 Crestodian 作為本機設定與修復聊天後端。

​
你會看到什麼

  • 標頭：連線 URL、目前代理程式、目前工作階段。
  • 聊天記錄：使用者訊息、助理回覆、系統通知、工具卡片。
  • 狀態列：連線/執行狀態（連線中、執行中、串流中、閒置、錯誤）。
  • 頁尾：連線狀態 + 代理程式 + 工作階段 + 模型 + 思考/快速/詳細/追蹤/推理 + Token 數 + 傳送。
  • 輸入：具備自動完成的文字編輯器。

​
心智模型：代理程式 + 工作階段

  • 代理程式是唯一的 slug（例如 main、research）。Gateway 會公開這份清單。
  • 工作階段屬於目前代理程式。
  • 工作階段鍵會儲存為 agent:<agentId>:<sessionKey>。
    • 如果你輸入 /session main，TUI 會將它展開為 agent:<currentAgent>:main。
    • 如果你輸入 /session agent:other:main，你會明確切換到該代理程式工作階段。
  • 工作階段範圍：
    • per-sender（預設）：每個代理程式有多個工作階段。
    • global：TUI 一律使用 global 工作階段（選擇器可能是空的）。
  • 目前代理程式 + 工作階段一律會顯示在頁尾。

​
傳送 + 交付

  • 訊息會傳送到 Gateway；預設不會交付給提供者。
  • 開啟交付：
    • /deliver on
    • 或使用設定面板
    • 或以 openclaw tui --deliver 啟動

​
選擇器 + 覆疊層

  • 模型選擇器：列出可用模型並設定工作階段覆寫。
  • 代理程式選擇器：選擇不同的代理程式。
  • 工作階段選擇器：只顯示目前代理程式的工作階段。
  • 設定：切換交付、工具輸出展開，以及思考可見性。

​
鍵盤快捷鍵

  • Enter：傳送訊息
  • Esc：中止作用中的執行
  • Ctrl+C：清除輸入（按兩次以結束）
  • Ctrl+D：結束
  • Ctrl+L：模型選擇器
  • Ctrl+G：代理程式選擇器
  • Ctrl+P：工作階段選擇器
  • Ctrl+O：切換工具輸出展開
  • Ctrl+T：切換思考可見性（重新載入歷史記錄）

​
斜線指令

核心：
  • /help
  • /status
  • /agent <id>（或 /agents）
  • /session <key>（或 /sessions）
  • /model <provider/model>（或 /models）
工作階段控制：
  • /think <off|minimal|low|medium|high>
  • /fast <status|on|off>
  • /verbose <on|full|off>
  • /trace <on|off>
  • /reasoning <on|off|stream>
  • /usage <off|tokens|full>
  • /elevated <on|off|ask|full>（別名：/elev）
  • /activation <mention|always>
  • /deliver <on|off>
工作階段生命週期：
  • /new 或 /reset（重設工作階段）
  • /abort（中止作用中的執行）
  • /settings
  • /exit
僅限本機模式：
  • /auth [provider] 會在 TUI 內開啟提供者驗證/登入流程。
其他 Gateway 斜線指令（例如 /context）會轉送到 Gateway，並顯示為系統輸出。請參閱斜線指令。

​
本機 shell 指令

  • 在一行前加上 !，即可在 TUI 主機上執行本機 shell 指令。
  • TUI 會在每個工作階段提示一次，以允許本機執行；拒絕後會在該工作階段停用 !。
  • 指令會在 TUI 工作目錄中的全新非互動式 shell 執行（沒有持續性的 cd/env）。
  • 本機 shell 指令會在其環境中收到 OPENCLAW_SHELL=tui-local。
  • 單獨的 ! 會作為一般訊息傳送；前置空白不會觸發本機執行。

​
從本機 TUI 修復設定

當目前設定已通過驗證，且你希望嵌入式代理程式在同一台機器上檢查設定、與文件比對，並在不依賴執行中的 Gateway 的情況下協助修復漂移時，請使用本機模式。 如果 openclaw config validate 已經失敗，請先從 openclaw configure 或 openclaw doctor --fix 開始。openclaw chat 不會繞過無效設定防護。 典型流程：
  1. 啟動本機模式：
openclaw chat
  1. 詢問代理程式你想檢查的內容，例如：
Compare my gateway auth config with the docs and suggest the smallest fix.
  1. 使用本機 shell 指令取得精確證據與驗證：
!openclaw config file
!openclaw docs gateway auth token secretref
!openclaw config validate
!openclaw doctor
  1. 使用 openclaw config set 或 openclaw configure 套用範圍狹窄的變更，然後重新執行 !openclaw config validate。
  2. 如果 Doctor 建議自動遷移或修復，請先檢閱，然後執行 !openclaw doctor --fix。
提示：
  • 優先使用 openclaw config set 或 openclaw configure，而不是手動編輯 openclaw.json。
  • openclaw docs "<query>" 會從同一台機器搜尋即時文件索引。
  • 當你需要結構化結構描述與 SecretRef/可解析性錯誤時，openclaw config validate --json 很有用。

​
工具輸出

  • 工具呼叫會顯示為含有引數 + 結果的卡片。
  • Ctrl+O 會在收合/展開檢視之間切換。
  • 工具執行期間，部分更新會串流到同一張卡片中。

​
終端機色彩

  • TUI 會讓助理本文文字使用你終端機的預設前景色，因此深色與淺色終端機都能保持可讀。
  • 如果你的終端機使用淺色背景且自動偵測錯誤，請在啟動 openclaw tui 前設定 OPENCLAW_THEME=light。
  • 若要改為強制使用原始深色調色盤，請設定 OPENCLAW_THEME=dark。

​
歷史記錄 + 串流

  • 連線時，TUI 會載入最新歷史記錄（預設 200 則訊息）。
  • 串流回應會原地更新，直到完成。
  • TUI 也會監聽代理程式工具事件，以提供更豐富的工具卡片。

​
連線詳細資料

  • TUI 會以 mode: "tui" 向 Gateway 註冊。
  • 重新連線會顯示系統訊息；事件間隙會浮現在記錄中。

​
選項

  • --local：針對本機嵌入式代理程式執行階段執行
  • --url <url>：Gateway WebSocket URL（預設為設定或 ws://127.0.0.1:<port>）
  • --token <token>：Gateway Token（如有需要）
  • --password <password>：Gateway 密碼（如有需要）
  • --session <key>：工作階段鍵（預設：main，或當範圍為全域時使用 global）
  • --deliver：將助理回覆交付給提供者（預設關閉）
  • --thinking <level>：覆寫傳送時的思考層級
  • --message <text>：連線後傳送初始訊息
  • --timeout-ms <ms>：代理程式逾時毫秒數（預設為 agents.defaults.timeoutSeconds）
  • --history-limit <n>：要載入的歷史項目數（預設 200）
當你設定 --url 時，TUI 不會退回使用設定或環境認證。請明確傳入 --token 或 --password。缺少明確認證會是錯誤。在本機模式中，請勿傳入 --url、--token 或 --password。

​
疑難排解

傳送訊息後沒有輸出：
  • 在 TUI 中執行 /status，確認 Gateway 已連線且處於閒置/忙碌狀態。
  • 檢查 Gateway 記錄：openclaw logs --follow。
  • 確認代理程式可以執行：openclaw status 和 openclaw models status。
  • 如果你預期在聊天頻道中看到訊息，請啟用交付（/deliver on 或 --deliver）。

​
連線疑難排解

  • disconnected：確認 Gateway 正在執行，且你的 --url/--token/--password 正確。
  • 選擇器中沒有代理程式：檢查 openclaw agents list 與你的路由設定。
  • 工作階段選擇器為空：你可能位於全域範圍，或尚未有任何工作階段。

​
相關

  • 控制 UI — 網頁式控制介面
  • 設定 — 檢查、驗證及編輯 openclaw.json
  • Doctor — 引導式修復與遷移檢查
  • CLI 參考 — 完整 CLI 指令參考