2026-01-15 06:12:54 +00:00
---
2026-01-30 03:15:10 +01:00
summary: "CLI reference for `openclaw configure` (interactive configuration prompts)"
2026-01-15 06:12:54 +00:00
read_when:
- You want to tweak credentials, devices, or agent defaults interactively
2026-01-31 16:04:03 -05:00
title: "configure"
2026-01-15 06:12:54 +00:00
---
2026-01-30 03:15:10 +01:00
# `openclaw configure`
2026-01-15 06:12:54 +00:00
Interactive prompt to set up credentials, devices, and agent defaults.
2026-01-21 10:58:56 +00:00
Note: The **Model ** section now includes a multi-select for the
`agents.defaults.models` allowlist (what shows up in `/model` and the model picker).
2026-04-04 11:30:18 +01:00
When configure starts from a provider auth choice, the default-model and
allowlist pickers prefer that provider automatically. For paired providers such
as Volcengine/BytePlus, the same preference also matches their coding-plan
variants (`volcengine-plan/*` , `byteplus-plan/*` ). If the preferred-provider
filter would produce an empty list, configure falls back to the unfiltered
catalog instead of showing a blank picker.
2026-01-30 03:15:10 +01:00
Tip: `openclaw config` without a subcommand opens the same wizard. Use
`openclaw config get|set|unset` for non-interactive edits.
2026-01-16 06:57:16 +00:00
2026-03-29 00:24:48 +00:00
For web search, `openclaw configure --section web` lets you choose a provider
2026-04-04 09:14:51 +01:00
and configure its credentials. Some providers also show provider-specific
follow-up prompts:
- **Grok** can offer optional `x_search` setup with the same `XAI_API_KEY` and
let you pick an `x_search` model.
- **Kimi** can ask for the Moonshot API region (`api.moonshot.ai` vs
`api.moonshot.cn` ) and the default Kimi web-search model.
2026-03-29 00:24:48 +00:00
2026-01-15 06:12:54 +00:00
Related:
2026-01-31 21:13:13 +09:00
2026-01-15 06:12:54 +00:00
- Gateway configuration reference: [Configuration ](/gateway/configuration )
2026-01-16 06:57:16 +00:00
- Config CLI: [Config ](/cli/config )
2026-01-15 06:12:54 +00:00
2026-04-04 08:48:15 +01:00
## Options
- `--section <section>` : repeatable section filter
Available sections:
- `workspace`
- `model`
- `web`
- `gateway`
- `daemon`
- `channels`
- `plugins`
- `skills`
- `health`
2026-01-16 01:05:55 +00:00
Notes:
2026-01-31 21:13:13 +09:00
2026-01-16 01:05:55 +00:00
- Choosing where the Gateway runs always updates `gateway.mode` . You can select "Continue" without other sections if that is all you need.
2026-01-18 00:41:57 +00:00
- Channel-oriented services (Slack/Discord/Matrix/Microsoft Teams) prompt for channel/room allowlists during setup. You can enter names or IDs; the wizard resolves names to IDs when possible.
2026-03-05 12:53:56 -06:00
- If you run the daemon install step, token auth requires a token, and `gateway.auth.token` is SecretRef-managed, configure validates the SecretRef but does not persist resolved plaintext token values into supervisor service environment metadata.
- If token auth requires a token and the configured token SecretRef is unresolved, configure blocks daemon install with actionable remediation guidance.
- If both `gateway.auth.token` and `gateway.auth.password` are configured and `gateway.auth.mode` is unset, configure blocks daemon install until mode is set explicitly.
2026-01-16 01:05:55 +00:00
2026-01-15 06:12:54 +00:00
## Examples
``` bash
2026-01-30 03:15:10 +01:00
openclaw configure
2026-03-29 00:24:48 +00:00
openclaw configure --section web
2026-02-25 02:44:49 +00:00
openclaw configure --section model --section channels
2026-04-04 08:48:15 +01:00
openclaw configure --section gateway --section daemon
2026-01-15 06:12:54 +00:00
```