OpenClaw Config

Overview

Safely edit ~/.openclaw/openclaw.json (or the path set by OPENCLAW_CONFIG_PATH) using a schema-first workflow. Validate before and after changes to avoid invalid keys/types that can break startup or change security behavior.

Workflow (Safe Edit)

1. 1. Identify the active config path

• - Precedence: OPENCLAW_CONFIG_PATH > OPENCLAW_STATE_DIR/openclaw.json > INLINECODE4
• The config file is JSON5 (comments + trailing commas allowed).

1. 2. Get an authoritative schema (do not guess keys)

• - If the Gateway is running: use openclaw gateway call config.schema --params '{}' to fetch a JSON Schema matching the running version.
• Otherwise: use openclaw/openclaw source-of-truth, primarily:

1. 3. Apply changes with the smallest safe surface

• - Prefer small edits: openclaw config get|set|unset (dot path or bracket notation).
• If the Gateway is online and you want "write + validate + restart" in one step: use RPC config.patch (merge patch) or config.apply (replaces the entire config; use carefully).
• For complex setups, split config with $include (see below).

1. 4. Validate strictly

• - Run openclaw doctor, then fix issues using the reported path + message.
• Do not run openclaw doctor --fix/--yes without explicit user consent (it writes to config/state files).

Guardrails (Avoid Schema Bugs)

• - Most objects are strict (.strict()): unknown keys usually fail validation and the Gateway will refuse to start.
• INLINECODE23 is .passthrough(): extension channels (matrix/zalo/nostr, etc.) can add custom keys, but most provider configs remain strict.
• INLINECODE25 is .catchall(z.string()): you can put string env vars directly under env, and you can also use env.vars.
• Secrets: prefer environment variables/credential files. Avoid committing long-lived tokens/API keys into openclaw.json.

$include (Modular Config)

INLINECODE30 is resolved before schema validation and lets you split config across JSON5 files:

• - Supports "$include": "./base.json5" or INLINECODE32
• Relative paths are resolved against the directory of the current config file.
• Deep-merge rules (per implementation):

• - If sibling keys exist alongside $include, sibling keys override included values.
• Limits: max depth 10; circular includes are detected and rejected.

Common Recipes (Examples)

1. 1. Set default workspace

CODEBLOCK0

1. 2. Change Gateway port

CODEBLOCK1

1. 3. Split config (example)

CODEBLOCK2

1. 4. Telegram open DMs (must explicitly allow senders)

Schema constraint: when dmPolicy="open", allowFrom must include "*".

CODEBLOCK3

1. 5. Discord token (config or env fallback)

CODEBLOCK4

1. 6. Enable web_search (Brave / Perplexity)

CODEBLOCK5

Resources

Load these when you need a field index or source locations:

• - references/openclaw-config-fields.md (root key index + key field lists with sources)
• INLINECODE38 (how to locate schema + constraints in openclaw repo)
• INLINECODE39 (print config path + run doctor)