openclaw.json: pobieranie/ustawianie/nakładanie poprawek/usuwanie/plik/schemat/walidacja wartości według ścieżki oraz wypisywanie aktywnego pliku konfiguracji. Uruchom bez podkomendy, aby otworzyć kreator konfiguracji (tak samo jak openclaw configure).
Gdy
OPENCLAW_NIX_MODE=1, OpenClaw traktuje openclaw.json jako niezmienny. Polecenia tylko do odczytu, takie jak config get, config file, config schema i config validate, nadal działają, ale polecenia zapisujące konfigurację odmawiają działania. Agenci powinni zamiast tego edytować źródło Nix dla instalacji; dla własnej dystrybucji nix-openclaw użyj nix-openclaw Quick Start i ustaw wartości pod programs.openclaw.config lub instances.<name>.config.Opcje główne
Powtarzalny filtr sekcji konfiguracji prowadzonej, gdy uruchamiasz
openclaw config bez podkomendy.workspace, model, web, gateway, daemon, channels, plugins, skills, health.
Przykłady
config schema
Wypisuje wygenerowany schemat JSON dla openclaw.json na stdout jako JSON.
Co zawiera
Co zawiera
- Bieżący główny schemat konfiguracji oraz główne pole tekstowe
$schemadla narzędzi edytora. - Metadane dokumentacji pól
titleidescriptionużywane przez Control UI. - Zagnieżdżone obiekty, symbole wieloznaczne (
*) i węzły elementów tablicy ([]) dziedziczą te same metadanetitle/description, gdy istnieje pasująca dokumentacja pola. - Gałęzie
anyOf/oneOf/allOftakże dziedziczą te same metadane dokumentacji, gdy istnieje pasująca dokumentacja pola. - Metadane schematu Pluginów i kanałów w trybie live na zasadzie najlepszej możliwości, gdy można wczytać manifesty runtime.
- Czysty schemat awaryjny nawet wtedy, gdy bieżąca konfiguracja jest nieprawidłowa.
Powiązane runtime RPC
Powiązane runtime RPC
config.schema.lookup zwraca jedną znormalizowaną ścieżkę konfiguracji z płytkim węzłem schemat (title, description, type, enum, const, wspólne ograniczenia), dopasowanymi metadanymi podpowiedzi UI oraz podsumowaniami bezpośrednich elementów podrzędnych. Użyj tego do szczegółowego przechodzenia po ścieżkach w Control UI lub klientach niestandardowych.Ścieżki
Ścieżki używają notacji kropkowej lub nawiasowej. Cytuj ścieżki w notacji nawiasowej w przykładach powłoki, aby powłoki takie jak zsh nie rozwijały[0] jako globu, zanim OpenClaw otrzyma ścieżkę:
Wartości
Wartości są parsowane jako JSON5, gdy to możliwe; w przeciwnym razie są traktowane jako ciągi znaków. Użyj--strict-json, aby wymagać standardowego parsowania JSON bez awaryjnego traktowania jako ciąg znaków. --json pozostaje obsługiwane jako starszy alias dla --strict-json.
--strict-json jest włączone, składnia dostępna tylko w JSON5, taka jak komentarze, końcowe przecinki lub niecytowane klucze obiektów, jest odrzucana. Pomiń --strict-json, aby parsować wartości JSON5 z awaryjnym użyciem surowego ciągu znaków.
config get <path> --json wypisuje surową wartość jako JSON zamiast tekstu formatowanego dla terminala.
Przypisanie obiektu domyślnie zastępuje ścieżkę docelową. Chronione ścieżki map/list, które często przechowują wpisy dodane przez użytkownika, takie jak
agents.defaults.models, models.providers, models.providers.<id>.models, plugins.entries i auth.profiles, odmawiają zastąpień, które usunęłyby istniejące wpisy, chyba że przekażesz --replace.--merge, gdy dodajesz wpisy do tych map:
--replace tylko wtedy, gdy celowo chcesz, aby podana wartość stała się pełną wartością docelową.
Tryby config set
openclaw config set obsługuje cztery style przypisania:
- Tryb wartości
- Tryb kreatora SecretRef
- Tryb kreatora dostawcy
- Tryb wsadowy
--batch-json/--batch-file) jako źródła prawdy. --strict-json / --json nie zmieniają zachowania parsowania wsadowego.
config patch
Użyj config patch, gdy chcesz wkleić lub przekierować poprawkę w kształcie konfiguracji zamiast uruchamiać wiele poleceń config set opartych na ścieżkach. Wejście jest obiektem JSON5. Obiekty scalają się rekurencyjnie, tablice i wartości skalarne zastępują wartość docelową, a null usuwa ścieżkę docelową.
--replace-path <path>, gdy jeden obiekt lub tablica musi stać się dokładnie podaną wartością zamiast być poprawiany rekurencyjnie:
--dry-run uruchamia sprawdzanie schematu i rozwiązywalności SecretRef bez zapisywania. SecretRefy oparte na exec są domyślnie pomijane podczas dry-run; dodaj --allow-exec, gdy celowo chcesz, aby dry-run wykonywał polecenia dostawcy.
Tryb ścieżki/wartości JSON pozostaje obsługiwany zarówno dla SecretRefów, jak i dostawców:
Flagi kreatora dostawcy
Cele kreatora dostawcy muszą używaćsecrets.providers.<alias> jako ścieżki.
Wspólne flagi
Wspólne flagi
--provider-source <env|file|exec>--provider-timeout-ms <ms>(file,exec)
Dostawca env (--provider-source env)
Dostawca env (--provider-source env)
--provider-allowlist <ENV_VAR>(powtarzalne)
Dostawca plikowy (--provider-source file)
Dostawca plikowy (--provider-source file)
--provider-path <path>(wymagane)--provider-mode <singleValue|json>--provider-max-bytes <bytes>--provider-allow-insecure-path
Dostawca exec (--provider-source exec)
Dostawca exec (--provider-source exec)
--provider-command <path>(wymagane)--provider-arg <arg>(powtarzalne)--provider-no-output-timeout-ms <ms>--provider-max-output-bytes <bytes>--provider-json-only--provider-env <KEY=VALUE>(powtarzalne)--provider-pass-env <ENV_VAR>(powtarzalne)--provider-trusted-dir <path>(powtarzalne)--provider-allow-insecure-path--provider-allow-symlink-command
Dry run
Użyj--dry-run, aby zweryfikować zmiany bez zapisywania openclaw.json.
Zachowanie dry-run
Zachowanie dry-run
- Tryb buildera: uruchamia kontrole rozwiązywalności SecretRef dla zmienionych refs/providers.
- Tryb JSON (
--strict-json,--jsonlub tryb wsadowy): uruchamia walidację schematu oraz kontrole rozwiązywalności SecretRef. - Walidacja zasad uruchamia się również dla znanych nieobsługiwanych powierzchni docelowych SecretRef.
- Kontrole zasad oceniają pełną konfigurację po zmianie, więc zapisy obiektu nadrzędnego (na przykład ustawienie
hooksjako obiektu) nie mogą ominąć walidacji nieobsługiwanej powierzchni. - Kontrole exec SecretRef są domyślnie pomijane podczas dry-run, aby uniknąć skutków ubocznych poleceń.
- Użyj
--allow-execz--dry-run, aby włączyć kontrole exec SecretRef (może to wykonać polecenia dostawcy). --allow-execdziała tylko z dry-run i zgłasza błąd, jeśli zostanie użyte bez--dry-run.
Pola --dry-run --json
Pola --dry-run --json
--dry-run --json wypisuje raport czytelny maszynowo:ok: czy dry-run zakończył się powodzeniemoperations: liczba ocenionych przypisańchecks: czy uruchomiono kontrole schematu/rozwiązywalnościchecks.resolvabilityComplete: czy kontrole rozwiązywalności dobiegły końca (false, gdy refs exec są pomijane)refsChecked: liczba refs faktycznie rozwiązanych podczas dry-runskippedExecRefs: liczba refs exec pominiętych, ponieważ--allow-execnie zostało ustawioneerrors: ustrukturyzowane błędy brakującej ścieżki, schematu lub rozwiązywalności, gdyok=false
Kształt danych wyjściowych JSON
- Przykład sukcesu
- Przykład niepowodzenia
Jeśli dry-run się nie powiedzie
Jeśli dry-run się nie powiedzie
config schema validation failed: kształt konfiguracji po zmianie jest nieprawidłowy; popraw ścieżkę/wartość albo kształt obiektu provider/ref.Config policy validation failed: unsupported SecretRef usage: przenieś te dane uwierzytelniające z powrotem do wejścia plaintext/string i utrzymuj SecretRefs tylko na obsługiwanych powierzchniach.SecretRef assignment(s) could not be resolved: wskazany provider/ref obecnie nie może zostać rozwiązany (brakująca zmienna env, nieprawidłowy wskaźnik pliku, awaria dostawcy exec albo niezgodność dostawcy/źródła).Dry run note: skipped <n> exec SecretRef resolvability check(s): dry-run pominął refs exec; uruchom ponownie z--allow-exec, jeśli potrzebujesz walidacji rozwiązywalności exec.- W trybie wsadowym popraw wpisy kończące się niepowodzeniem i uruchom ponownie
--dry-runprzed zapisem.
Bezpieczeństwo zapisu
openclaw config set i inne narzędzia zapisujące konfigurację należące do OpenClaw walidują pełną konfigurację po zmianie przed zapisaniem jej na dysku. Jeśli nowy payload nie przejdzie walidacji schematu albo wygląda jak destrukcyjne nadpisanie, aktywna konfiguracja pozostaje bez zmian, a odrzucony payload jest zapisywany obok niej jako openclaw.json.rejected.*.
Preferuj zapisy przez CLI przy małych edycjach:
openclaw.json. Uruchom openclaw doctor --fix, aby naprawić konfigurację z prefiksem/nadpisaną albo przywrócić ostatnią znaną dobrą kopię. Zobacz rozwiązywanie problemów z Gateway.
Odzyskiwanie całego pliku jest zarezerwowane dla naprawy przez doctora. Zmiany schematu Plugin lub rozjazd minHostVersion pozostają wyraźnie sygnalizowane zamiast wycofywać niepowiązane ustawienia użytkownika, takie jak modele, dostawcy, profile auth, kanały, ekspozycja Gateway, narzędzia, pamięć, przeglądarka czy konfiguracja cron.
Podpolecenia
config file: Wypisuje ścieżkę aktywnego pliku konfiguracji (rozwiązaną zOPENCLAW_CONFIG_PATHalbo domyślnej lokalizacji). Ścieżka powinna wskazywać zwykły plik, a nie symlink.
Walidacja
Waliduj bieżącą konfigurację względem aktywnego schematu bez uruchamiania gateway.openclaw config validate przechodzi, możesz użyć lokalnego TUI, aby osadzony agent porównał aktywną konfigurację z dokumentacją podczas walidowania każdej zmiany z tego samego terminala:
Jeśli walidacja już się nie powodzi, zacznij od
openclaw configure albo openclaw doctor --fix. openclaw chat nie omija ochrony przed nieprawidłową konfiguracją.Porównaj z dokumentacją
Poproś agenta o porównanie bieżącej konfiguracji z odpowiednią stroną dokumentacji i zasugerowanie najmniejszej poprawki.
Zastosuj ukierunkowane edycje
Zastosuj ukierunkowane edycje za pomocą
openclaw config set albo openclaw configure.