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
Herhaalbaar filter voor begeleide-installatiesecties wanneer je
openclaw config zonder subopdracht uitvoert.workspace, model, web, gateway, daemon, channels, plugins, skills, health.
Voorbeelden
config schema
Druk het gegenereerde JSON-schema voor openclaw.json als JSON af naar stdout.
Wat het bevat
Wat het bevat
- Het huidige root-configuratieschema, plus een rootveld
$schemaals tekenreeks voor editorhulpmiddelen. - Documentatiemetadata voor veld-
titleendescriptiondie door de Control UI worden gebruikt. - Geneste object-, wildcard- (
*) en array-item- ([]) knooppunten erven dezelfde metadata voortitle/descriptionwanneer 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.
Gerelateerde runtime-RPC
Gerelateerde runtime-RPC
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.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:
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.
--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.--merge wanneer je items aan die maps toevoegt:
--replace alleen wanneer je bewust wilt dat de opgegeven waarde de volledige doelwaarde wordt.
config set-modi
openclaw config set ondersteunt vier toewijzingsstijlen:
- Waardemodus
- SecretRef-buildermodus
- Provider-buildermodus
- Batchmodus
--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.
--replace-path <path> wanneer één object of array exact de opgegeven waarde moet worden in plaats van recursief gepatcht te worden:
--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:
Provider-builderflags
Provider-builderdoelen moetensecrets.providers.<alias> als pad gebruiken.
Algemene flags
Algemene flags
--provider-source <env|file|exec>--provider-timeout-ms <ms>(file,exec)
Env-provider (--provider-source env)
Env-provider (--provider-source env)
--provider-allowlist <ENV_VAR>(herhaalbaar)
File-provider (--provider-source file)
File-provider (--provider-source file)
--provider-path <path>(vereist)--provider-mode <singleValue|json>--provider-max-bytes <bytes>--provider-allow-insecure-path
Exec-provider (--provider-source exec)
Exec-provider (--provider-source exec)
--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
Dry run
Gebruik--dry-run om wijzigingen te valideren zonder naar openclaw.json te schrijven.
Dry-run-gedrag
Dry-run-gedrag
- Builder-modus: voert SecretRef-oplosbaarheidscontroles uit voor gewijzigde refs/providers.
- JSON-modus (
--strict-json,--jsonof 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
hooksinstellen 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-execmet--dry-runom expliciet exec-SecretRef-controles in te schakelen (dit kan provideropdrachten uitvoeren). --allow-execis alleen voor dry-run en geeft een fout als het zonder--dry-runwordt gebruikt.
--dry-run --json-velden
--dry-run --json-velden
--dry-run --json print een machineleesbaar rapport:ok: of dry-run is geslaagdoperations: aantal geëvalueerde toewijzingenchecks: of schema-/oplosbaarheidscontroles zijn uitgevoerdchecks.resolvabilityComplete: of oplosbaarheidscontroles tot voltooiing zijn uitgevoerd (false wanneer exec-refs worden overgeslagen)refsChecked: aantal refs dat daadwerkelijk is opgelost tijdens dry-runskippedExecRefs: aantal exec-refs dat is overgeslagen omdat--allow-execniet was ingestelderrors: gestructureerde fouten voor ontbrekend pad, schema of oplosbaarheid wanneerok=false
Vorm van JSON-uitvoer
- Voorbeeld van succes
- Voorbeeld van fout
Als dry-run mislukt
Als dry-run mislukt
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-execals je exec-oplosbaarheidsvalidatie nodig hebt.- Voor batchmodus: herstel falende vermeldingen en voer
--dry-runopnieuw 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.*.
Geef de voorkeur aan CLI-schrijfacties voor kleine bewerkingen:
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 vanuitOPENCLAW_CONFIG_PATHof de standaardlocatie). Het pad moet een regulier bestand aanduiden, geen symlink.
Valideren
Valideer de huidige configuratie tegen het actieve schema zonder de gateway te starten.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.Vergelijk met docs
Vraag de agent om je huidige configuratie te vergelijken met de relevante docspagina en de kleinste fix voor te stellen.
Gerichte bewerkingen toepassen
Pas gerichte bewerkingen toe met
openclaw config set of openclaw configure.