Naar hoofdinhoud gaan
Config-hulpmiddelen voor niet-interactieve bewerkingen in openclaw.json: waarden per pad ophalen/instellen/patchen/verwijderen, bestanden/schema’s valideren en het actieve configuratiebestand afdrukken. Voer uit zonder subopdracht om de configuratiewizard te openen (hetzelfde als openclaw configure).
Wanneer OPENCLAW_NIX_MODE=1 is ingesteld, behandelt OpenClaw openclaw.json als onveranderlijk. Alleen-lezen opdrachten zoals config get, config file, config schema en config validate blijven werken, maar configuratieschrijvers weigeren. Agents moeten in plaats daarvan de Nix-bron voor de installatie bewerken; gebruik voor de first-party nix-openclaw-distributie nix-openclaw Quick Start en stel waarden in onder programs.openclaw.config of instances.<name>.config.

Root-opties

--section <section>
string
Herhaalbaar filter voor begeleide-installatiesecties wanneer je openclaw config zonder subopdracht uitvoert.
Ondersteunde begeleide secties: workspace, model, web, gateway, daemon, channels, plugins, skills, health.

Voorbeelden

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"
openclaw config set browser.profiles.work.executablePath "/Applications/Google Chrome.app/Contents/MacOS/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 set agents.defaults.models '{"openai/gpt-5.4":{}}' --strict-json --merge
openclaw config set channels.discord.token --ref-provider default --ref-source env --ref-id DISCORD_BOT_TOKEN
openclaw config set secrets.providers.vaultfile --provider-source file --provider-path /etc/openclaw/secrets.json --provider-mode json
openclaw config patch --file ./openclaw.patch.json5 --dry-run
openclaw config unset plugins.entries.brave.config.webSearch.apiKey
openclaw config set channels.discord.token --ref-provider default --ref-source env --ref-id DISCORD_BOT_TOKEN --dry-run
openclaw config validate
openclaw config validate --json

config schema

Druk het gegenereerde JSON-schema voor openclaw.json als JSON af naar stdout.
  • Het huidige root-configuratieschema, plus een rootveld $schema als tekenreeks voor editorhulpmiddelen.
  • Documentatiemetadata voor veld-title en description die door de Control UI worden gebruikt.
  • Geneste object-, wildcard- (*) en array-item- ([]) knooppunten erven dezelfde metadata voor title / description wanneer passende velddocumentatie bestaat.
  • anyOf / oneOf / allOf-takken erven ook dezelfde documentatiemetadata wanneer passende velddocumentatie bestaat.
  • Best-effort live Plugin- en kanaalschemametadata wanneer runtimemanifesten kunnen worden geladen.
  • Een schoon fallback-schema, zelfs wanneer de huidige configuratie ongeldig is.
config.schema.lookup retourneert één genormaliseerd configuratiepad met een ondiep schemaknooppunt (title, description, type, enum, const, algemene grenzen), passende UI-hintmetadata en directe onderliggende samenvattingen. Gebruik dit voor padgerichte drill-down in Control UI of aangepaste clients.
openclaw config schema
Pipe het naar een bestand wanneer je het met andere hulpmiddelen wilt inspecteren of valideren:
openclaw config schema > openclaw.schema.json

Paden

Paden gebruiken punt- of haakjesnotatie. Zet paden met haakjesnotatie tussen aanhalingstekens in shellvoorbeelden, zodat shells zoals zsh [0] niet als glob uitbreiden voordat OpenClaw het pad ontvangt:
openclaw config get agents.defaults.workspace
openclaw config get 'agents.list[0].id'
Gebruik de agentlijstindex om een specifieke agent te kiezen:
openclaw config get agents.list
openclaw config set 'agents.list[1].tools.exec.node' "node-id-or-name"

Waarden

