OpenClawDocs
View as MarkdownView this page as plain textOpen in ChatGPTAsk questions about this pageOpen in ClaudeAsk questions about this page

Guides

命令列介面設定參考資料

本頁涵蓋逐步的新手設定行為、輸出與內部機制。 如需操作說明，請參閱新手設定（命令列介面）。如需完整的命令列介面旗標 參考（每個 --flag、非互動式範例、供應商特定 命令），請參閱 openclaw onboard。

精靈的功能

本機模式（預設）會引導你完成：

  • 模型與驗證設定（Anthropic、OpenAI Code 訂閱 OAuth、xAI、OpenCode、自訂端點，以及更多由供應商擁有的驗證流程）
  • 工作區位置與啟動檔案
  • 閘道設定（連接埠、繫結、驗證、Tailscale）
  • 頻道與供應商（Discord、Feishu、Google Chat、iMessage、Mattermost、Microsoft Teams、QQ Bot、Signal、Slack、Telegram、WhatsApp，以及其他內建或外掛頻道）
  • 網頁搜尋供應商（選用）
  • 常駐程式安裝（LaunchAgent、systemd 使用者單元，或原生 Windows 排定的工作，並以「啟動」資料夾作為備援）
  • 健康狀態檢查
  • Skills 設定

遠端模式會設定此機器以連線至其他位置的閘道。它不會 在遠端主機上安裝或修改任何內容。

