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. - ترث عقد الكائنات المتداخلة وحرف البدل (
*) وعناصر المصفوفة ([]) بيانات تعريفtitle/descriptionنفسها عند وجود توثيق مطابق للحقل. - ترث فروع
anyOf/oneOf/allOfبيانات التعريف التوثيقية نفسها أيضا عند وجود توثيق مطابق للحقل. - بيانات تعريف مخطط Plugin + قناة مباشرة بأفضل جهد عندما يمكن تحميل بيانات manifest وقت التشغيل.
- مخطط احتياطي نظيف حتى عندما تكون الإعدادات الحالية غير صالحة.
RPC وقت التشغيل ذي الصلة
RPC وقت التشغيل ذي الصلة
يعيد
config.schema.lookup مسار إعدادات واحدا مطبّعا مع عقدة مخطط سطحية (title وdescription وtype وenum وconst والحدود الشائعة)، وبيانات تعريف تلميح واجهة مستخدم مطابقة، وملخصات الأبناء المباشرين. استخدمه للتنقل التفصيلي محدود المسار في Control UI أو العملاء المخصصين.المسارات
تستخدم المسارات ترميز النقاط أو الأقواس. ضع مسارات ترميز الأقواس بين علامات اقتباس في أمثلة shell حتى لا توسع shells مثل zsh القيمة[0] كنمط glob قبل أن يتلقى OpenClaw المسار:
القيم
تُحلل القيم كـ JSON5 عندما يكون ذلك ممكنا؛ وإلا فتُعامل كسلاسل. استخدم--strict-json لطلب تحليل JSON قياسي دون رجوع إلى السلاسل. يظل --json مدعوما كاسم بديل قديم لـ --strict-json.
--strict-json، تُرفض صياغة JSON5 فقط مثل التعليقات أو الفواصل اللاحقة أو مفاتيح الكائنات غير المقتبسة. احذف --strict-json لتحليل قيم JSON5 مع الرجوع إلى السلسلة الخام.
يطبع config get <path> --json القيمة الخام بصيغة JSON بدلا من نص منسق للطرفية.
يستبدل إسناد الكائن المسار الهدف افتراضيا. ترفض مسارات الخرائط/القوائم المحمية التي تحتفظ عادة بمدخلات يضيفها المستخدم، مثل
agents.defaults.models وmodels.providers وmodels.providers.<id>.models وplugins.entries وauth.profiles، عمليات الاستبدال التي قد تزيل مدخلات موجودة ما لم تمرر --replace.--merge عند إضافة مدخلات إلى تلك الخرائط:
--replace فقط عندما تريد عمدا أن تصبح القيمة المقدمة هي القيمة الهدف الكاملة.
أوضاع config set
يدعم openclaw config set أربعة أنماط إسناد:
- وضع القيمة
- وضع منشئ SecretRef
- وضع منشئ المزوّد
- وضع الدُفعات
--batch-json/--batch-file) كمصدر الحقيقة. لا يغير --strict-json / --json سلوك تحليل الدُفعات.
config patch
استخدم config patch عندما تريد لصق أو تمرير تصحيح له شكل الإعدادات بدلا من تشغيل العديد من أوامر config set المعتمدة على المسارات. يكون الإدخال كائن JSON5. تُدمج الكائنات تكراريا، وتستبدل المصفوفات والقيم القياسية القيمة الهدف، وتحذف null المسار الهدف.
--replace-path <path> عندما يجب أن يصبح كائن أو مصفوفة واحدة القيمة المقدمة بالضبط بدلا من تصحيحها تكراريا:
--dry-run فحوصات المخطط وقابلية حل SecretRef دون كتابة. تُتخطى SecretRefs المدعومة بـ exec افتراضيا أثناء التشغيل التجريبي؛ أضف --allow-exec عندما تريد عمدا أن ينفذ التشغيل التجريبي أوامر المزوّد.
يبقى وضع مسار/قيمة 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>(قابل للتكرار)
مزوّد الملفات (--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: انقل بيانات الاعتماد هذه مرة أخرى إلى إدخال نص عادي/سلسلة نصية، وأبقِ SecretRefs على الأسطح المدعومة فقط.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 حارس التهيئة غير الصالحة.المقارنة مع الوثائق
اطلب من الوكيل مقارنة التهيئة الحالية لديك بصفحة الوثائق ذات الصلة واقتراح أصغر إصلاح.