Waarden worden waar mogelijk als JSON5 geparseerd; anders worden ze als tekenreeksen behandeld. Gebruik --strict-json om standaard JSON-parsing zonder tekenreeksfallback te vereisen. --json blijft ondersteund als legacy-alias voor --strict-json.
openclaw config set agents.defaults.heartbeat.every "0m"
openclaw config set gateway.port 19001 --strict-json
openclaw config set channels.whatsapp.groups '["*"]' --strict-json
Wanneer --strict-json is ingeschakeld, wordt JSON5-only syntaxis zoals opmerkingen, trailing comma’s of objectkeys zonder aanhalingstekens geweigerd. Laat --strict-json weg voor JSON5-waardeparsing met fallback naar ruwe tekenreeksen. config get <path> --json drukt de ruwe waarde af als JSON in plaats van tekst die voor de terminal is opgemaakt.
Objecttoewijzing vervangt standaard het doelpad. Beschermde map-/lijstpaden die vaak door gebruikers toegevoegde items bevatten, zoals agents.defaults.models, models.providers, models.providers.<id>.models, plugins.entries en auth.profiles, weigeren vervangingen die bestaande items zouden verwijderen, tenzij je --replace doorgeeft.
Gebruik --merge wanneer je items aan die maps toevoegt:
openclaw config set agents.defaults.models '{"openai/gpt-5.4":{}}' --strict-json --merge
openclaw config set models.providers.ollama.models '[{"id":"llama3.2","name":"Llama 3.2"}]' --strict-json --merge
Gebruik --replace alleen wanneer je bewust wilt dat de opgegeven waarde de volledige doelwaarde wordt.

config set-modi

openclaw config set ondersteunt vier toewijzingsstijlen:
openclaw config set <path> <value>
SecretRef-toewijzingen worden geweigerd op niet-ondersteunde runtime-muteerbare oppervlakken (bijvoorbeeld hooks.token, commands.ownerDisplaySecret, webhooktokens voor Discord-threadbinding en WhatsApp-creds-JSON). Zie SecretRef-referentiegegevensoppervlak.
Batchparsing gebruikt altijd de batchpayload (--batch-json/--batch-file) als bron van waarheid. --strict-json / --json wijzigen het batchparsinggedrag niet.

config patch

Gebruik config patch wanneer je een configuratievormige patch wilt plakken of pipen in plaats van veel padgebaseerde config set-opdrachten uit te voeren. De invoer is een JSON5-object. Objecten worden recursief samengevoegd, arrays en scalaire waarden vervangen de doelwaarde, en null verwijdert het doelpad.
openclaw config patch --file ./openclaw.patch.json5 --dry-run
openclaw config patch --file ./openclaw.patch.json5
Je kunt ook een patch via stdin pipen, wat handig is voor externe installatiescripts:
ssh openclaw-host 'openclaw config patch --stdin --dry-run' < ./openclaw.patch.json5
ssh openclaw-host 'openclaw config patch --stdin' < ./openclaw.patch.json5
Voorbeeldpatch:
{
  channels: {
    slack: {
      enabled: true,
      mode: "socket",
      botToken: { source: "env", provider: "default", id: "SLACK_BOT_TOKEN" },
      appToken: { source: "env", provider: "default", id: "SLACK_APP_TOKEN" },
      groupPolicy: "open",
      requireMention: false,
    },
    discord: {
      enabled: true,
      token: { source: "env", provider: "default", id: "DISCORD_BOT_TOKEN" },
      dmPolicy: "disabled",
      dm: { enabled: false },
      groupPolicy: "allowlist",
    },
  },
  agents: {
    defaults: {
      model: { primary: "openai/gpt-5.5" },
      models: {
        "openai/gpt-5.5": { params: { fastMode: true } },
      },
    },
  },
}
Gebruik --replace-path <path> wanneer één object of array exact de opgegeven waarde moet worden in plaats van recursief gepatcht te worden:
openclaw config patch --file ./discord.patch.json5 --replace-path 'channels.discord.guilds["123"].channels'
--dry-run voert schema- en SecretRef-oplosbaarheidscontroles uit zonder te schrijven. Exec-backed SecretRefs worden standaard overgeslagen tijdens dry-run; voeg --allow-exec toe wanneer je bewust wilt dat dry-run provideropdrachten uitvoert. JSON-pad-/waardemodus blijft ondersteund voor zowel SecretRefs als providers:
openclaw config set channels.discord.token \
  '{"source":"env","provider":"default","id":"DISCORD_BOT_TOKEN"}' \
  --strict-json

openclaw config set secrets.providers.vaultfile \
  '{"source":"file","path":"/etc/openclaw/secrets.json","mode":"json"}' \
  --strict-json

Provider-builderflags

