diff --git a/docs/cli/onboard.md b/docs/cli/onboard.md index f8045e31477..8408d7d3437 100644 --- a/docs/cli/onboard.md +++ b/docs/cli/onboard.md @@ -11,11 +11,23 @@ Interactive onboarding for local or remote Gateway setup. ## Related guides -- CLI onboarding hub: [Onboarding (CLI)](/start/wizard) -- Onboarding overview: [Onboarding Overview](/start/onboarding-overview) -- CLI onboarding reference: [CLI Setup Reference](/start/wizard-cli-reference) -- CLI automation: [CLI Automation](/start/wizard-cli-automation) -- macOS onboarding: [Onboarding (macOS App)](/start/onboarding) + + + Walkthrough of the interactive CLI flow. + + + How OpenClaw onboarding fits together. + + + Outputs, internals, and per-step behavior. + + + Non-interactive flags and scripted setups. + + + Onboarding flow for the macOS menu bar app. + + ## Examples @@ -132,10 +144,11 @@ Interactive onboarding behavior with reference mode: - Onboarding performs a fast preflight validation before saving the ref. - If validation fails, onboarding shows the error and lets you retry. -Non-interactive Z.AI endpoint choices: +### Non-interactive Z.AI endpoint choices -Note: `--auth-choice zai-api-key` now auto-detects the best Z.AI endpoint for your key (prefers the general API with `zai/glm-5.1`). -If you specifically want the GLM Coding Plan endpoints, pick `zai-coding-global` or `zai-coding-cn`. + +`--auth-choice zai-api-key` auto-detects the best Z.AI endpoint for your key (prefers the general API with `zai/glm-5.1`). If you specifically want the GLM Coding Plan endpoints, pick `zai-coding-global` or `zai-coding-cn`. + ```bash # Promptless endpoint selection @@ -157,26 +170,30 @@ openclaw onboard --non-interactive \ --mistral-api-key "$MISTRAL_API_KEY" ``` -Flow notes: +## Flow notes -- `quickstart`: minimal prompts, auto-generates a gateway token. -- `manual`: full prompts for port/bind/auth (alias of `advanced`). -- When an auth choice implies a preferred provider, onboarding prefilters the - default-model and allowlist pickers to that provider. For Volcengine and - BytePlus, this also matches the coding-plan variants - (`volcengine-plan/*`, `byteplus-plan/*`). -- If the preferred-provider filter yields no loaded models yet, onboarding - falls back to the unfiltered catalog instead of leaving the picker empty. -- In the web-search step, some providers can trigger provider-specific - follow-up prompts: - - **Grok** can offer optional `x_search` setup with the same `XAI_API_KEY` - and an `x_search` model choice. - - **Kimi** can ask for the Moonshot API region (`api.moonshot.ai` vs - `api.moonshot.cn`) and the default Kimi web-search model. -- Local onboarding DM scope behavior: [CLI Setup Reference](/start/wizard-cli-reference#outputs-and-internals). -- Fastest first chat: `openclaw dashboard` (Control UI, no channel setup). -- Custom Provider: connect any OpenAI or Anthropic compatible endpoint, - including hosted providers not listed. Use Unknown to auto-detect. + + + - `quickstart`: minimal prompts, auto-generates a gateway token. + - `manual`: full prompts for port, bind, and auth (alias of `advanced`). + + + When an auth choice implies a preferred provider, onboarding prefilters the default-model and allowlist pickers to that provider. For Volcengine and BytePlus, this also matches the coding-plan variants (`volcengine-plan/*`, `byteplus-plan/*`). + + If the preferred-provider filter yields no loaded models yet, onboarding falls back to the unfiltered catalog instead of leaving the picker empty. + + + Some web-search providers trigger provider-specific follow-up prompts: + + - **Grok** can offer optional `x_search` setup with the same `XAI_API_KEY` and an `x_search` model choice. + - **Kimi** can ask for the Moonshot API region (`api.moonshot.ai` vs `api.moonshot.cn`) and the default Kimi web-search model. + + + - Local onboarding DM scope behavior: [CLI setup reference](/start/wizard-cli-reference#outputs-and-internals). + - Fastest first chat: `openclaw dashboard` (Control UI, no channel setup). + - Custom provider: connect any OpenAI or Anthropic compatible endpoint, including hosted providers not listed. Use Unknown to auto-detect. + + ## Common follow-up commands