docs(cli): align setup command hierarchy · openclaw/openclaw@f13dfd6
vincentkoc
·
2026-05-10
·
via Recent Commits to openclaw:main
| Original file line number | Diff line number | Diff line change |
|---|
@@ -19,6 +19,7 @@ Docs: https://docs.openclaw.ai
|
19 | 19 | - Agents: surface concise default-visible warnings when `exec`/`bash` tool calls fail after the assistant claims success, while keeping raw stderr hidden unless verbose details are enabled. Fixes #60497. (#80003) Thanks @jbetala7. |
20 | 20 | - Auto-reply/TUI: keep fallback timeout recovery deliverable after a primary model lifecycle error by emitting fallback progress and deferring terminal TUI errors until recovery has a chance to finish. Fixes #80000. (#80009) Thanks @TurboTheTurtle. |
21 | 21 | - CLI/agent: let `openclaw agent --model` use the backend/admin Gateway scope without cached device-token scopes silently downscoping the request. (#78837) Thanks @VACInc. |
| 22 | +- CLI/help: keep help and version invocations configless while improving shared port, channel, plugin, task, session, message, pairing, and auth recovery text. |
22 | 23 | - Ollama: keep DeepSeek V4 cloud models thinking-capable even when Ollama Cloud `/api/show` omits the `thinking` capability, so `/think high` no longer rejects `ollama/deepseek-v4-*:cloud`. |
23 | 24 | - ACPX/Claude ACP: keep foreground prompts waiting for their own result when autonomous task-notification results arrive during the same session, and retarget the patch for Claude Agent ACP `0.33.1`. |
24 | 25 | - WhatsApp: keep Baileys media uploads from passing non-Dispatcher agents to undici in `7.0.0-rc10`, and patch the bundled Baileys declaration so the latest tsdown build stays warning-clean. |
|
| Original file line number | Diff line number | Diff line change |
|---|
@@ -80,7 +80,7 @@ When you run `openclaw channels add` without flags, the interactive wizard can p
|
80 | 80 | |
81 | 81 | - account ids per selected channel |
82 | 82 | - optional display names for those accounts |
83 | | -- `Bind configured channel accounts to agents now?` |
| 83 | +- `Route these channel accounts to agents now?` |
84 | 84 | |
85 | 85 | If you confirm bind now, the wizard asks which agent should own each configured channel account and writes account-scoped routing bindings. |
86 | 86 | |
|
| Original file line number | Diff line number | Diff line change |
|---|
@@ -7,7 +7,9 @@ title: "Configure"
|
7 | 7 | |
8 | 8 | # `openclaw configure` |
9 | 9 | |
10 | | -Interactive prompt to set up credentials, devices, and agent defaults. |
| 10 | +Interactive prompt for targeted changes to an existing setup: credentials, devices, agent defaults, gateway, channels, plugins, skills, and health checks. |
| 11 | + |
| 12 | +Use `openclaw onboard` for the full guided first-run journey, `openclaw setup` for the baseline config/workspace only, and `openclaw channels add` when you only need channel account setup. |
11 | 13 | |
12 | 14 | <Note> |
13 | 15 | The **Model** section includes a multi-select for the `agents.defaults.models` allowlist (what shows up in `/model` and the model picker). Provider-scoped setup choices merge their selected models into the existing allowlist instead of replacing unrelated providers already in the config. |
|
| Original file line number | Diff line number | Diff line change |
|---|
@@ -11,6 +11,13 @@ dedicated reference page or is documented with the command it aliases; this
|
11 | 11 | index lists the commands, the global flags, and the output styling rules that |
12 | 12 | apply across the CLI. |
13 | 13 | |
| 14 | +Use the setup commands by intent: |
| 15 | + |
| 16 | +- `openclaw setup` creates the baseline config and workspace without walking the full guided onboarding flow. |
| 17 | +- `openclaw onboard` is the full guided first-run path for gateway, model auth, workspace, channels, skills, and health. |
| 18 | +- `openclaw configure` changes targeted parts of an existing setup, such as model auth, gateway, channels, plugins, or skills. |
| 19 | +- `openclaw channels add` configures channel accounts after the baseline exists; run it without flags for guided channel setup or with channel-specific flags for scripts. |
| 20 | + |
14 | 21 | ## Command pages |
15 | 22 | |
16 | 23 | | Area | Commands | |
|
| Original file line number | Diff line number | Diff line change |
|---|
@@ -7,7 +7,7 @@ title: "Onboard"
|
7 | 7 | |
8 | 8 | # `openclaw onboard` |
9 | 9 | |
10 | | -Interactive onboarding for local or remote Gateway setup. |
| 10 | +Full guided onboarding for local or remote Gateway setup. Use this when you want OpenClaw to walk through model auth, workspace, gateway, channels, skills, and health in one flow. |
11 | 11 | |
12 | 12 | ## Related guides |
13 | 13 | |
@@ -212,10 +212,13 @@ openclaw onboard --non-interactive \
|
212 | 212 | ## Common follow-up commands |
213 | 213 | |
214 | 214 | ```bash |
| 215 | +openclaw channels add |
215 | 216 | openclaw configure |
216 | 217 | openclaw agents add <name> |
217 | 218 | ``` |
218 | 219 | |
| 220 | +Use `openclaw setup` instead when you only need the baseline config/workspace. Use `openclaw configure` later for targeted changes and `openclaw channels add` for channel-only setup. |
| 221 | + |
219 | 222 | <Note> |
220 | 223 | `--json` does not imply non-interactive mode. Use `--non-interactive` for scripts. |
221 | 224 | </Note> |
| Original file line number | Diff line number | Diff line change |
|---|
@@ -8,7 +8,7 @@ title: "Setup"
|
8 | 8 | |
9 | 9 | # `openclaw setup` |
10 | 10 | |
11 | | -Initialize `~/.openclaw/openclaw.json` and the agent workspace. |
| 11 | +Initialize the baseline config and agent workspace without running the full guided onboarding flow. |
12 | 12 | |
13 | 13 | <Note> |
14 | 14 | `openclaw setup` is for mutable config installs. In Nix mode (`OPENCLAW_NIX_MODE=1`), OpenClaw refuses setup writes because the config file is managed by Nix. Agents should use the first-party [nix-openclaw Quick Start](https://github.com/openclaw/nix-openclaw#quick-start) or the equivalent source config for another Nix package. |
@@ -50,7 +50,7 @@ openclaw setup --wizard
|
50 | 50 | Notes: |
51 | 51 | |
52 | 52 | - Plain `openclaw setup` initializes config + workspace without the full onboarding flow. |
53 | | -- After plain setup, run `openclaw configure` to choose models, channels, Gateway, plugins, skills, or health checks. |
| 53 | +- After plain setup, run `openclaw onboard` for the full guided journey, `openclaw configure` for targeted changes, or `openclaw channels add` to add channel accounts. |
54 | 54 | - Onboarding auto-runs when any onboarding flags are present (`--wizard`, `--non-interactive`, `--mode`, `--import-from`, `--import-source`, `--import-secrets`, `--remote-url`, `--remote-token`). |
55 | 55 | - If Hermes state is detected, interactive onboarding can offer migration automatically. Import onboarding requires a fresh setup; use [Migrate](/cli/migrate) for dry-run plans, backups, and overwrite mode outside onboarding. |
56 | 56 | |
|
| Original file line number | Diff line number | Diff line change |
|---|
@@ -15,7 +15,7 @@ For a high-level overview, see [Onboarding (CLI)](/start/wizard).
|
15 | 15 | |
16 | 16 | <Steps> |
17 | 17 | <Step title="Existing config detection"> |
18 | | -- If `~/.openclaw/openclaw.json` exists, choose **Keep / Modify / Reset**. |
| 18 | +- If `~/.openclaw/openclaw.json` exists, choose **Keep current values**, **Review and update**, or **Reset before setup**. |
19 | 19 | - Re-running onboarding does **not** wipe anything unless you explicitly choose **Reset** |
20 | 20 | (or pass `--reset`). |
21 | 21 | - CLI `--reset` defaults to `config+creds+sessions`; use `--reset-scope full` |
@@ -137,7 +137,7 @@ For a high-level overview, see [Onboarding (CLI)](/start/wizard).
|
137 | 137 | |
138 | 138 | </Step> |
139 | 139 | <Step title="Finish"> |
140 | | -- Summary + next steps, including iOS/Android/macOS apps for extra features. |
| 140 | +- Summary + next steps, including the **How do you want to hatch your agent?** prompt for Terminal, Browser, or later. |
141 | 141 | |
142 | 142 | </Step> |
143 | 143 | </Steps> |
|
此内容由惯性聚合(RSS阅读器)自动聚合整理,仅供阅读参考。 原文来自 — 版权归原作者所有。