Provider-builderdoelen moeten secrets.providers.<alias> als pad gebruiken.
  • --provider-source <env|file|exec>
  • --provider-timeout-ms <ms> (file, exec)
  • --provider-allowlist <ENV_VAR> (herhaalbaar)
  • --provider-path <path> (vereist)
  • --provider-mode <singleValue|json>
  • --provider-max-bytes <bytes>
  • --provider-allow-insecure-path
  • --provider-command <path> (vereist)
  • --provider-arg <arg> (herhaalbaar)
  • --provider-no-output-timeout-ms <ms>
  • --provider-max-output-bytes <bytes>
  • --provider-json-only
  • --provider-env <KEY=VALUE> (herhaalbaar)
  • --provider-pass-env <ENV_VAR> (herhaalbaar)
  • --provider-trusted-dir <path> (herhaalbaar)
  • --provider-allow-insecure-path
  • --provider-allow-symlink-command
Voorbeeld van een geharde exec-provider:
openclaw config set secrets.providers.vault \
  --provider-source exec \
  --provider-command /usr/local/bin/openclaw-vault \
  --provider-arg read \
  --provider-arg openai/api-key \
  --provider-json-only \
  --provider-pass-env VAULT_TOKEN \
  --provider-trusted-dir /usr/local/bin \
  --provider-timeout-ms 5000

Dry run

Gebruik --dry-run om wijzigingen te valideren zonder naar openclaw.json te schrijven.
openclaw config set channels.discord.token \
  --ref-provider default \
  --ref-source env \
  --ref-id DISCORD_BOT_TOKEN \
  --dry-run

openclaw config set channels.discord.token \
  --ref-provider default \
  --ref-source env \
  --ref-id DISCORD_BOT_TOKEN \
  --dry-run \
  --json

openclaw config set channels.discord.token \
  --ref-provider vault \
  --ref-source exec \
  --ref-id discord/token \
  --dry-run \
  --allow-exec
  • Builder-modus: voert SecretRef-oplosbaarheidscontroles uit voor gewijzigde refs/providers.
  • JSON-modus (--strict-json, --json of batchmodus): voert schemavalidatie plus SecretRef-oplosbaarheidscontroles uit.
  • Beleidsvalidatie wordt ook uitgevoerd voor bekende niet-ondersteunde SecretRef-doeloppervlakken.
  • Beleidscontroles evalueren de volledige configuratie na de wijziging, dus schrijfacties naar bovenliggende objecten (bijvoorbeeld hooks instellen als een object) kunnen validatie van niet-ondersteunde oppervlakken niet omzeilen.
  • Exec-SecretRef-controles worden standaard overgeslagen tijdens dry-run om neveneffecten van opdrachten te voorkomen.
  • Gebruik --allow-exec met --dry-run om expliciet exec-SecretRef-controles in te schakelen (dit kan provideropdrachten uitvoeren).
  • --allow-exec is alleen voor dry-run en geeft een fout als het zonder --dry-run wordt gebruikt.
--dry-run --json print een machineleesbaar rapport:
  • ok: of dry-run is geslaagd
  • operations: aantal geëvalueerde toewijzingen
  • checks: of schema-/oplosbaarheidscontroles zijn uitgevoerd
  • checks.resolvabilityComplete: of oplosbaarheidscontroles tot voltooiing zijn uitgevoerd (false wanneer exec-refs worden overgeslagen)
  • refsChecked: aantal refs dat daadwerkelijk is opgelost tijdens dry-run
  • skippedExecRefs: aantal exec-refs dat is overgeslagen omdat --allow-exec niet was ingesteld
  • errors: gestructureerde fouten voor ontbrekend pad, schema of oplosbaarheid wanneer ok=false

Vorm van JSON-uitvoer

{
  ok: boolean,
  operations: number,
  configPath: string,
  inputModes: ["value" | "json" | "builder" | "unset", ...],
  checks: {
    schema: boolean,
    resolvability: boolean,
    resolvabilityComplete: boolean,
  },
  refsChecked: number,
  skippedExecRefs: number,
  errors?: [
    {
      kind: "missing-path" | "schema" | "resolvability",
      message: string,
      ref?: string, // present for resolvability errors
    },
  ],
}
{
  "ok": true,
  "operations": 1,
  "configPath": "~/.openclaw/openclaw.json",
  "inputModes": ["builder"],
  "checks": {
    "schema": false,
    "resolvability": true,
    "resolvabilityComplete": true
  },
  "refsChecked": 1,
  "skippedExecRefs": 0
}
  • config schema validation failed: de configuratievorm na je wijziging is ongeldig; herstel het pad/de waarde of de vorm van het provider-/ref-object.
  • Config policy validation failed: unsupported SecretRef usage: verplaats die referentie terug naar plaintext-/stringinvoer en houd SecretRefs alleen op ondersteunde oppervlakken.
  • SecretRef assignment(s) could not be resolved: provider/ref waarnaar wordt verwezen kan momenteel niet worden opgelost (ontbrekende omgevingsvariabele, ongeldige bestandsverwijzing, fout in exec-provider of mismatch tussen provider en bron).
  • Dry run note: skipped <n> exec SecretRef resolvability check(s): dry-run heeft exec-refs overgeslagen; voer opnieuw uit met --allow-exec als je exec-oplosbaarheidsvalidatie nodig hebt.
  • Voor batchmodus: herstel falende vermeldingen en voer --dry-run opnieuw uit voordat je schrijft.

