openclaw config
Допоміжні команди конфігурації для неінтерактивного редагування в openclaw.json: get/set/unset/file/schema/validate
значень за шляхом і виведення активного файла конфігурації. Запустіть без підкоманди, щоб
відкрити майстер налаштування (те саме, що openclaw configure).
Кореневі параметри:
--section <section>: повторюваний фільтр розділів покрокового налаштування, коли ви запускаєтеopenclaw configбез підкоманди
workspacemodelwebgatewaydaemonchannelspluginsskillshealth
Приклади
config schema
Виводить згенеровану JSON-схему для openclaw.json у stdout як JSON.
Що вона містить:
- Поточну кореневу схему конфігурації, а також кореневе строкове поле
$schemaдля інструментів редактора - Метадані документації полів
titleіdescription, що використовуються інтерфейсом керування - Вкладені об’єкти, вузли wildcard (
*) і елементи масиву ([]) успадковують ті самі метаданіtitle/description, коли для відповідного поля існує документація - Гілки
anyOf/oneOf/allOfтакож успадковують ті самі метадані документації, коли для відповідного поля існує документація - Live-метадані схеми Plugin + channel за принципом best-effort, коли можна завантажити маніфести середовища виконання
- Чисту резервну схему навіть тоді, коли поточна конфігурація невалідна
config.schema.lookupповертає один нормалізований шлях конфігурації з поверхневим вузлом схеми (title,description,type,enum,const, поширені межі), відповідними метаданими UI hints і зведеннями безпосередніх дочірніх елементів. Використовуйте це для деталізації за шляхом в інтерфейсі керування або в користувацьких клієнтах.
Шляхи
Шляхи використовують крапкову нотацію або нотацію з дужками:Значення
Значення розбираються як JSON5, коли це можливо; інакше вони трактуються як рядки. Використовуйте--strict-json, щоб вимагати розбір JSON5. --json і далі підтримується як застарілий псевдонім.
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 підтримує чотири стилі присвоєння:
- Режим значення:
openclaw config set <path> <value> - Режим побудови SecretRef:
- Режим побудови provider (лише для шляху
secrets.providers.<alias>):
- Пакетний режим (
--batch-jsonабо--batch-file):
- Присвоєння SecretRef відхиляються на непідтримуваних поверхнях runtime-mutable (наприклад,
hooks.token,commands.ownerDisplaySecret, токени Webhook для прив’язки потоків Discord і JSON облікових даних WhatsApp). Див. Поверхня облікових даних SecretRef.
--batch-json/--batch-file) як джерело істини.
--strict-json / --json не змінюють поведінку пакетного розбору.
Режим шляху/значення JSON і далі підтримується як для SecretRef, так і для provider:
Прапорці побудови provider
Цілі побудови provider повинні використовуватиsecrets.providers.<alias> як шлях.
Поширені прапорці:
--provider-source <env|file|exec>--provider-timeout-ms <ms>(file,exec)
--provider-source env):
--provider-allowlist <ENV_VAR>(можна повторювати)
--provider-source file):
--provider-path <path>(обов’язково)--provider-mode <singleValue|json>--provider-max-bytes <bytes>
--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, щоб валідувати зміни без запису в openclaw.json.
- Режим побудови: запускає перевірки розв’язуваності SecretRef для змінених ref/provider.
- Режим JSON (
--strict-json,--jsonабо пакетний режим): запускає валідацію схеми та перевірки розв’язуваності SecretRef. - Валідація політики також запускається для відомих непідтримуваних цільових поверхонь SecretRef.
- Перевірки політики оцінюють повну конфігурацію після змін, тому записи батьківських об’єктів (наприклад, встановлення
hooksяк об’єкта) не можуть обійти валідацію непідтримуваних поверхонь. - Перевірки exec SecretRef типово пропускаються під час сухого запуску, щоб уникнути побічних ефектів команд.
- Використовуйте
--allow-execразом із--dry-run, щоб увімкнути перевірки exec SecretRef (це може виконати команди provider). --allow-execпризначений лише для сухого запуску й спричиняє помилку, якщо використовується без--dry-run.
--dry-run --json виводить машинозчитуваний звіт:
ok: чи пройдено сухий запускoperations: кількість оцінених присвоєньchecks: чи запускалися перевірки схеми/розв’язуваностіchecks.resolvabilityComplete: чи були перевірки розв’язуваності виконані до кінця (false, коли exec ref пропущено)refsChecked: кількість ref, фактично розв’язаних під час сухого запускуskippedExecRefs: кількість exec ref, пропущених через те, що не було встановлено--allow-execerrors: структуровані збої схеми/розв’язуваності, колиok=false
Форма виводу JSON
config schema validation failed: форма вашої конфігурації після змін невалідна; виправте шлях/значення або форму об’єкта provider/ref.Config policy validation failed: unsupported SecretRef usage: перенесіть цей обліковий запис назад у plaintext/string input і залишайте SecretRef лише на підтримуваних поверхнях.SecretRef assignment(s) could not be resolved: на цей момент не вдається розв’язати вказаний provider/ref (відсутня змінна середовища, невалідний вказівник на файл, збій exec provider або невідповідність provider/source).Dry run note: skipped <n> exec SecretRef resolvability check(s): сухий запуск пропустив exec ref; перезапустіть з--allow-exec, якщо вам потрібна валідація розв’язуваності exec.- Для пакетного режиму виправте записи, які не пройшли, і перед записом повторно запустіть
--dry-run.
Безпека запису
openclaw config set та інші засоби запису конфігурації, якими керує OpenClaw, валідують повну
конфігурацію після змін перед її збереженням на диск. Якщо нове корисне навантаження не проходить
валідацію схеми або виглядає як руйнівне перезаписування, активна конфігурація залишається без змін,
а відхилене корисне навантаження зберігається поруч як openclaw.json.rejected.*.
Активний шлях конфігурації має бути звичайним файлом. Макети openclaw.json
із символічними посиланнями не підтримуються для запису; натомість використовуйте OPENCLAW_CONFIG_PATH, щоб вказати безпосередньо
на реальний файл.
Для невеликих змін віддавайте перевагу запису через CLI:
Підкоманди
config file: Вивести шлях до активного файла конфігурації (визначений зOPENCLAW_CONFIG_PATHабо стандартного розташування). Шлях має вказувати на звичайний файл, а не на символічне посилання.
Валідація
Валідуйте поточну конфігурацію щодо активної схеми без запуску gateway.openclaw config validate почне проходити, ви можете використовувати локальний TUI, щоб
вбудований агент порівняв активну конфігурацію з документацією, поки ви валідуєте
кожну зміну з того самого термінала:
Якщо валідація вже не проходить, почніть з openclaw configure або
openclaw doctor --fix. openclaw chat не обходить захист від
невалідної конфігурації.
- Попросіть агента порівняти вашу поточну конфігурацію з відповідною сторінкою документації та запропонувати найменше виправлення.
- Застосуйте цільові зміни за допомогою
openclaw config setабоopenclaw configure. - Повторно запускайте
openclaw config validateпісля кожної зміни. - Якщо валідація проходить, але середовище виконання все ще нездорове, запустіть
openclaw doctorабоopenclaw doctor --fixдля допомоги з міграцією та виправленням.