diff --git a/docs/cli/config.md b/docs/cli/config.md index fb86594bc61..a0fae0301df 100644 --- a/docs/cli/config.md +++ b/docs/cli/config.md @@ -11,10 +11,28 @@ Config helpers for non-interactive edits in `openclaw.json`: get/set/unset/file/ values by path and print the active config file. Run without a subcommand to open the configure wizard (same as `openclaw configure`). +Root options: + +- `--section
`: repeatable guided-setup section filter when you run `openclaw config` without a subcommand + +Supported guided sections: + +- `workspace` +- `model` +- `web` +- `gateway` +- `daemon` +- `channels` +- `plugins` +- `skills` +- `health` + ## Examples ```bash openclaw config file +openclaw config --section model +openclaw config --section gateway --section daemon openclaw config schema openclaw config get browser.executablePath openclaw config set browser.executablePath "/usr/bin/google-chrome" @@ -69,6 +87,8 @@ openclaw config set gateway.port 19001 --strict-json openclaw config set channels.whatsapp.groups '["*"]' --strict-json ``` +`config get --json` prints the raw value as JSON instead of terminal-formatted text. + ## `config set` modes `openclaw config set` supports four assignment styles: diff --git a/docs/cli/configure.md b/docs/cli/configure.md index ea9840c4725..f527f28383c 100644 --- a/docs/cli/configure.md +++ b/docs/cli/configure.md @@ -25,6 +25,22 @@ Related: - Gateway configuration reference: [Configuration](/gateway/configuration) - Config CLI: [Config](/cli/config) +## Options + +- `--section
`: repeatable section filter + +Available sections: + +- `workspace` +- `model` +- `web` +- `gateway` +- `daemon` +- `channels` +- `plugins` +- `skills` +- `health` + Notes: - Choosing where the Gateway runs always updates `gateway.mode`. You can select "Continue" without other sections if that is all you need. @@ -39,4 +55,5 @@ Notes: openclaw configure openclaw configure --section web openclaw configure --section model --section channels +openclaw configure --section gateway --section daemon ``` diff --git a/docs/cli/doctor.md b/docs/cli/doctor.md index d5429b5b01c..17529eecb4c 100644 --- a/docs/cli/doctor.md +++ b/docs/cli/doctor.md @@ -21,8 +21,21 @@ Related: openclaw doctor openclaw doctor --repair openclaw doctor --deep +openclaw doctor --repair --non-interactive +openclaw doctor --generate-gateway-token ``` +## Options + +- `--no-workspace-suggestions`: disable workspace memory/search suggestions +- `--yes`: accept defaults without prompting +- `--repair`: apply recommended repairs without prompting +- `--fix`: alias for `--repair` +- `--force`: apply aggressive repairs, including overwriting custom service config when needed +- `--non-interactive`: run without prompts; safe migrations only +- `--generate-gateway-token`: generate and configure a gateway token +- `--deep`: scan system services for extra gateway installs + Notes: - Interactive prompts (like keychain/OAuth fixes) only run when stdin is a TTY and `--non-interactive` is **not** set. Headless runs (cron, Telegram, no terminal) will skip prompts. diff --git a/docs/cli/setup.md b/docs/cli/setup.md index e13cd89e5b2..28130d4bd73 100644 --- a/docs/cli/setup.md +++ b/docs/cli/setup.md @@ -20,10 +20,26 @@ Related: ```bash openclaw setup openclaw setup --workspace ~/.openclaw/workspace +openclaw setup --wizard +openclaw setup --non-interactive --mode remote --remote-url wss://gateway-host:18789 --remote-token ``` +## Options + +- `--workspace `: agent workspace directory (stored as `agents.defaults.workspace`) +- `--wizard`: run onboarding +- `--non-interactive`: run onboarding without prompts +- `--mode `: onboarding mode +- `--remote-url `: remote Gateway WebSocket URL +- `--remote-token `: remote Gateway token + To run onboarding via setup: ```bash openclaw setup --wizard ``` + +Notes: + +- Plain `openclaw setup` initializes config + workspace without the full onboarding flow. +- Onboarding auto-runs when any onboarding flags are present (`--wizard`, `--non-interactive`, `--mode`, `--remote-url`, `--remote-token`).