CLI commands

Konfiguration

Nicht interaktive Hilfsfunktionen für openclaw.json: einen Wert anhand seines Pfads abrufen, festlegen, patchen oder entfernen, das Schema ausgeben, validieren oder den Pfad der aktiven Datei ausgeben. Führen Sie openclaw config ohne Unterbefehl aus, um denselben geführten Assistenten wie bei openclaw configure zu öffnen.

Stammoptionen

OPENCLAW_DOCS_MARKER:paramOpen:IHBhdGg9Ii0tc2VjdGlvbiA8c2VjdGlvbg " type="string"> Wiederholbarer Abschnittsfilter für die geführte Einrichtung, wenn Sie openclaw config ohne Unterbefehl ausführen.

Geführte Abschnitte: workspace, model, web, gateway, daemon, channels, plugins, skills, health.

Beispiele

bash
openclaw config fileopenclaw config --section modelopenclaw config --section gateway --section daemonopenclaw config schemaopenclaw config get browser.executablePathopenclaw 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 --mergeopenclaw config set channels.discord.token --ref-provider default --ref-source env --ref-id DISCORD_BOT_TOKENopenclaw config set secrets.providers.vaultfile --provider-source file --provider-path /etc/openclaw/secrets.json --provider-mode jsonopenclaw config patch --file ./openclaw.patch.json5 --dry-runopenclaw config unset plugins.entries.brave.config.webSearch.apiKeyopenclaw config set channels.discord.token --ref-provider default --ref-source env --ref-id DISCORD_BOT_TOKEN --dry-runopenclaw config validateopenclaw config validate --json

Pfade

Punkt- oder Klammernotation. Setzen Sie Klammerpfade in Shell-Beispielen in Anführungszeichen, damit zsh [0] nicht als Glob-Muster erweitert:

bash
openclaw config get agents.defaults.workspaceopenclaw config get 'agents.list[0].id'openclaw config get agents.listopenclaw config set 'agents.list[1].tools.exec.node' "node-id-or-name"

config get

Liest einen Wert aus der geschwärzten Konfigurationsmomentaufnahme aus (Geheimnisse werden niemals ausgegeben). --json gibt den Rohwert als JSON aus; andernfalls werden Zeichenfolgen, Zahlen und boolesche Werte ohne zusätzliche Formatierung sowie Objekte und Arrays als formatiertes JSON ausgegeben.

bash
openclaw config get browser.executablePathopenclaw config get agents.defaults.model --json

config file

Gibt den Pfad der aktiven Konfigurationsdatei aus, der anhand von OPENCLAW_CONFIG_PATH oder dem Standardspeicherort aufgelöst wird. Der Pfad bezeichnet eine reguläre Datei und keinen symbolischen Link; siehe Schreibsicherheit.

config schema

Gibt das generierte JSON-Schema für openclaw.json auf der Standardausgabe aus.

Enthaltene Elemente
  • Das aktuelle Stammkonfigurationsschema sowie ein $schema-Zeichenfolgenfeld auf Stammebene für Editor-Werkzeuge.
  • Die Dokumentationsmetadaten title und description für Felder, die von der Control UI verwendet werden.
  • Verschachtelte Objekt-, Platzhalter- (*) und Array-Elementknoten ([]) übernehmen dieselben title- und description-Metadaten, wenn passende Felddokumentation vorhanden ist.
  • Verzweigungen mit anyOf, oneOf und allOf übernehmen ebenfalls dieselben Dokumentationsmetadaten.
  • Nach Möglichkeit aktuelle Schema-Metadaten für Plugins und Kanäle, wenn Laufzeitmanifeste geladen werden können.
  • Ein bereinigtes Ausweichschema, selbst wenn die aktuelle Konfiguration ungültig ist.
Zugehöriger Laufzeit-RPC

config.schema.lookup gibt einen normalisierten Konfigurationspfad mit einem flachen Schemaknoten (title, description, type, enum, const, allgemeine Grenzwerte), passenden UI-Hinweismetadaten und Zusammenfassungen der unmittelbaren untergeordneten Elemente zurück. Verwenden Sie ihn für eine pfadbezogene Detailansicht in der Control UI oder in benutzerdefinierten Clients.

bash
openclaw config schemaopenclaw config schema > openclaw.schema.json

config validate

Validiert die aktuelle Konfiguration anhand des aktiven Schemas, ohne das Gateway zu starten.

bash
openclaw config validateopenclaw config validate --json

Werte