本機流程詳細資料

  • 偵測現有設定

    • 如果 ~/.openclaw/openclaw.json 存在，請選擇保留目前的值、檢閱並更新或設定前重設。
    • 除非你明確選擇「重設」（或傳入 --reset），否則再次執行精靈不會清除任何內容。
    • 命令列介面 --reset 預設為 config+creds+sessions；使用 --reset-scope full 也一併移除工作區。
    • 如果設定無效或包含舊版鍵值，精靈會停止，並要求你先執行 openclaw doctor 再繼續。
    • 重設會將狀態移至「垃圾桶」（絕不直接刪除），並提供以下範圍：
      • 僅設定
      • 設定 + 認證資訊 + 工作階段
      • 完整重設（也會移除工作區）

  • 模型與驗證

  • 工作區

    • 預設為 ~/.openclaw/workspace（可設定）。
    • 建立首次執行啟動程序所需的工作區檔案。
    • 再次執行時，現有的代理程式名冊會保留其整個機群共用的工作區，除非 你明確確認移動。非互動式的再次執行會發出警告並保留 目前的值。
    • 工作區配置：代理程式工作區。

  • 閘道

    • 提示輸入連接埠、繫結、驗證模式與 Tailscale 公開設定。
    • 建議：即使使用回送介面，也請保持啟用權杖驗證，以要求本機 WS 用戶端進行驗證。
    • 在權杖模式中，互動式設定提供：
      • 產生／儲存純文字權杖（預設）
      • 使用 SecretRef（選用）
    • 在密碼模式中，互動式設定也支援純文字或 SecretRef 儲存方式。
    • 非互動式權杖 SecretRef 路徑：--gateway-token-ref-env <ENV_VAR>。
      • 新手設定程序的環境中必須有非空白的環境變數。
      • 不能與 --gateway-token 搭配使用。
    • 只有在你完全信任所有本機程序時，才停用驗證。
    • 非回送繫結仍需要驗證。

  • 頻道

    • WhatsApp：選用的 QR 登入
    • Telegram：機器人權杖
    • Discord：機器人權杖
    • Google Chat：服務帳戶 JSON + 網路鉤子受眾
    • Mattermost：機器人權杖 + 基底 URL
    • Signal：選用的 signal-cli 安裝 + 帳戶設定
    • iMessage：imsg 命令列介面路徑 + Messages 資料庫存取權；當閘道不在 Mac 上執行時，請使用 SSH 包裝函式
    • 私訊安全性：預設採用配對。第一則私訊會傳送代碼；請透過 openclaw pairing approve <channel> <code> 核准，或使用允許清單。

  • 網頁搜尋

    • 選擇供應商（Brave、DuckDuckGo、Exa、Firecrawl、Gemini、Grok、Kimi、MiniMax Search、Ollama Web Search、Perplexity、SearXNG、Tavily）或略過。
    • 使用 --skip-search 略過此步驟；稍後使用 openclaw configure --section web 重新設定。

  • 安裝常駐程式

    • macOS：LaunchAgent
      • 需要已登入的使用者工作階段；若為無頭環境，請使用自訂 LaunchDaemon（未隨附）。
    • Linux 與透過 WSL2 執行的 Windows：systemd 使用者單元
      • 精靈會嘗試執行 loginctl enable-linger <user>，使閘道在登出後仍保持運作。
      • 可能會提示使用 sudo（寫入 /var/lib/systemd/linger）；它會先嘗試不使用 sudo。
    • 原生 Windows：優先使用排定的工作
      • 如果建立工作遭拒，OpenClaw 會退回使用每位使用者的「啟動」資料夾登入項目，並立即啟動閘道。
      • 排定的工作仍是首選，因為它們能提供較佳的監督程式狀態。
    • 執行階段選擇：必須使用節點，因為 OpenClaw 的標準執行階段狀態存放區使用 node:sqlite。

  • 健康狀態檢查

    • 啟動閘道（如有需要）並執行 openclaw health。
    • openclaw status --deep 會將即時閘道健康狀態探查加入狀態輸出，包括支援時的頻道探查。

  • Skills

    • 讀取可用的 Skills 並檢查需求。
    • 讓你選擇節點管理器：npm、pnpm 或 bun。
    • 當所需的安裝程式可用時，為受信任的內建 Skills 安裝選用 相依套件。
    • 略過不可用的 Homebrew、uv 與 Go 安裝程式，接著將受影響的 Skills 分組並提供手動設定指引。安裝缺少的必要條件後， 執行 openclaw doctor。

  • 完成

    • 摘要與後續步驟，包括 iOS、Android 與 macOS 應用程式選項。

    • 遠端模式詳細資料

    遠端模式會設定此機器以連線至其他位置的閘道。它不會 在遠端主機上安裝或修改任何內容。

    你需要設定：

    • 遠端閘道 URL（ws://... 或 wss://...）
    • 權杖、密碼或不使用驗證，須與遠端閘道的設定相符

  • 探索（選用）

    如果 dns-sd（macOS）或 avahi-browse（Linux）可用，新手設定 會先提供搜尋 Bonjour/mDNS 閘道信標的選項，再退回 手動輸入 URL。設定後也會嘗試廣域 DNS-SD 探索。 文件：閘道探索、Bonjour。

  • 連線方式

    選取信標時，請選擇直接 WebSocket 或 SSH 通道：

    • 直接連線：透過 wss:// 連線，並提示信任所探索到的 TLS 指紋（首次使用時信任固定機制；只有在你接受時才會固定）。
    • SSH 通道：印出要先執行的 ssh -N -L 18789:127.0.0.1:18789 <user>@<host> 命令，接著連線至本機通道端點。

  • 驗證

    選擇權杖（建議）、密碼或不使用驗證，接著可選擇將其儲存 為 SecretRef，而不是純文字。

    • 驗證與模型選項

    如果互動式新手設定中的供應商設定步驟失敗（例如命令列介面重用選項 沒有本機登入），精靈會顯示錯誤並返回供應商選擇器， 而不是結束。明確的 --auth-choice 執行仍會為了自動化而快速失敗。

    Anthropic API 金鑰

    如果存在 ANTHROPIC_API_KEY，便使用該值，否則提示輸入金鑰，接著儲存供常駐程式使用。

    Anthropic Claude 命令列介面

    互動式新手設定／設定中的首選本機路徑；可用時會重用現有的 Claude 命令列介面登入。

    OpenAI Code 訂閱（OAuth）

    瀏覽器流程；貼上 code#state。

    在沒有主要模型的全新設定中，會透過 Codex 執行階段將 agents.defaults.model 設為 openai/gpt-5.6-sol。

    OpenAI Code 訂閱（裝置配對）

    使用短效裝置代碼的瀏覽器配對流程。

    在沒有主要模型的全新設定中，會透過 Codex 執行階段將 agents.defaults.model 設為 openai/gpt-5.6-sol。

    OpenAI API 金鑰

    如果存在 OPENAI_API_KEY，便使用該值，否則提示輸入金鑰，接著將認證資訊儲存在驗證設定檔中。

    在沒有主要模型的全新設定中，會將 agents.defaults.model 設為 openai/gpt-5.6；未加限定的直接 API 模型 ID 會解析至 Sol 層級。

    新增或重新驗證 OpenAI 時，會保留現有明確指定的主要 模型，包括 openai/gpt-5.5。如果帳戶未提供 GPT-5.6， 請明確選取 openai/gpt-5.5；OpenClaw 不會自動將其降級。

    xAI (Grok) OAuth

    適用於符合資格的 SuperGrok 或 X Premium 帳號，以瀏覽器登入。對多數使用者而言，這是 建議使用的 xAI 方式。OpenClaw 會儲存產生的 Grok 模型驗證 設定檔、Grok web_search、x_search 和 code_execution。

    xAI (Grok) 裝置代碼

    適合遠端使用的瀏覽器登入方式，以短代碼取代 localhost 回呼。請從 SSH、Docker 或 VPS 主機使用此方式。

    xAI (Grok) API 金鑰

    提示輸入 XAI_API_KEY，並將 xAI 設定為模型供應商。當你想使用 xAI Console API 金鑰，而非訂閱 OAuth 時，請使用此方式。

    OpenCode

    提示輸入 OPENCODE_API_KEY（或 OPENCODE_ZEN_API_KEY），並讓你選擇 Zen 或 Go 目錄（一個 API 金鑰可同時涵蓋兩者）。 設定網址：opencode.ai/auth。

    API 金鑰（通用）

    為你儲存金鑰。

    Vercel AI Gateway

    提示輸入 AI_GATEWAY_API_KEY。 更多詳細資訊：Vercel AI Gateway。

    Cloudflare AI Gateway

    提示輸入帳號 ID、閘道 ID 和 CLOUDFLARE_AI_GATEWAY_API_KEY。 更多詳細資訊：Cloudflare AI Gateway。

    MiniMax

    系統會自動寫入設定。託管服務預設為 MiniMax-M3；API 金鑰設定使用 minimax/...，OAuth 設定則使用 minimax-portal/...。 更多詳細資訊：MiniMax。

    StepFun

    系統會為中國或全球端點的 StepFun 標準方案或 Step Plan 自動寫入設定。 標準方案目前包含 step-3.5-flash，Step Plan 也包含 step-3.5-flash-2603。 更多詳細資訊：StepFun。

    Synthetic（相容 Anthropic）

    提示輸入 SYNTHETIC_API_KEY。 更多詳細資訊：Synthetic。

    Ollama（雲端與本機開放模型）

    先提示輸入 Cloud + Local、Cloud only 或 Local only。 Cloud only 使用 OLLAMA_API_KEY 搭配 https://ollama.com。 由主機支援的模式會提示輸入基礎 URL（預設為 http://127.0.0.1:11434）、探索可用模型，並建議預設值。 Cloud + Local 也會檢查該 Ollama 主機是否已登入，以使用雲端存取。 更多詳細資訊：Ollama。

    Moonshot 與 Kimi Coding

    系統會自動寫入 Moonshot（Kimi K2）和 Kimi Coding 設定。 更多詳細資訊：Moonshot AI（Kimi + Kimi Coding）。

    自訂供應商

    適用於相容 OpenAI、相容 OpenAI Responses，以及相容 Anthropic 的端點。

    互動式初始設定支援與其他供應商 API 金鑰流程相同的 API 金鑰儲存選項：

    • 立即貼上 API 金鑰（純文字）
    • 使用秘密參照（環境變數參照或已設定的供應商參照，並進行預先驗證）

    初始設定會推斷常見視覺模型 ID（GPT-4o/4.1/5.x、Claude 3/4、Gemini、Qwen-VL、LLaVA、Pixtral 等）是否支援影像，只有模型名稱未知時才會詢問。

    非互動式旗標：

    • --auth-choice custom-api-key
    • --custom-base-url
    • --custom-model-id
    • --custom-api-key（選用；回退至 CUSTOM_API_KEY）
    • --custom-provider-id（選用）
    • --custom-compatibility <openai|openai-responses|anthropic>（選用；預設為 openai）
    • --custom-image-input / --custom-text-input（選用；覆寫推斷的模型輸入能力）
    略過

    保持驗證未設定狀態。

    模型行為：

    • 從偵測到的選項中選取預設模型，或手動輸入供應商和模型。
    • 當初始設定從供應商驗證選項開始時，模型選擇器會自動優先顯示 該供應商。對於 Volcengine 和 BytePlus，相同的偏好設定 也會比對其程式設計方案變體（volcengine-plan/*、 byteplus-plan/*）。
    • 如果套用偏好供應商篩選器後沒有任何項目，選擇器會回退至 完整目錄，而不是不顯示任何模型。
    • 精靈會執行模型檢查，並在已設定的模型未知或缺少驗證時提出警告。

    認證資訊與設定檔路徑：

    • 驗證設定檔（API 金鑰 + OAuth）：~/.openclaw/agents/<agentId>/agent/auth-profiles.json
    • 舊版 OAuth 匯入：~/.openclaw/credentials/oauth.json

    認證資訊儲存模式：

    • 預設初始設定行為會將 API 金鑰以純文字值持久儲存在驗證設定檔中。
    • --secret-input-mode ref 會啟用參照模式，而非以純文字儲存金鑰。 在互動式設定中，你可以選擇：
      • 環境變數參照（例如 keyRef: { source: "env", provider: "default", id: "OPENAI_API_KEY" }）
      • 已設定的供應商參照（file 或 exec），包含供應商別名 + ID
    • 互動式參照模式會在儲存前執行快速預先驗證。
      • 環境變數參照：驗證目前初始設定環境中的變數名稱與非空白值。
      • 供應商參照：驗證供應商設定並解析要求的 ID。
      • 如果預先驗證失敗，初始設定會顯示錯誤並讓你重試。
    • 在非互動式模式中，--secret-input-mode ref 僅由環境變數支援。
      • 請在初始設定程序環境中設定供應商環境變數。
      • 內嵌金鑰旗標（例如 --openai-api-key）要求必須設定該環境變數；否則初始設定會立即失敗。
      • 對於自訂供應商，非互動式 ref 模式會將 models.providers.<id>.apiKey 儲存為 { source: "env", provider: "default", id: "CUSTOM_API_KEY" }。
      • 在該自訂供應商情況下，--custom-api-key 要求必須設定 CUSTOM_API_KEY；否則初始設定會立即失敗。
    • 閘道驗證認證資訊在互動式設定中支援純文字和 SecretRef 選項：
      • 權杖模式：產生／儲存純文字權杖（預設）或使用 SecretRef。
      • 密碼模式：純文字或 SecretRef。
    • 非互動式權杖 SecretRef 路徑：--gateway-token-ref-env &lt;ENV_VAR&gt;。
    • 現有的純文字設定會繼續運作，不需變更。

    輸出與內部機制

    ~/.openclaw/openclaw.json 中的常見欄位：

    • agents.defaults.workspace
    • 傳遞 --skip-bootstrap 時的 agents.defaults.skipBootstrap
    • agents.defaults.model / models.providers（如果選擇 Minimax）
    • tools.profile（未設定時，本機初始設定預設為 "coding"；現有的明確值會予以保留）
    • gateway.*（模式、繫結、驗證、Tailscale）
    • session.dmScope（初始設定會保留明確值，否則維持未設定，讓 main 預設值將所有頻道的私人訊息保留在代理程式持續輪替的主要工作階段中——這是個人代理程式的預設值。對於共用或多使用者收件匣，請使用 per-channel-peer；當 openclaw security audit 偵測到多使用者私人訊息流量時，會建議隔離）
    • channels.telegram.botToken、channels.discord.token、channels.matrix.*、channels.signal.*、channels.imessage.*
    • 在提示期間選擇加入時的頻道允許清單（Discord、iMessage、Signal、Slack、Telegram、WhatsApp）；Discord 和 Slack 也會將輸入的名稱解析為 ID
    • skills.install.nodeManager
      • setup --node-manager 旗標接受 npm、pnpm 或 bun。
      • 之後仍可透過手動設定來設定 skills.install.nodeManager: "yarn"。
    • wizard.lastRunAt
    • wizard.lastRunVersion
    • wizard.lastRunCommit
    • wizard.lastRunCommand
    • wizard.lastRunMode
    • wizard.securityAcknowledgedAt

    openclaw agents add 會寫入 agents.entries.* 和選用的 bindings。

    WhatsApp 認證資訊位於 ~/.openclaw/credentials/whatsapp/<accountId>/ 下。 作用中的工作階段和文字記錄儲存在 ~/.openclaw/agents/<agentId>/agent/openclaw-agent.sqlite。~/.openclaw/agents/<agentId>/sessions/ 目錄用於舊版移轉輸入和封存／支援成品。

    已安裝應用程式建議

    模型存取檢查成功後，macOS 上的傳統互動式初始設定會掃描應用程式名稱和套件 ID，且不會要求 macOS 隱私權限。它會搜尋官方外掛目錄和 ClawHub，接著要求已設定的模型排除錯誤的名稱比對結果，並建議相關外掛或 Skills。建議的比對項目預設會被選取；選用的比對項目則需要明確選取。

    結果畫面會列出偵測到的應用程式，並顯示：“應用程式名稱是使用你已設定的模型和 ClawHub 搜尋進行比對。”將 wizard.appRecommendations 設為 false，即可停用此初始設定步驟，以及閘道對節點應用程式清單的存取。快速入門或非 macOS 初始設定不會使用此掃描。

    非互動式設定

    --non-interactive 需要 --accept-risk（表示你瞭解代理程式功能強大， 而完整的系統存取權限具有風險）：

    bash
    openclaw onboard --non-interactive --accept-risk \  --auth-choice apiKey \  --anthropic-api-key "$ANTHROPIC_API_KEY"

    完整旗標參考與供應商特定範例：openclaw onboard、命令列介面自動化。

    閘道精靈 RPC

    • wizard.start
    • wizard.next
    • wizard.cancel
    • wizard.status

    用戶端（macOS 應用程式和控制介面）無須重新實作初始設定邏輯，即可呈現各個步驟。

    Signal 設定行為

    • 從官方 signal-cli GitHub 發行版本下載適當的發行成品（原生組建，僅限 Linux x86-64）
    • 在其他平台（macOS、非 x64 Linux）上，則改為透過 Homebrew 安裝
    • 將發行成品安裝儲存在 ~/.openclaw/tools/signal-cli/<version>/ 下
    • 在設定中寫入 channels.signal.cliPath
    • 目前尚不支援原生 Windows；請在 WSL2 內執行初始設定，以取得 Linux 安裝路徑

    相關文件

    Was this useful?
    On this page

    On this page