Schrijfveiligheid

openclaw config set en andere configuratieschrijvers die door OpenClaw worden beheerd, valideren de volledige configuratie na de wijziging voordat deze naar schijf wordt weggeschreven. Als de nieuwe payload niet door schemavalidatie komt of lijkt op destructief overschrijven, blijft de actieve configuratie ongemoeid en wordt de geweigerde payload ernaast opgeslagen als openclaw.json.rejected.*.
Het actieve configuratiepad moet een regulier bestand zijn. Symlinked openclaw.json-indelingen worden niet ondersteund voor schrijfacties; gebruik in plaats daarvan OPENCLAW_CONFIG_PATH om rechtstreeks naar het echte bestand te wijzen.
Geef de voorkeur aan CLI-schrijfacties voor kleine bewerkingen:
openclaw config set gateway.reload.mode hybrid --dry-run
openclaw config set gateway.reload.mode hybrid
openclaw config validate
Als een schrijfactie wordt geweigerd, inspecteer dan de opgeslagen payload en herstel de volledige configuratievorm:
CONFIG="$(openclaw config file)"
ls -lt "$CONFIG".rejected.* 2>/dev/null | head
openclaw config validate
Rechtstreekse bewerkingen in een editor zijn nog steeds toegestaan, maar de draaiende Gateway behandelt ze als onvertrouwd totdat ze zijn gevalideerd. Ongeldige rechtstreekse bewerkingen laten het opstarten mislukken of worden overgeslagen door hot reload; Gateway herschrijft openclaw.json niet. Voer openclaw doctor --fix uit om geprefixte/overschreven configuratie te repareren of de laatst bekende goede kopie te herstellen. Zie Gateway-probleemoplossing. Herstel van het volledige bestand is voorbehouden aan doctor-reparatie. Wijzigingen in Plugin-schema’s of scheefstand in minHostVersion blijven luid zichtbaar in plaats van niet-gerelateerde gebruikersinstellingen terug te draaien, zoals modellen, providers, auth-profielen, kanalen, gateway-blootstelling, tools, geheugen, browser of cron-configuratie.

Subopdrachten

  • config file: Print het actieve configuratiebestandspad (opgelost vanuit OPENCLAW_CONFIG_PATH of de standaardlocatie). Het pad moet een regulier bestand aanduiden, geen symlink.
Herstart de gateway na bewerkingen.

Valideren

Valideer de huidige configuratie tegen het actieve schema zonder de gateway te starten.
openclaw config validate
openclaw config validate --json
Nadat openclaw config validate slaagt, kun je de lokale TUI gebruiken om een ingebedde agent de actieve configuratie te laten vergelijken met de docs terwijl je elke wijziging vanuit dezelfde terminal valideert:
Als validatie al mislukt, begin dan met openclaw configure of openclaw doctor --fix. openclaw chat omzeilt de ongeldige-configuratiebewaking niet.
openclaw chat
Daarna binnen de TUI:
!openclaw config file
!openclaw docs gateway auth token secretref
!openclaw config validate
!openclaw doctor
Typische reparatielus:
1

Vergelijk met docs

Vraag de agent om je huidige configuratie te vergelijken met de relevante docspagina en de kleinste fix voor te stellen.
2

Gerichte bewerkingen toepassen

Pas gerichte bewerkingen toe met openclaw config set of openclaw configure.
3

Opnieuw valideren

Voer openclaw config validate opnieuw uit na elke wijziging.
4

Doctor voor runtimeproblemen

Als validatie slaagt maar de runtime nog steeds ongezond is, voer dan openclaw doctor of openclaw doctor --fix uit voor hulp bij migratie en reparatie.

Gerelateerd