openclaw.json: отримуйте/задавайте/застосовуйте патчі/скасовуйте/переглядайте файл/схему/перевіряйте значення за шляхом і виводьте активний файл конфігурації. Запустіть без підкоманди, щоб відкрити майстер налаштування (те саме, що openclaw configure).
Коли
OPENCLAW_NIX_MODE=1, OpenClaw розглядає openclaw.json як незмінний. Команди лише для читання, як-от config get, config file, config schema і config validate, і далі працюють, але команди запису конфігурації відмовляються виконуватись. Натомість агенти мають редагувати джерело Nix для інсталяції; для офіційного дистрибутива nix-openclaw використовуйте nix-openclaw Quick Start і задавайте значення в programs.openclaw.config або instances.<name>.config.Кореневі параметри
Повторюваний фільтр розділу керованого налаштування, коли ви запускаєте
openclaw config без підкоманди.workspace, model, web, gateway, daemon, channels, plugins, skills, health.
Приклади
config schema
Виводить згенеровану схему JSON для openclaw.json у stdout як JSON.
Що вона містить
Що вона містить
- Поточну кореневу схему конфігурації, а також кореневе рядкове поле
$schemaдля інструментів редактора. - Метадані документації полів
titleіdescription, які використовує Control UI. - Вкладені об’єкти, wildcard-вузли (
*) і вузли елементів масиву ([]) успадковують ті самі метаданіtitle/description, коли існує відповідна документація поля. - Гілки
anyOf/oneOf/allOfтакож успадковують ті самі метадані документації, коли існує відповідна документація поля. - Найкращі доступні живі метадані схем plugin + каналу, коли можна завантажити маніфести runtime.
- Чисту резервну схему навіть тоді, коли поточна конфігурація недійсна.
Пов’язаний runtime RPC
Пов’язаний runtime RPC
config.schema.lookup повертає один нормалізований шлях конфігурації з поверхневим вузлом схеми (title, description, type, enum, const, поширені межі), відповідними метаданими підказки UI та короткими описами безпосередніх дочірніх елементів. Використовуйте це для деталізації в межах шляху в Control UI або власних клієнтах.Шляхи
Шляхи використовують крапкову або дужкову нотацію. Беріть шляхи в дужковій нотації в лапки в прикладах shell, щоб shell, як-от zsh, не розгортав[0] як glob до того, як OpenClaw отримає шлях:
Значення
Значення за можливості розбираються як JSON5; інакше вони трактуються як рядки. Використовуйте--strict-json, щоб вимагати стандартний розбір JSON без резервного трактування як рядка. --json і далі підтримується як застарілий псевдонім для --strict-json.
--strict-json, синтаксис, властивий лише JSON5, як-от коментарі, кінцеві коми або не взяті в лапки ключі об’єктів, відхиляється. Опустіть --strict-json для розбору значень JSON5 із резервним трактуванням як необробленого рядка.
config get <path> --json виводить необроблене значення як JSON замість тексту, відформатованого для термінала.
Присвоєння об’єкта типово замінює цільовий шлях. Захищені шляхи map/list, які зазвичай містять додані користувачем записи, як-от
agents.defaults.models, models.providers, models.providers.<id>.models, plugins.entries і auth.profiles, відмовляються від замін, які видалили б наявні записи, якщо не передати --replace.--merge, коли додаєте записи до цих map:
--replace лише тоді, коли навмисно хочете, щоб надане значення стало повним цільовим значенням.
Режими config set
openclaw config set підтримує чотири стилі присвоєння:
- Режим значення
- Режим конструктора SecretRef
- Режим конструктора провайдера
- Пакетний режим
--batch-json/--batch-file) як джерело істини. --strict-json / --json не змінюють поведінку пакетного розбору.
config patch
Використовуйте config patch, коли хочете вставити або передати через pipe патч у формі конфігурації замість запуску багатьох команд config set на основі шляхів. Вхідні дані є об’єктом JSON5. Об’єкти рекурсивно об’єднуються, масиви й скалярні значення замінюють цільове значення, а null видаляє цільовий шлях.
--replace-path <path>, коли один об’єкт або масив має стати точно наданим значенням замість рекурсивного застосування патча:
--dry-run запускає перевірки схеми та розв’язності SecretRef без запису. SecretRefs на основі exec типово пропускаються під час dry-run; додайте --allow-exec, коли навмисно хочете, щоб dry-run виконував команди провайдера.
Режим JSON шлях/значення і далі підтримується як для SecretRefs, так і для провайдерів:
Прапорці конструктора провайдера
Цілі конструктора провайдера мають використовуватиsecrets.providers.<alias> як шлях.
Спільні прапорці
Спільні прапорці
--provider-source <env|file|exec>--provider-timeout-ms <ms>(file,exec)
Env-провайдер (--provider-source env)
Env-провайдер (--provider-source env)
--provider-allowlist <ENV_VAR>(повторюваний)
File-провайдер (--provider-source file)
File-провайдер (--provider-source file)
--provider-path <path>(обов’язковий)--provider-mode <singleValue|json>--provider-max-bytes <bytes>--provider-allow-insecure-path
Exec-провайдер (--provider-source exec)
Exec-провайдер (--provider-source exec)
--provider-command <path>(обов’язковий)--provider-arg <arg>(повторюваний)--provider-no-output-timeout-ms <ms>--provider-max-output-bytes <bytes>--provider-json-only--provider-env <KEY=VALUE>(повторюваний)--provider-pass-env <ENV_VAR>(повторюваний)--provider-trusted-dir <path>(повторюваний)--provider-allow-insecure-path--provider-allow-symlink-command
Dry run
Використовуйте--dry-run, щоб перевірити зміни без запису openclaw.json.
Поведінка dry-run
Поведінка dry-run
- Режим builder: запускає перевірки розв’язності SecretRef для змінених refs/провайдерів.
- Режим JSON (
--strict-json,--jsonабо пакетний режим): запускає перевірку схеми та перевірки розв’язності SecretRef. - Перевірка політики також виконується для відомих непідтримуваних цільових поверхонь SecretRef.
- Перевірки політики оцінюють повну конфігурацію після зміни, тому записи батьківських об’єктів (наприклад, встановлення
hooksяк об’єкта) не можуть обійти перевірку непідтримуваних поверхонь. - Перевірки exec SecretRef типово пропускаються під час dry-run, щоб уникнути побічних ефектів команд.
- Використовуйте
--allow-execіз--dry-run, щоб увімкнути перевірки exec SecretRef (це може виконати команди провайдера). --allow-execпрацює лише для dry-run і завершується помилкою, якщо використовується без--dry-run.
Поля --dry-run --json
Поля --dry-run --json
--dry-run --json виводить машинозчитуваний звіт:ok: чи dry-run пройшов успішноoperations: кількість оцінених присвоєньchecks: чи виконувалися перевірки схеми/розв’язностіchecks.resolvabilityComplete: чи перевірки розв’язності виконалися до завершення (false, коли exec refs пропущено)refsChecked: кількість refs, фактично розв’язаних під час dry-runskippedExecRefs: кількість exec refs, пропущених через те, що--allow-execне було заданоerrors: структуровані помилки відсутнього шляху, схеми або розв’язності, колиok=false
Форма виводу JSON
- Приклад успіху
- Приклад збою
Якщо dry-run завершується помилкою
Якщо dry-run завершується помилкою
config schema validation failed: форма вашої конфігурації після зміни недійсна; виправте шлях/значення або форму об’єкта провайдера/ref.Config policy validation failed: unsupported SecretRef usage: поверніть ці облікові дані до відкритого тексту/рядкового вводу й використовуйте SecretRefs лише на підтримуваних поверхнях.SecretRef assignment(s) could not be resolved: вказаний провайдер/ref наразі не може розв’язатися (відсутня змінна середовища, недійсний файловий вказівник, збій exec-провайдера або невідповідність провайдера/джерела).Dry run note: skipped <n> exec SecretRef resolvability check(s): dry-run пропустив exec refs; запустіть повторно з--allow-exec, якщо вам потрібна перевірка розв’язності exec.- Для пакетного режиму виправте записи, що завершилися помилкою, і повторно запустіть
--dry-runперед записом.
Безпека запису
openclaw config set та інші засоби запису конфігурації, що належать OpenClaw, перевіряють повну конфігурацію після зміни перед записом на диск. Якщо нове корисне навантаження не проходить перевірку схеми або схоже на руйнівне перезаписування, активна конфігурація залишається без змін, а відхилене корисне навантаження зберігається поруч як openclaw.json.rejected.*.
Віддавайте перевагу записам через CLI для невеликих редагувань:
openclaw.json. Запустіть openclaw doctor --fix, щоб виправити конфігурацію з префіксами/перезаписуванням або відновити останню відому робочу копію. Див. Усунення несправностей Gateway.
Відновлення всього файлу зарезервоване для виправлення через doctor. Зміни схем Plugin або розбіжність minHostVersion залишаються явними, замість того щоб відкочувати непов’язані налаштування користувача, як-от конфігурацію моделей, провайдерів, профілів автентифікації, каналів, доступності Gateway, інструментів, пам’яті, браузера або cron.
Підкоманди
config file: Вивести шлях до активного файлу конфігурації (визначений ізOPENCLAW_CONFIG_PATHабо стандартного розташування). Шлях має вказувати на звичайний файл, а не на симлінк.
Перевірка
Перевірте поточну конфігурацію за активною схемою без запуску gateway.openclaw config validate можна використати локальний TUI, щоб вбудований агент порівняв активну конфігурацію з документацією, поки ви перевіряєте кожну зміну з того самого термінала:
Якщо перевірка вже не проходить, почніть з
openclaw configure або openclaw doctor --fix. openclaw chat не обходить захист від недійсної конфігурації.Порівняти з документацією
Попросіть агента порівняти вашу поточну конфігурацію з відповідною сторінкою документації та запропонувати найменше виправлення.
Застосувати цільові редагування
Застосуйте цільові редагування за допомогою
openclaw config set або openclaw configure.