diff --git a/docs/.i18n/glossary.zh-CN.json b/docs/.i18n/glossary.zh-CN.json index f8941862b94..36e44b6d909 100644 --- a/docs/.i18n/glossary.zh-CN.json +++ b/docs/.i18n/glossary.zh-CN.json @@ -47,6 +47,18 @@ "source": "Quick Start", "target": "快速开始" }, + { + "source": "Setup Wizard Reference", + "target": "设置向导参考" + }, + { + "source": "CLI Setup Reference", + "target": "CLI 设置参考" + }, + { + "source": "Setup Wizard (CLI)", + "target": "设置向导（CLI）" + }, { "source": "Docs directory", "target": "文档目录" diff --git a/docs/cli/index.md b/docs/cli/index.md index f99b04efece..ded970cde9d 100644 --- a/docs/cli/index.md +++ b/docs/cli/index.md @@ -317,7 +317,7 @@ Initialize config + workspace. Options: - `--workspace `: agent workspace path (default `~/.openclaw/workspace`). -- `--wizard`: run the onboarding wizard. +- `--wizard`: run the setup wizard. - `--non-interactive`: run wizard without prompts. - `--mode `: wizard mode. - `--remote-url `: remote Gateway URL. diff --git a/docs/cli/onboard.md b/docs/cli/onboard.md index 4b30e0d52b3..899ccd82713 100644 --- a/docs/cli/onboard.md +++ b/docs/cli/onboard.md @@ -1,5 +1,5 @@ --- -summary: "CLI reference for `openclaw onboard` (interactive onboarding wizard)" +summary: "CLI reference for `openclaw onboard` (interactive setup wizard)" read_when: - You want guided setup for gateway, workspace, auth, channels, and skills title: "onboard" @@ -7,13 +7,13 @@ title: "onboard" # `openclaw onboard` -Interactive onboarding wizard (local or remote Gateway setup). +Interactive setup wizard (local or remote Gateway setup). ## Related guides -- CLI onboarding hub: [Onboarding Wizard (CLI)](/start/wizard) +- CLI onboarding hub: [Setup Wizard (CLI)](/start/wizard) - Onboarding overview: [Onboarding Overview](/start/onboarding-overview) -- CLI onboarding reference: [CLI Onboarding Reference](/start/wizard-cli-reference) +- 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) @@ -140,7 +140,7 @@ Flow notes: - `quickstart`: minimal prompts, auto-generates a gateway token. - `manual`: full prompts for port/bind/auth (alias of `advanced`). -- Local onboarding DM scope behavior: [CLI Onboarding Reference](/start/wizard-cli-reference#outputs-and-internals). +- 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. diff --git a/docs/cli/setup.md b/docs/cli/setup.md index 340a53a30d7..d8992ba8a43 100644 --- a/docs/cli/setup.md +++ b/docs/cli/setup.md @@ -1,7 +1,7 @@ --- summary: "CLI reference for `openclaw setup` (initialize config + workspace)" read_when: - - You’re doing first-run setup without the full onboarding wizard + - You’re doing first-run setup without the full setup wizard - You want to set the default workspace path title: "setup" --- diff --git a/docs/concepts/models.md b/docs/concepts/models.md index 6323feef04e..e85e605456f 100644 --- a/docs/concepts/models.md +++ b/docs/concepts/models.md @@ -36,7 +36,7 @@ Related: ## Setup wizard (recommended) -If you don’t want to hand-edit config, run the onboarding wizard: +If you don’t want to hand-edit config, run the setup wizard: ```bash openclaw onboard diff --git a/docs/design/kilo-gateway-integration.md b/docs/design/kilo-gateway-integration.md index 4f34e553c0f..39088aaf5b2 100644 --- a/docs/design/kilo-gateway-integration.md +++ b/docs/design/kilo-gateway-integration.md @@ -492,8 +492,8 @@ const needsNonImageSanitize = - Test `resolveEnvApiKey("kilocode")` returns correct env var 2. **Integration Tests:** - - Test onboarding flow with `--auth-choice kilocode-api-key` - - Test non-interactive onboarding with `--kilocode-api-key` + - Test setup flow with `--auth-choice kilocode-api-key` + - Test non-interactive setup with `--kilocode-api-key` - Test model selection with `kilocode/` prefix 3. **E2E Tests:** diff --git a/docs/experiments/onboarding-config-protocol.md b/docs/experiments/onboarding-config-protocol.md index 9427d47b7f6..e3b9d9dff10 100644 --- a/docs/experiments/onboarding-config-protocol.md +++ b/docs/experiments/onboarding-config-protocol.md @@ -1,6 +1,6 @@ --- -summary: "RPC protocol notes for onboarding wizard and config schema" -read_when: "Changing onboarding wizard steps or config schema endpoints" +summary: "RPC protocol notes for setup wizard and config schema" +read_when: "Changing setup wizard steps or config schema endpoints" title: "Onboarding and Config Protocol" --- diff --git a/docs/gateway/authentication.md b/docs/gateway/authentication.md index 28314dd85a3..c25501e6cdd 100644 --- a/docs/gateway/authentication.md +++ b/docs/gateway/authentication.md @@ -49,7 +49,7 @@ openclaw models status openclaw doctor ``` -If you’d rather not manage env vars yourself, the onboarding wizard can store +If you’d rather not manage env vars yourself, the setup wizard can store API keys for daemon use: `openclaw onboard`. See [Help](/help) for details on env inheritance (`env.shellEnv`, diff --git a/docs/gateway/multiple-gateways.md b/docs/gateway/multiple-gateways.md index d6f35e08a46..6d1cf423b98 100644 --- a/docs/gateway/multiple-gateways.md +++ b/docs/gateway/multiple-gateways.md @@ -70,7 +70,7 @@ openclaw --profile rescue onboard # better choose completely different base port, like 19789, # - rest of the onboarding is the same as normal -# To install the service (if not happened automatically during onboarding) +# To install the service (if not happened automatically during setup) openclaw --profile rescue gateway install ``` diff --git a/docs/gateway/secrets.md b/docs/gateway/secrets.md index 05554b1f6d3..1379d8e0202 100644 --- a/docs/gateway/secrets.md +++ b/docs/gateway/secrets.md @@ -70,7 +70,7 @@ active-surface policy, so you can see why a credential was treated as active or When onboarding runs in interactive mode and you choose SecretRef storage, OpenClaw runs preflight validation before saving: -- Env refs: validates env var name and confirms a non-empty value is visible during onboarding. +- Env refs: validates env var name and confirms a non-empty value is visible during setup. - Provider refs (`file` or `exec`): validates provider selection, resolves `id`, and checks resolved value type. - Quickstart reuse path: when `gateway.auth.token` is already a SecretRef, onboarding resolves it before probe/dashboard bootstrap (for `env`, `file`, and `exec` refs) using the same fail-fast gate. diff --git a/docs/gateway/security/index.md b/docs/gateway/security/index.md index f7f6583d794..595e50f2628 100644 --- a/docs/gateway/security/index.md +++ b/docs/gateway/security/index.md @@ -738,7 +738,7 @@ In minimal mode, the Gateway still broadcasts enough for device discovery (`role Gateway auth is **required by default**. If no token/password is configured, the Gateway refuses WebSocket connections (fail‑closed). -The onboarding wizard generates a token by default (even for loopback) so +The setup wizard generates a token by default (even for loopback) so local clients must authenticate. Set a token so **all** WS clients must authenticate: diff --git a/docs/help/faq.md b/docs/help/faq.md index c402230aaa3..8fdf39ab5c1 100644 --- a/docs/help/faq.md +++ b/docs/help/faq.md @@ -36,7 +36,7 @@ Quick answers plus deeper troubleshooting for real-world setups (local dev, VPS, - [How do I install OpenClaw on a VPS?](#how-do-i-install-openclaw-on-a-vps) - [Where are the cloud/VPS install guides?](#where-are-the-cloudvps-install-guides) - [Can I ask OpenClaw to update itself?](#can-i-ask-openclaw-to-update-itself) - - [What does the onboarding wizard actually do?](#what-does-the-onboarding-wizard-actually-do) + - [What does the setup wizard actually do?](#what-does-the-setup-wizard-actually-do) - [Do I need a Claude or OpenAI subscription to run this?](#do-i-need-a-claude-or-openai-subscription-to-run-this) - [Can I use Claude Max subscription without an API key](#can-i-use-claude-max-subscription-without-an-api-key) - [How does Anthropic "setup-token" auth work?](#how-does-anthropic-setuptoken-auth-work) @@ -317,7 +317,7 @@ Install docs: [Install](/install), [Installer flags](/install/installer), [Updat ### What's the recommended way to install and set up OpenClaw -The repo recommends running from source and using the onboarding wizard: +The repo recommends running from source and using the setup wizard: ```bash curl -fsSL https://openclaw.ai/install.sh | bash @@ -627,7 +627,7 @@ More detail: [Install](/install) and [Installer flags](/install/installer). ### How do I install OpenClaw on Linux -Short answer: follow the Linux guide, then run the onboarding wizard. +Short answer: follow the Linux guide, then run the setup wizard. - Linux quick path + service install: [Linux](/platforms/linux). - Full walkthrough: [Getting Started](/start/getting-started). @@ -685,7 +685,7 @@ openclaw gateway restart Docs: [Update](/cli/update), [Updating](/install/updating). -### What does the onboarding wizard actually do +### What does the setup wizard actually do `openclaw onboard` is the recommended setup path. In **local mode** it walks you through: @@ -773,7 +773,7 @@ OpenClaw supports **OpenAI Code (Codex)** via OAuth (ChatGPT sign-in). The wizar Yes. OpenClaw fully supports **OpenAI Code (Codex) subscription OAuth**. OpenAI explicitly allows subscription OAuth usage in external tools/workflows -like OpenClaw. The onboarding wizard can run the OAuth flow for you. +like OpenClaw. The setup wizard can run the OAuth flow for you. See [OAuth](/concepts/oauth), [Model providers](/concepts/model-providers), and [Wizard](/start/wizard). @@ -844,7 +844,7 @@ without WhatsApp/Telegram. `channels.telegram.allowFrom` is **the human sender's Telegram user ID** (numeric). It is not the bot username. -The onboarding wizard accepts `@username` input and resolves it to a numeric ID, but OpenClaw authorization uses numeric IDs only. +The setup wizard accepts `@username` input and resolves it to a numeric ID, but OpenClaw authorization uses numeric IDs only. Safer (no third-party bot): @@ -1901,7 +1901,7 @@ Non-interactive full reset: openclaw reset --scope full --yes --non-interactive ``` -Then re-run onboarding: +Then re-run setup: ```bash openclaw onboard --install-daemon @@ -1909,7 +1909,7 @@ openclaw onboard --install-daemon Notes: -- The onboarding wizard also offers **Reset** if it sees an existing config. See [Wizard](/start/wizard). +- The setup wizard also offers **Reset** if it sees an existing config. See [Wizard](/start/wizard). - If you used profiles (`--profile` / `OPENCLAW_PROFILE`), reset each state dir (defaults are `~/.openclaw-`). - Dev reset: `openclaw gateway --dev --reset` (dev-only; wipes dev config + credentials + sessions + workspace). diff --git a/docs/install/docker.md b/docs/install/docker.md index a68066dcd57..a3827075202 100644 --- a/docs/install/docker.md +++ b/docs/install/docker.md @@ -51,7 +51,7 @@ From repo root: This script: - builds the gateway image locally (or pulls a remote image if `OPENCLAW_IMAGE` is set) -- runs the onboarding wizard +- runs the setup wizard - prints optional provider setup hints - starts the gateway via Docker Compose - generates a gateway token and writes it to `.env` diff --git a/docs/install/index.md b/docs/install/index.md index 464a457a360..21adfdaa592 100644 --- a/docs/install/index.md +++ b/docs/install/index.md @@ -33,7 +33,7 @@ For VPS/cloud hosts, avoid third-party "1-click" marketplace images when possibl - Downloads the CLI, installs it globally via npm, and launches the onboarding wizard. + Downloads the CLI, installs it globally via npm, and launches the setup wizard. diff --git a/docs/install/updating.md b/docs/install/updating.md index e304fe0322b..a8161cc07f0 100644 --- a/docs/install/updating.md +++ b/docs/install/updating.md @@ -22,7 +22,7 @@ curl -fsSL https://openclaw.ai/install.sh | bash Notes: -- Add `--no-onboard` if you don’t want the onboarding wizard to run again. +- Add `--no-onboard` if you don’t want the setup wizard to run again. - For **source installs**, use: ```bash diff --git a/docs/platforms/raspberry-pi.md b/docs/platforms/raspberry-pi.md index 5e7e35c9544..2050b6395b4 100644 --- a/docs/platforms/raspberry-pi.md +++ b/docs/platforms/raspberry-pi.md @@ -321,7 +321,7 @@ Since the Pi is just the Gateway (models run in the cloud), use API-based models ## Auto-Start on Boot -The onboarding wizard sets this up, but to verify: +The setup wizard sets this up, but to verify: ```bash # Check service is enabled diff --git a/docs/providers/anthropic.md b/docs/providers/anthropic.md index 8974bb2dd61..d16d76f6315 100644 --- a/docs/providers/anthropic.md +++ b/docs/providers/anthropic.md @@ -213,7 +213,7 @@ openclaw models auth paste-token --provider anthropic ### CLI setup (setup-token) ```bash -# Paste a setup-token during onboarding +# Paste a setup-token during setup openclaw onboard --auth-choice setup-token ``` diff --git a/docs/providers/huggingface.md b/docs/providers/huggingface.md index d9746d5c166..7b33955f524 100644 --- a/docs/providers/huggingface.md +++ b/docs/providers/huggingface.md @@ -64,7 +64,7 @@ GET https://router.huggingface.co/v1/models (Optional: send `Authorization: Bearer $HUGGINGFACE_HUB_TOKEN` or `$HF_TOKEN` for the full list; some endpoints return a subset without auth.) The response is OpenAI-style `{ "object": "list", "data": [ { "id": "Qwen/Qwen3-8B", "owned_by": "Qwen", ... }, ... ] }`. -When you configure a Hugging Face API key (via onboarding, `HUGGINGFACE_HUB_TOKEN`, or `HF_TOKEN`), OpenClaw uses this GET to discover available chat-completion models. During **interactive onboarding**, after you enter your token you see a **Default Hugging Face model** dropdown populated from that list (or the built-in catalog if the request fails). At runtime (e.g. Gateway startup), when a key is present, OpenClaw again calls **GET** `https://router.huggingface.co/v1/models` to refresh the catalog. The list is merged with a built-in catalog (for metadata like context window and cost). If the request fails or no key is set, only the built-in catalog is used. +When you configure a Hugging Face API key (via onboarding, `HUGGINGFACE_HUB_TOKEN`, or `HF_TOKEN`), OpenClaw uses this GET to discover available chat-completion models. During **interactive setup**, after you enter your token you see a **Default Hugging Face model** dropdown populated from that list (or the built-in catalog if the request fails). At runtime (e.g. Gateway startup), when a key is present, OpenClaw again calls **GET** `https://router.huggingface.co/v1/models` to refresh the catalog. The list is merged with a built-in catalog (for metadata like context window and cost). If the request fails or no key is set, only the built-in catalog is used. ## Model names and editable options diff --git a/docs/providers/ollama.md b/docs/providers/ollama.md index c4604a8e350..5a1eb2bd27e 100644 --- a/docs/providers/ollama.md +++ b/docs/providers/ollama.md @@ -18,7 +18,7 @@ Ollama is a local LLM runtime that makes it easy to run open-source models on yo ### Onboarding wizard (recommended) -The fastest way to set up Ollama is through the onboarding wizard: +The fastest way to set up Ollama is through the setup wizard: ```bash openclaw onboard @@ -231,7 +231,7 @@ Once configured, all your Ollama models are available: Cloud models let you run cloud-hosted models (for example `kimi-k2.5:cloud`, `minimax-m2.5:cloud`, `glm-5:cloud`) alongside your local models. -To use cloud models, select **Cloud + Local** mode during onboarding. The wizard checks whether you are signed in and opens a browser sign-in flow when needed. If authentication cannot be verified, the wizard falls back to local model defaults. +To use cloud models, select **Cloud + Local** mode during setup. The wizard checks whether you are signed in and opens a browser sign-in flow when needed. If authentication cannot be verified, the wizard falls back to local model defaults. You can also sign in directly at [ollama.com/signin](https://ollama.com/signin). diff --git a/docs/providers/opencode.md b/docs/providers/opencode.md index bf8d54afc9e..da44e5154c0 100644 --- a/docs/providers/opencode.md +++ b/docs/providers/opencode.md @@ -59,6 +59,6 @@ openclaw onboard --opencode-go-api-key "$OPENCODE_API_KEY" ## Notes - `OPENCODE_ZEN_API_KEY` is also supported. -- Entering one OpenCode key during onboarding stores credentials for both runtime providers. +- Entering one OpenCode key during setup stores credentials for both runtime providers. - You sign in to OpenCode, add billing details, and copy your API key. - Billing and catalog availability are managed from the OpenCode dashboard. diff --git a/docs/refactor/cluster.md b/docs/refactor/cluster.md index f3b13186972..1d9c8e6f119 100644 --- a/docs/refactor/cluster.md +++ b/docs/refactor/cluster.md @@ -87,11 +87,11 @@ Risk: - Low -## 3. Onboarding prompt and config-patch steps +## 3. Setup prompt and config-patch steps Large surface area. -Many onboarding files repeat: +Many setup files repeat: - resolve account id - prompt allowlist entries @@ -102,18 +102,18 @@ Many onboarding files repeat: Strong examples: -- `extensions/bluebubbles/src/onboarding.ts` -- `extensions/googlechat/src/onboarding.ts` -- `extensions/msteams/src/onboarding.ts` -- `extensions/zalo/src/onboarding.ts` -- `extensions/zalouser/src/onboarding.ts` -- `extensions/nextcloud-talk/src/onboarding.ts` -- `extensions/matrix/src/onboarding.ts` -- `extensions/irc/src/onboarding.ts` +- `extensions/bluebubbles/src/setup-surface.ts` +- `extensions/googlechat/src/setup-surface.ts` +- `extensions/msteams/src/setup-surface.ts` +- `extensions/zalo/src/setup-surface.ts` +- `extensions/zalouser/src/setup-surface.ts` +- `extensions/nextcloud-talk/src/setup-surface.ts` +- `extensions/matrix/src/setup-surface.ts` +- `extensions/irc/src/setup-surface.ts` Existing helper seam: -- `src/channels/plugins/onboarding/helpers.ts` +- `src/channels/plugins/setup-wizard-helpers.ts` Likely extraction shape: diff --git a/docs/reference/wizard.md b/docs/reference/wizard.md index bbaebbdc84f..5bfa3da7f9f 100644 --- a/docs/reference/wizard.md +++ b/docs/reference/wizard.md @@ -1,17 +1,17 @@ --- -summary: "Full reference for the CLI onboarding wizard: every step, flag, and config field" +summary: "Full reference for the CLI setup wizard: every step, flag, and config field" read_when: - Looking up a specific wizard step or flag - Automating onboarding with non-interactive mode - Debugging wizard behavior -title: "Onboarding Wizard Reference" +title: "Setup Wizard Reference" sidebarTitle: "Wizard Reference" --- -# Onboarding Wizard Reference +# Setup Wizard Reference This is the full reference for the `openclaw onboard` CLI wizard. -For a high-level overview, see [Onboarding Wizard](/start/wizard). +For a high-level overview, see [Setup Wizard](/start/wizard). ## Flow details (local mode) @@ -73,12 +73,12 @@ For a high-level overview, see [Onboarding Wizard](/start/wizard). - Port, bind, auth mode, tailscale exposure. - Auth recommendation: keep **Token** even for loopback so local WS clients must authenticate. - - In token mode, interactive onboarding offers: + - In token mode, interactive setup offers: - **Generate/store plaintext token** (default) - **Use SecretRef** (opt-in) - Quickstart reuses existing `gateway.auth.token` SecretRefs across `env`, `file`, and `exec` providers for onboarding probe/dashboard bootstrap. - If that SecretRef is configured but cannot be resolved, onboarding fails early with a clear fix message instead of silently degrading runtime auth. - - In password mode, interactive onboarding also supports plaintext or SecretRef storage. + - In password mode, interactive setup also supports plaintext or SecretRef storage. - Non-interactive token SecretRef path: `--gateway-token-ref-env `. - Requires a non-empty env var in the onboarding process environment. - Cannot be combined with `--gateway-token`. @@ -208,7 +208,7 @@ Typical fields in `~/.openclaw/openclaw.json`: - `agents.defaults.model` / `models.providers` (if Minimax chosen) - `tools.profile` (local onboarding defaults to `"coding"` when unset; existing explicit values are preserved) - `gateway.*` (mode, bind, auth, tailscale) -- `session.dmScope` (behavior details: [CLI Onboarding Reference](/start/wizard-cli-reference#outputs-and-internals)) +- `session.dmScope` (behavior details: [CLI Setup Reference](/start/wizard-cli-reference#outputs-and-internals)) - `channels.telegram.botToken`, `channels.discord.token`, `channels.signal.*`, `channels.imessage.*` - Channel allowlists (Slack/Discord/Matrix/Microsoft Teams) when you opt in during the prompts (names resolve to IDs when possible). - `skills.install.nodeManager` @@ -223,12 +223,12 @@ Typical fields in `~/.openclaw/openclaw.json`: WhatsApp credentials go under `~/.openclaw/credentials/whatsapp//`. Sessions are stored under `~/.openclaw/agents//sessions/`. -Some channels are delivered as plugins. When you pick one during onboarding, the wizard +Some channels are delivered as plugins. When you pick one during setup, the wizard will prompt to install it (npm or a local path) before it can be configured. ## Related docs -- Wizard overview: [Onboarding Wizard](/start/wizard) +- Wizard overview: [Setup Wizard](/start/wizard) - macOS app onboarding: [Onboarding](/start/onboarding) - Config reference: [Gateway configuration](/gateway/configuration) - Providers: [WhatsApp](/channels/whatsapp), [Telegram](/channels/telegram), [Discord](/channels/discord), [Google Chat](/channels/googlechat), [Signal](/channels/signal), [BlueBubbles](/channels/bluebubbles) (iMessage), [iMessage](/channels/imessage) (legacy) diff --git a/docs/start/getting-started.md b/docs/start/getting-started.md index 26b54b63f6f..3fc64e5087d 100644 --- a/docs/start/getting-started.md +++ b/docs/start/getting-started.md @@ -52,13 +52,13 @@ Check your Node version with `node --version` if you are unsure. - + ```bash openclaw onboard --install-daemon ``` The wizard configures auth, gateway settings, and optional channels. - See [Onboarding Wizard](/start/wizard) for details. + See [Setup Wizard](/start/wizard) for details. @@ -114,7 +114,7 @@ Full environment variable reference: [Environment vars](/help/environment). ## Go deeper - + Full CLI wizard reference and advanced options. diff --git a/docs/start/onboarding-overview.md b/docs/start/onboarding-overview.md index 6227cdc104b..1e94a4db64a 100644 --- a/docs/start/onboarding-overview.md +++ b/docs/start/onboarding-overview.md @@ -17,7 +17,7 @@ and how you prefer to configure providers. - **CLI wizard** for macOS, Linux, and Windows (via WSL2). - **macOS app** for a guided first run on Apple silicon or Intel Macs. -## CLI onboarding wizard +## CLI setup wizard Run the wizard in a terminal: @@ -28,7 +28,7 @@ openclaw onboard Use the CLI wizard when you want full control of the Gateway, workspace, channels, and skills. Docs: -- [Onboarding Wizard (CLI)](/start/wizard) +- [Setup Wizard (CLI)](/start/wizard) - [`openclaw onboard` command](/cli/onboard) ## macOS app onboarding diff --git a/docs/start/onboarding.md b/docs/start/onboarding.md index 3e3401cad64..c1dfb90b676 100644 --- a/docs/start/onboarding.md +++ b/docs/start/onboarding.md @@ -1,5 +1,5 @@ --- -summary: "First-run onboarding flow for OpenClaw (macOS app)" +summary: "First-run setup flow for OpenClaw (macOS app)" read_when: - Designing the macOS onboarding assistant - Implementing auth or identity setup @@ -9,7 +9,7 @@ sidebarTitle: "Onboarding: macOS App" # Onboarding (macOS App) -This doc describes the **current** first‑run onboarding flow. The goal is a +This doc describes the **current** first‑run setup flow. The goal is a smooth “day 0” experience: pick where the Gateway runs, connect auth, run the wizard, and let the agent bootstrap itself. For a general overview of onboarding paths, see [Onboarding Overview](/start/onboarding-overview). diff --git a/docs/start/wizard-cli-automation.md b/docs/start/wizard-cli-automation.md index cd00787c5c7..884d49e143b 100644 --- a/docs/start/wizard-cli-automation.md +++ b/docs/start/wizard-cli-automation.md @@ -33,7 +33,7 @@ openclaw onboard --non-interactive \ Add `--json` for a machine-readable summary. Use `--secret-input-mode ref` to store env-backed refs in auth profiles instead of plaintext values. -Interactive selection between env refs and configured provider refs (`file` or `exec`) is available in the onboarding wizard flow. +Interactive selection between env refs and configured provider refs (`file` or `exec`) is available in the setup wizard flow. In non-interactive `ref` mode, provider env vars must be set in the process environment. Passing inline key flags without the matching env var now fails fast. @@ -210,6 +210,6 @@ Notes: ## Related docs -- Onboarding hub: [Onboarding Wizard (CLI)](/start/wizard) -- Full reference: [CLI Onboarding Reference](/start/wizard-cli-reference) +- Onboarding hub: [Setup Wizard (CLI)](/start/wizard) +- Full reference: [CLI Setup Reference](/start/wizard-cli-reference) - Command reference: [`openclaw onboard`](/cli/onboard) diff --git a/docs/start/wizard-cli-reference.md b/docs/start/wizard-cli-reference.md index 5d3e6be6e72..36bd836a13f 100644 --- a/docs/start/wizard-cli-reference.md +++ b/docs/start/wizard-cli-reference.md @@ -1,16 +1,16 @@ --- -summary: "Complete reference for CLI onboarding flow, auth/model setup, outputs, and internals" +summary: "Complete reference for CLI setup flow, auth/model setup, outputs, and internals" read_when: - You need detailed behavior for openclaw onboard - You are debugging onboarding results or integrating onboarding clients -title: "CLI Onboarding Reference" +title: "CLI Setup Reference" sidebarTitle: "CLI reference" --- -# CLI Onboarding Reference +# CLI Setup Reference This page is the full reference for `openclaw onboard`. -For the short guide, see [Onboarding Wizard (CLI)](/start/wizard). +For the short guide, see [Setup Wizard (CLI)](/start/wizard). ## What the wizard does @@ -51,10 +51,10 @@ It does not install or modify anything on the remote host. - Prompts for port, bind, auth mode, and tailscale exposure. - Recommended: keep token auth enabled even for loopback so local WS clients must authenticate. - - In token mode, interactive onboarding offers: + - In token mode, interactive setup offers: - **Generate/store plaintext token** (default) - **Use SecretRef** (opt-in) - - In password mode, interactive onboarding also supports plaintext or SecretRef storage. + - In password mode, interactive setup also supports plaintext or SecretRef storage. - Non-interactive token SecretRef path: `--gateway-token-ref-env `. - Requires a non-empty env var in the onboarding process environment. - Cannot be combined with `--gateway-token`. @@ -222,7 +222,7 @@ Credential storage mode: - Default onboarding behavior persists API keys as plaintext values in auth profiles. - `--secret-input-mode ref` enables reference mode instead of plaintext key storage. - In interactive onboarding, you can choose either: + In interactive setup, you can choose either: - environment variable ref (for example `keyRef: { source: "env", provider: "default", id: "OPENAI_API_KEY" }`) - configured provider ref (`file` or `exec`) with provider alias + id - Interactive reference mode runs a fast preflight validation before saving. @@ -234,7 +234,7 @@ Credential storage mode: - Inline key flags (for example `--openai-api-key`) require that env var to be set; otherwise onboarding fails fast. - For custom providers, non-interactive `ref` mode stores `models.providers..apiKey` as `{ source: "env", provider: "default", id: "CUSTOM_API_KEY" }`. - In that custom-provider case, `--custom-api-key` requires `CUSTOM_API_KEY` to be set; otherwise onboarding fails fast. -- Gateway auth credentials support plaintext and SecretRef choices in interactive onboarding: +- Gateway auth credentials support plaintext and SecretRef choices in interactive setup: - Token mode: **Generate/store plaintext token** (default) or **Use SecretRef**. - Password mode: plaintext or SecretRef. - Non-interactive token SecretRef path: `--gateway-token-ref-env `. @@ -270,7 +270,7 @@ WhatsApp credentials go under `~/.openclaw/credentials/whatsapp//`. Sessions are stored under `~/.openclaw/agents//sessions/`. -Some channels are delivered as plugins. When selected during onboarding, the wizard +Some channels are delivered as plugins. When selected during setup, the wizard prompts to install the plugin (npm or local path) before channel configuration. @@ -294,6 +294,6 @@ Signal setup behavior: ## Related docs -- Onboarding hub: [Onboarding Wizard (CLI)](/start/wizard) +- Onboarding hub: [Setup Wizard (CLI)](/start/wizard) - Automation and scripts: [CLI Automation](/start/wizard-cli-automation) - Command reference: [`openclaw onboard`](/cli/onboard) diff --git a/docs/start/wizard.md b/docs/start/wizard.md index 05c09ed53fd..7bbe9df64cf 100644 --- a/docs/start/wizard.md +++ b/docs/start/wizard.md @@ -1,15 +1,15 @@ --- -summary: "CLI onboarding wizard: guided setup for gateway, workspace, channels, and skills" +summary: "CLI setup wizard: guided setup for gateway, workspace, channels, and skills" read_when: - - Running or configuring the onboarding wizard + - Running or configuring the setup wizard - Setting up a new machine -title: "Onboarding Wizard (CLI)" +title: "Setup Wizard (CLI)" sidebarTitle: "Onboarding: CLI" --- -# Onboarding Wizard (CLI) +# Setup Wizard (CLI) -The onboarding wizard is the **recommended** way to set up OpenClaw on macOS, +The setup wizard is the **recommended** way to set up OpenClaw on macOS, Linux, or Windows (via WSL2; strongly recommended). It configures a local Gateway or a remote Gateway connection, plus channels, skills, and workspace defaults in one guided flow. @@ -35,7 +35,7 @@ openclaw agents add -The onboarding wizard includes a web search step where you can pick a provider +The setup wizard includes a web search step where you can pick a provider (Perplexity, Brave, Gemini, Grok, or Kimi) and paste your API key so the agent can use `web_search`. You can also configure this later with `openclaw configure --section web`. Docs: [Web tools](/tools/web). @@ -52,7 +52,7 @@ The wizard starts with **QuickStart** (defaults) vs **Advanced** (full control). - Gateway port **18789** - Gateway auth **Token** (auto‑generated, even on loopback) - Tool policy default for new local setups: `tools.profile: "coding"` (existing explicit profile is preserved) - - DM isolation default: local onboarding writes `session.dmScope: "per-channel-peer"` when unset. Details: [CLI Onboarding Reference](/start/wizard-cli-reference#outputs-and-internals) + - DM isolation default: local onboarding writes `session.dmScope: "per-channel-peer"` when unset. Details: [CLI Setup Reference](/start/wizard-cli-reference#outputs-and-internals) - Tailscale exposure **Off** - Telegram + WhatsApp DMs default to **allowlist** (you'll be prompted for your phone number) @@ -112,7 +112,7 @@ Notes: ## Full reference For detailed step-by-step breakdowns and config outputs, see -[CLI Onboarding Reference](/start/wizard-cli-reference). +[CLI Setup Reference](/start/wizard-cli-reference). For non-interactive examples, see [CLI Automation](/start/wizard-cli-automation). For the deeper technical reference, including RPC details, see [Wizard Reference](/reference/wizard). diff --git a/docs/tools/plugin.md b/docs/tools/plugin.md index 8be0743c57c..eb065d79138 100644 --- a/docs/tools/plugin.md +++ b/docs/tools/plugin.md @@ -1181,7 +1181,7 @@ A provider plugin can participate in five distinct phases: without prompts. Use this when the provider needs custom headless setup beyond the built-in simple API-key paths. 3. **Wizard integration** - `wizard.onboarding` adds an entry to `openclaw onboard`. + `wizard.setup` adds an entry to `openclaw onboard`. `wizard.modelPicker` adds a setup entry to the model picker. 4. **Implicit discovery** `discovery.run(ctx)` can contribute provider config automatically during @@ -1247,7 +1247,7 @@ errors instead. ### Provider wizard metadata -`wizard.onboarding` controls how the provider appears in grouped onboarding: +`wizard.setup` controls how the provider appears in grouped onboarding: - `choiceId`: auth-choice value - `choiceLabel`: option label @@ -1377,7 +1377,7 @@ api.registerProvider({ }, ], wizard: { - onboarding: { + setup: { choiceId: "acme", choiceLabel: "AcmeAI", groupId: "acme", @@ -1413,7 +1413,7 @@ Notes: headless onboarding. - Return `configPatch` when you need to add default models or provider config. - Return `defaultModel` so `--set-default` can update agent defaults. -- `wizard.onboarding` adds a provider choice to `openclaw onboard`. +- `wizard.setup` adds a provider choice to `openclaw onboard`. - `wizard.modelPicker` adds a “setup this provider” entry to the model picker. - `discovery.run` returns either `{ provider }` for the plugin’s own provider id or `{ providers }` for multi-provider discovery. diff --git a/docs/web/control-ui.md b/docs/web/control-ui.md index 73487cc0eae..204d68605d2 100644 --- a/docs/web/control-ui.md +++ b/docs/web/control-ui.md @@ -28,7 +28,7 @@ Auth is supplied during the WebSocket handshake via: - `connect.params.auth.token` - `connect.params.auth.password` The dashboard settings panel keeps a token for the current browser tab session and selected gateway URL; passwords are not persisted. - The onboarding wizard generates a gateway token by default, so paste it here on first connect. + The setup wizard generates a gateway token by default, so paste it here on first connect. ## Device pairing (first connection)