Werte werden nach Möglichkeit als JSON5 geparst; andernfalls werden sie als unverarbeitete Zeichenfolgen behandelt. Verwenden Sie --strict-json, um Standard-JSON ohne Rückgriff auf eine Zeichenfolge zu verlangen. Reine JSON5-Syntax wie Kommentare, nachgestellte Kommas oder Schlüssel ohne Anführungszeichen wird dann abgelehnt. --json ist bei config set ein veralteter Alias für --strict-json.

bash
openclaw config set agents.defaults.heartbeat.every "0m"openclaw config set gateway.port 19001 --strict-jsonopenclaw config set channels.whatsapp.groups '["*"]' --strict-json

config get <path> --json gibt den Rohwert als JSON statt als für das Terminal formatierten Text aus.

Verwenden Sie --merge, wenn Sie diesen Zuordnungen Einträge hinzufügen:

bash
openclaw config set agents.defaults.models '{"openai/gpt-5.4":{}}' --strict-json --mergeopenclaw config set models.providers.ollama.models '[{"id":"llama3.2","name":"Llama 3.2"}]' --strict-json --merge

Verwenden Sie --replace nur, wenn der angegebene Wert absichtlich zum vollständigen Zielwert werden soll.

Modi von config set

Wertmodus

bash
openclaw config set <path> <value>

SecretRef-Erstellungsmodus

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

Provider-Erstellungsmodus

Ist ausschließlich für Pfade unter secrets.providers.<alias> vorgesehen:

bash
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-timeout-ms 5000

Stapelmodus

bash
openclaw config set --batch-json '[  {    "path": "secrets.providers.default",    "provider": { "source": "env" }  },  {    "path": "channels.discord.token",    "ref": { "source": "env", "provider": "default", "id": "DISCORD_BOT_TOKEN" }  }]'
bash
openclaw config set --batch-file ./config-set.batch.json --dry-run

Beim Parsen von Stapeln dient stets die Stapelnutzlast (--batch-json/--batch-file) als maßgebliche Quelle. --strict-json und --json ändern das Verhalten beim Parsen von Stapeln nicht.

Der JSON-Pfad-/Wertmodus funktioniert auch direkt für SecretRefs und Provider:

bash
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

Flags für die Provider-Erstellung

Ziele der Provider-Erstellung müssen secrets.providers.<alias> als Pfad verwenden.

Allgemeine Flags
  • --provider-source <env|file|exec>
  • --provider-timeout-ms <ms> (file, exec)
Umgebungsvariablen-Provider (--provider-source env)
  • --provider-allowlist &lt;ENV_VAR&gt; (wiederholbar)
Datei-Provider (--provider-source file)
  • --provider-path <path> (erforderlich)
  • --provider-mode <singleValue|json>
  • --provider-max-bytes <bytes>
  • --provider-allow-insecure-path
Ausführungs-Provider (--provider-source exec)
  • --provider-command <path> (erforderlich)
  • --provider-arg <arg> (wiederholbar)
  • --provider-no-output-timeout-ms <ms>
  • --provider-max-output-bytes <bytes>
  • --provider-json-only
  • --provider-env &lt;KEY=VALUE&gt; (wiederholbar)
  • --provider-pass-env &lt;ENV_VAR&gt; (wiederholbar)
  • --provider-trusted-dir <path> (wiederholbar)
  • --provider-allow-insecure-path
  • --provider-allow-symlink-command

Beispiel für einen gehärteten Ausführungs-Provider:

bash
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

config patch

Fügen Sie einen konfigurationsförmigen JSON5-Patch ein oder leiten Sie ihn über eine Pipe weiter, anstatt viele pfadbasierte config set-Befehle auszuführen. Objekte werden rekursiv zusammengeführt; Arrays und skalare Werte ersetzen das Ziel; null löscht den Zielpfad.

bash
openclaw config patch --file ./openclaw.patch.json5 --dry-runopenclaw config patch --file ./openclaw.patch.json5

Leiten Sie für Skripte zur Remote-Einrichtung einen Patch über die Standardeingabe weiter:

bash
ssh user@gateway-host 'openclaw config patch --stdin --dry-run' < ./openclaw.patch.json5ssh user@gateway-host 'openclaw config patch --stdin' < ./openclaw.patch.json5

Beispiel-Patch:

json5
{  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.6-sol" },      models: {        "openai/gpt-5.6-sol": { params: { fastMode: true } },      },    },  },}

Verwenden Sie --replace-path <path>, wenn ein Objekt oder Array exakt zum angegebenen Wert werden soll, anstatt rekursiv gepatcht zu werden:

bash
openclaw config patch --file ./discord.patch.json5 --replace-path 'channels.discord.guilds["123"].channels'

--dry-run führt Schema- und SecretRef-Auflösbarkeitsprüfungen durch, ohne zu schreiben. Auf Ausführungsbefehlen basierende SecretRefs werden während eines Probelaufs standardmäßig übersprungen. Fügen Sie --allow-exec hinzu, wenn der Probelauf absichtlich Provider-Befehle ausführen soll.

Probelauf

--dry-run validiert Änderungen, ohne openclaw.json zu schreiben. Verfügbar für config set, config patch und config unset.

bash
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
Verhalten des Probelaufs
  • Builder-Modus: Führt Prüfungen zur Auflösbarkeit von SecretRefs für geänderte Referenzen/Provider aus.
  • JSON-Modus (--strict-json, --json oder Batch-Modus): Führt die Schemavalidierung sowie Prüfungen zur Auflösbarkeit von SecretRefs aus.
  • Die Richtlinienvalidierung wird für die vollständige Konfiguration nach der Änderung ausgeführt, sodass Schreibvorgänge übergeordneter Objekte (beispielsweise das Festlegen von hooks als Objekt) die Validierung nicht unterstützter Bereiche nicht umgehen können.
  • Prüfungen von Exec-SecretRefs werden standardmäßig übersprungen, um Nebenwirkungen von Befehlen zu vermeiden. Übergeben Sie --allow-exec, um sie zu aktivieren (dadurch können Provider-Befehle ausgeführt werden). --allow-exec ist nur für Probeläufe vorgesehen und führt ohne --dry-run zu einem Fehler.
Felder von --dry-run --json
  • ok: Gibt an, ob der Probelauf erfolgreich war.
  • operations: Anzahl der ausgewerteten Zuweisungen
  • checks: Gibt an, ob Schema-/Auflösbarkeitsprüfungen ausgeführt wurden.
  • checks.resolvabilityComplete: Gibt an, ob die Auflösbarkeitsprüfungen vollständig ausgeführt wurden (false, wenn Exec-Referenzen übersprungen werden).
  • refsChecked: Anzahl der während des Probelaufs tatsächlich aufgelösten Referenzen
  • skippedExecRefs: Anzahl der übersprungenen Exec-Referenzen, weil --allow-exec nicht gesetzt war
  • errors: Strukturierte Fehler aufgrund fehlender Pfade, des Schemas oder der Auflösbarkeit, wenn ok=false

Struktur der JSON-Ausgabe

json5
{  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, // bei Auflösbarkeitsfehlern vorhanden    },  ],}

Beispiel für Erfolg

json
{  "ok": true,  "operations": 1,  "configPath": "~/.openclaw/openclaw.json",  "inputModes": ["builder"],  "checks": {    "schema": false,    "resolvability": true,    "resolvabilityComplete": true  },  "refsChecked": 1,  "skippedExecRefs": 0}

Beispiel für einen Fehler

json
{  "ok": false,  "operations": 1,  "configPath": "~/.openclaw/openclaw.json",  "inputModes": ["builder"],  "checks": {    "schema": false,    "resolvability": true,    "resolvabilityComplete": true  },  "refsChecked": 1,  "skippedExecRefs": 0,  "errors": [    {      "kind": "resolvability",      "message": "Error: Environment variable \"MISSING_TEST_SECRET\" is not set.",      "ref": "env:default:MISSING_TEST_SECRET"    }  ]}
Wenn der Probelauf fehlschlägt
  • config schema validation failed: Die Struktur Ihrer Konfiguration nach der Änderung ist ungültig. Korrigieren Sie den Pfad/Wert oder die Struktur des Provider-/Referenzobjekts.
  • Config policy validation failed: unsupported SecretRef usage: Verschieben Sie diese Zugangsdaten zurück in eine Klartext-/Zeichenketteneingabe. Verwenden Sie SecretRefs nur in unterstützten Bereichen.
  • SecretRef assignment(s) could not be resolved: Der referenzierte Provider bzw. die referenzierte Referenz kann derzeit nicht aufgelöst werden (fehlende Umgebungsvariable, ungültiger Dateizeiger, Fehler des Exec-Providers oder Abweichung zwischen Provider und Quelle).
  • Dry run note: skipped <n> exec SecretRef resolvability check(s): Führen Sie den Vorgang mit --allow-exec erneut aus, wenn Sie die Auflösbarkeit von Exec-Referenzen validieren müssen.
  • Korrigieren Sie im Batch-Modus fehlerhafte Einträge und führen Sie --dry-run vor dem Schreiben erneut aus.

Änderungen anwenden

Nach jedem erfolgreichen config set / config patch / config unset gibt die CLI einen von drei Hinweisen aus, damit Sie wissen, ob der Gateway neu gestartet werden muss:

Hinweis Bedeutung
Restart the gateway to apply. Der geänderte Pfad erfordert einen vollständigen Neustart.
Change will apply without restarting the gateway. Hot-Reload übernimmt die Änderung automatisch.
No gateway restart needed. Es wurde nichts Laufzeitrelevantes geändert.

Schreibvorgänge in plugins.entries (oder einen beliebigen Unterpfad) erfordern immer einen Neustart, da die CLI nicht nachweisen kann, dass die Reload-Metadaten jedes Plugins geladen sind.

Schreibsicherheit

openclaw config set und andere OpenClaw-eigene Konfigurationswerkzeuge validieren vor dem Speichern auf dem Datenträger die vollständige Konfiguration nach der Änderung. Wenn die neuen Daten die Schemavalidierung nicht bestehen oder wie ein destruktives Überschreiben aussehen, bleibt die aktive Konfiguration unverändert und die abgelehnten Daten werden daneben als openclaw.json.rejected.* gespeichert.

Bevorzugen Sie für kleine Änderungen Schreibvorgänge über die CLI:

bash
openclaw config set gateway.reload.mode hybrid --dry-runopenclaw config set gateway.reload.mode hybridopenclaw config validate

Wenn ein Schreibvorgang abgelehnt wird, überprüfen Sie die gespeicherten Daten und korrigieren Sie die vollständige Konfigurationsstruktur:

bash
CONFIG="$(openclaw config file)"ls -lt "$CONFIG".rejected.* 2>/dev/null | headopenclaw config validate

Direkte Änderungen mit einem Editor sind weiterhin zulässig, aber der laufende Gateway behandelt sie als nicht vertrauenswürdig, bis sie erfolgreich validiert wurden. Ungültige direkte Änderungen verhindern den Start oder werden beim Hot-Reload übersprungen. Der Gateway schreibt openclaw.json nicht neu. Führen Sie openclaw doctor --fix aus, um Konfigurationen mit unerwünschten Präfixen oder Überschreibungen zu reparieren oder die letzte als funktionierend bekannte Kopie wiederherzustellen. Weitere Informationen finden Sie unter Fehlerbehebung für den Gateway.

Die Wiederherstellung der gesamten Datei ist der Reparatur durch Doctor vorbehalten. Änderungen am Plugin-Schema oder Abweichungen bei minHostVersion führen weiterhin zu einem deutlichen Fehler, statt nicht zusammenhängende Benutzereinstellungen wie Modelle, Provider, Authentifizierungsprofile, Kanäle, Gateway-Erreichbarkeit, Werkzeuge, Speicher, Browser oder Cron-Konfiguration zurückzusetzen.

Reparaturschleife

Nachdem openclaw config validate erfolgreich abgeschlossen wurde, verwenden Sie die lokale TUI, damit ein eingebetteter Agent die aktive Konfiguration mit der Dokumentation vergleicht, während Sie jede Änderung im selben Terminal validieren:

bash
openclaw chat

Innerhalb der TUI führt ein vorangestelltes ! einen wörtlichen lokalen Shell-Befehl aus (nach einer einmaligen Bestätigungsabfrage pro Sitzung):

text
!openclaw config file!openclaw docs gateway auth token secretref!openclaw config validate!openclaw doctor
  • Mit der Dokumentation vergleichen

    Bitten Sie den Agenten, Ihre aktuelle Konfiguration mit der relevanten Dokumentationsseite zu vergleichen und die kleinste erforderliche Korrektur vorzuschlagen.

  • Gezielte Änderungen anwenden

    Wenden Sie gezielte Änderungen mit openclaw config set oder openclaw configure an.

  • Erneut validieren

    Führen Sie openclaw config validate nach jeder Änderung erneut aus.

  • Doctor bei Laufzeitproblemen verwenden

    Wenn die Validierung erfolgreich ist, die Laufzeit aber weiterhin nicht ordnungsgemäß funktioniert, führen Sie openclaw doctor oder openclaw doctor --fix aus, um Unterstützung bei Migration und Reparatur zu erhalten.

  • Verwandte Themen

    Was this useful?
    On this page

    On this page