mirror of
https://github.com/openclaw/openclaw.git
synced 2026-03-12 15:30:39 +00:00
3002f13ca7
Merged via squash.
Prepared head SHA: 4598f2a541
Co-authored-by: Sid-Qin <201593046+Sid-Qin@users.noreply.github.com>
Co-authored-by: gumadeiras <5599352+gumadeiras@users.noreply.github.com>
Reviewed-by: @gumadeiras
69 lines
1.7 KiB
Markdown
69 lines
1.7 KiB
Markdown
---
|
|
summary: "CLI reference for `openclaw config` (get/set/unset/file/validate)"
|
|
read_when:
|
|
- You want to read or edit config non-interactively
|
|
title: "config"
|
|
---
|
|
|
|
# `openclaw config`
|
|
|
|
Config helpers: get/set/unset/validate values by path and print the active
|
|
config file. Run without a subcommand to open
|
|
the configure wizard (same as `openclaw configure`).
|
|
|
|
## Examples
|
|
|
|
```bash
|
|
openclaw config file
|
|
openclaw config get browser.executablePath
|
|
openclaw config set browser.executablePath "/usr/bin/google-chrome"
|
|
openclaw config set agents.defaults.heartbeat.every "2h"
|
|
openclaw config set agents.list[0].tools.exec.node "node-id-or-name"
|
|
openclaw config unset tools.web.search.apiKey
|
|
openclaw config validate
|
|
openclaw config validate --json
|
|
```
|
|
|
|
## Paths
|
|
|
|
Paths use dot or bracket notation:
|
|
|
|
```bash
|
|
openclaw config get agents.defaults.workspace
|
|
openclaw config get agents.list[0].id
|
|
```
|
|
|
|
Use the agent list index to target a specific agent:
|
|
|
|
```bash
|
|
openclaw config get agents.list
|
|
openclaw config set agents.list[1].tools.exec.node "node-id-or-name"
|
|
```
|
|
|
|
## Values
|
|
|
|
Values are parsed as JSON5 when possible; otherwise they are treated as strings.
|
|
Use `--strict-json` to require JSON5 parsing. `--json` remains supported as a legacy alias.
|
|
|
|
```bash
|
|
openclaw config set agents.defaults.heartbeat.every "0m"
|
|
openclaw config set gateway.port 19001 --strict-json
|
|
openclaw config set channels.whatsapp.groups '["*"]' --strict-json
|
|
```
|
|
|
|
## Subcommands
|
|
|
|
- `config file`: Print the active config file path (resolved from `OPENCLAW_CONFIG_PATH` or default location).
|
|
|
|
Restart the gateway after edits.
|
|
|
|
## Validate
|
|
|
|
Validate the current config against the active schema without starting the
|
|
gateway.
|
|
|
|
```bash
|
|
openclaw config validate
|
|
openclaw config validate --json
|
|
```
|