跳轉到主要內容

Documentation Index

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

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

CLI onboarding 是在 macOS、Linux 或 Windows（透過 WSL2；強烈建議）上設定 OpenClaw 的建議方式。 它會在單一引導流程中設定本機 Gateway 或遠端 Gateway 連線，以及頻道、Skills 和工作區預設值。 
openclaw onboard
最快開始第一次聊天：開啟控制 UI（不需要設定頻道）。執行 openclaw dashboard，然後在瀏覽器中聊天。文件：儀表板。
若要稍後重新設定： 
openclaw configure
openclaw agents add <name>
--json 不代表非互動模式。用於腳本時，請使用 --non-interactive。
CLI onboarding 包含一個網頁搜尋步驟，你可以在其中選擇 Brave、DuckDuckGo、Exa、Firecrawl、Gemini、Grok、Kimi、MiniMax Search、Ollama Web Search、Perplexity、SearXNG 或 Tavily 等供應商。有些供應商需要 API 金鑰，其他則不需要金鑰。你也可以稍後使用 openclaw configure --section web 設定此項。文件：網頁工具。

​
快速開始與進階

onboarding 會從快速開始（預設值）與進階（完整控制）開始。
  • 本機 Gateway（loopback）
  • 工作區預設值（或現有工作區）
  • Gateway 連接埠 18789
  • Gateway 驗證 Token（自動產生，即使在 loopback 上也是如此）
  • 新本機設定的工具政策預設值：tools.profile: "coding"（會保留現有明確設定檔）
  • DM 隔離預設值：本機 onboarding 會在未設定時寫入 session.dmScope: "per-channel-peer"。詳細資訊：CLI 設定參考
  • Tailscale 暴露關閉
  • Telegram + WhatsApp DM 預設為允許清單（系統會提示你輸入電話號碼）

​
onboarding 會設定的內容

**本機模式（預設）**會引導你完成以下步驟：
  1. 模型/驗證 — 選擇任何支援的供應商/驗證流程（API 金鑰、OAuth 或供應商特定手動驗證），包括自訂供應商 （OpenAI 相容、Anthropic 相容或未知自動偵測）。選擇預設模型。 安全性注意事項：如果此代理將執行工具或處理 webhook/hooks 內容，請優先使用可用的最強最新世代模型，並保持嚴格的工具政策。較弱/較舊的等級更容易被提示注入。 對於非互動執行，--secret-input-mode ref 會將環境變數支援的 ref 儲存在驗證設定檔中，而不是純文字 API 金鑰值。 在非互動 ref 模式中，必須設定供應商環境變數；若在沒有該環境變數的情況下傳入行內金鑰旗標，會快速失敗。 在互動執行中，選擇密鑰參照模式可讓你指向環境變數或已設定的供應商 ref（file 或 exec），並在儲存前進行快速預檢驗證。 對於 Anthropic，互動式 onboarding/configure 會提供 Anthropic Claude CLI 作為偏好的本機路徑，並提供 Anthropic API key 作為建議的正式環境路徑。Anthropic setup-token 也仍可作為支援的 token 驗證路徑。
  2. 工作區 — 代理檔案的位置（預設 ~/.openclaw/workspace）。植入啟動檔案。
  3. Gateway — 連接埠、綁定位址、驗證模式、Tailscale 暴露。 在互動式 token 模式中，選擇預設純文字 token 儲存，或選擇使用 SecretRef。 非互動 token SecretRef 路徑：--gateway-token-ref-env <ENV_VAR>。
  4. 頻道 — 內建和隨附的聊天頻道，例如 iMessage、Discord、Feishu、Google Chat、Mattermost、Microsoft Teams、QQ Bot、Signal、Slack、Telegram、WhatsApp 等。
  5. Daemon — 安裝 LaunchAgent（macOS）、systemd 使用者單元（Linux/WSL2），或原生 Windows 排定的工作，並提供每位使用者的 Startup 資料夾備援。 如果 token 驗證需要 token，且 gateway.auth.token 由 SecretRef 管理，daemon 安裝會驗證它，但不會將解析後的 token 持久化到監督服務環境中繼資料。 如果 token 驗證需要 token，且已設定的 token SecretRef 無法解析，daemon 安裝會被封鎖並提供可操作的指引。 如果同時設定了 gateway.auth.token 和 gateway.auth.password，且 gateway.auth.mode 未設定，daemon 安裝會被封鎖，直到明確設定模式。
  6. 健康檢查 — 啟動 Gateway 並驗證它正在執行。
  7. Skills — 安裝建議的 Skills 和選用相依項。
除非你明確選擇重設（或傳入 --reset），否則重新執行 onboarding 不會清除任何內容。 CLI --reset 預設會重設設定、憑證和工作階段；使用 --reset-scope full 以包含工作區。 如果設定無效或包含舊版鍵，onboarding 會要求你先執行 openclaw doctor。
遠端模式只會設定本機用戶端以連線到其他位置的 Gateway。 它不會在遠端主機上安裝或變更任何內容。

​
新增另一個代理

使用 openclaw agents add <name> 建立具有自己的工作區、 工作階段和驗證設定檔的獨立代理。在沒有 --workspace 的情況下執行會啟動 onboarding。 它會設定：
  • agents.list[].name
  • agents.list[].workspace
  • agents.list[].agentDir
注意事項：
  • 預設工作區遵循 ~/.openclaw/workspace-<agentId>。
  • 新增 bindings 以路由傳入訊息（onboarding 可以執行此操作）。
  • 非互動旗標：--model、--agent-dir、--bind、--non-interactive。

​
完整參考

如需詳細的逐步拆解與設定輸出，請參閱 CLI 設定參考。 如需非互動範例，請參閱 CLI 自動化。 如需更深入的技術參考，包括 RPC 詳細資訊，請參閱 onboarding 參考。

​
相關文件