openclaw.json: получение/задание/применение патча/снятие/файл/схема/проверка значений по пути и вывод активного файла конфигурации. Запустите без подкоманды, чтобы открыть мастер настройки (то же самое, что openclaw configure).
Когда
OPENCLAW_NIX_MODE=1, OpenClaw считает openclaw.json неизменяемым. Команды только для чтения, такие как config get, config file, config schema и config validate, по-прежнему работают, но команды записи конфигурации отказываются выполняться. Вместо этого агенты должны редактировать Nix-источник установки; для официального дистрибутива nix-openclaw используйте краткое руководство nix-openclaw и задавайте значения в 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также наследуют те же метаданные документации, когда существует соответствующая документация поля. - Метаданные схемы live Plugin + канала по мере возможности, когда можно загрузить манифесты времени выполнения.
- Чистая резервная схема даже тогда, когда текущая конфигурация недействительна.
Связанный RPC времени выполнения
Связанный RPC времени выполнения
config.schema.lookup возвращает один нормализованный путь конфигурации с неглубоким узлом схемы (title, description, type, enum, const, общие ограничения), соответствующими метаданными подсказки UI и сводками непосредственных дочерних элементов. Используйте его для детализации по путям в Control UI или пользовательских клиентах.Пути
Пути используют точечную или скобочную нотацию. Заключайте пути в скобочной нотации в кавычки в примерах 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 без записи. SecretRef на основе exec по умолчанию пропускаются во время dry-run; добавьте --allow-exec, когда намеренно хотите, чтобы dry-run выполнял команды провайдера.
Режим пути/значения JSON по-прежнему поддерживается как для SecretRef, так и для провайдеров:
Флаги конструктора провайдера
Цели конструктора провайдера должны использовать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>(повторяемый)
Файловый провайдер (--provider-source 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, чтобы проверить изменения без записи openclaw.json.
Поведение пробного запуска
Поведение пробного запуска
- Режим конструктора: выполняет проверки разрешимости SecretRef для измененных ссылок/поставщиков.
- Режим JSON (
--strict-json,--jsonили пакетный режим): выполняет проверку схемы и проверки разрешимости SecretRef. - Проверка политики также выполняется для известных неподдерживаемых целевых поверхностей SecretRef.
- Проверки политики оценивают полную конфигурацию после изменения, поэтому записи родительских объектов (например, установка
hooksкак объекта) не могут обойти проверку неподдерживаемых поверхностей. - Проверки exec SecretRef по умолчанию пропускаются во время пробного запуска, чтобы избежать побочных эффектов команд.
- Используйте
--allow-execвместе с--dry-run, чтобы явно включить проверки exec SecretRef (это может выполнить команды поставщика). --allow-execработает только для пробного запуска и выдает ошибку, если используется без--dry-run.
Поля --dry-run --json
Поля --dry-run --json
--dry-run --json выводит машиночитаемый отчет:ok: прошел ли пробный запускoperations: количество оцененных присваиванийchecks: выполнялись ли проверки схемы/разрешимостиchecks.resolvabilityComplete: были ли проверки разрешимости выполнены до конца (false, когда exec-ссылки пропущены)refsChecked: количество ссылок, фактически разрешенных во время пробного запускаskippedExecRefs: количество exec-ссылок, пропущенных из-за того, что--allow-execне был заданerrors: структурированные ошибки отсутствующего пути, схемы или разрешимости, когдаok=false
Форма вывода JSON
- Пример успеха
- Пример сбоя
Если пробный запуск завершается с ошибкой
Если пробный запуск завершается с ошибкой
config schema validation failed: форма конфигурации после изменения недействительна; исправьте путь/значение или форму объекта поставщика/ссылки.Config policy validation failed: unsupported SecretRef usage: верните эти учетные данные к вводу открытым текстом/строкой и используйте SecretRef только на поддерживаемых поверхностях.SecretRef assignment(s) could not be resolved: указанный поставщик/ссылка сейчас не может разрешиться (отсутствующая переменная окружения, недействительный указатель файла, сбой exec-поставщика или несоответствие поставщика/источника).Dry run note: skipped <n> exec SecretRef resolvability check(s): пробный запуск пропустил exec-ссылки; запустите повторно с--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.