Files
openclaw/docs/cli/configure.md

37 lines
1.7 KiB
Markdown
Raw Normal View History

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
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.
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-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-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
Notes:
2026-01-31 21:13:13 +09:00
- Choosing where the Gateway runs always updates `gateway.mode`. You can select "Continue" without other sections if that is all you need.
- 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.
- 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-15 06:12:54 +00:00
## Examples
```bash
2026-01-30 03:15:10 +01:00
openclaw configure
2026-02-25 02:44:49 +00:00
openclaw configure --section model --section channels
2026-01-15 06:12:54 +00:00
```