CLI commands

التكوين

مساعدات الإعداد للتعديلات غير التفاعلية في OmeniaClaw.json: الحصول على القيم/تعيينها/تصحيحها/إلغاء تعيينها/الملف/المخطط/التحقق منها حسب المسار وطباعة ملف الإعداد النشط. شغّل الأمر بدون أمر فرعي لفتح معالج الإعداد (مثل OmeniaClaw configure).

خيارات الجذر

OmeniaClaw_DOCS_MARKER:paramOpen:IHBhdGg9Ii0tc2VjdGlvbiA8c2VjdGlvbg " type="string"> مرشح قسم الإعداد الموجّه القابل للتكرار عند تشغيل OmeniaClaw config بدون أمر فرعي.

الأقسام الموجّهة المدعومة: workspace، model، web، gateway، daemon، channels، plugins، skills، health.

أمثلة

bash
OmeniaClaw config fileOmeniaClaw config --section modelOmeniaClaw config --section gateway --section daemonOmeniaClaw config schemaOmeniaClaw config get browser.executablePathOmeniaClaw config set browser.executablePath "/usr/bin/google-chrome"OmeniaClaw config set browser.profiles.work.executablePath "/Applications/Google Chrome.app/Contents/MacOS/Google Chrome"OmeniaClaw config set agents.defaults.heartbeat.every "2h"OmeniaClaw config set agents.list[0].tools.exec.node "node-id-or-name"OmeniaClaw config set agents.defaults.models '{"openai/gpt-5.4":{}}' --strict-json --mergeOmeniaClaw config set channels.discord.token --ref-provider default --ref-source env --ref-id DISCORD_BOT_TOKENOmeniaClaw config set secrets.providers.vaultfile --provider-source file --provider-path /etc/OmeniaClaw/secrets.json --provider-mode jsonOmeniaClaw config patch --file ./OmeniaClaw.patch.json5 --dry-runOmeniaClaw config unset plugins.entries.brave.config.webSearch.apiKeyOmeniaClaw config set channels.discord.token --ref-provider default --ref-source env --ref-id DISCORD_BOT_TOKEN --dry-runOmeniaClaw config validateOmeniaClaw config validate --json

config schema

يطبع مخطط JSON المُولَّد لـ OmeniaClaw.json إلى stdout بصيغة JSON.

ما يتضمنه
  • مخطط إعداد الجذر الحالي، بالإضافة إلى حقل سلسلة جذرية $schema لأدوات التحرير.
  • بيانات تعريف الوثائق title وdescription للحقول المستخدمة في Control UI.
  • ترث عُقد الكائنات المتداخلة، وحرف البدل (*)، وعناصر المصفوفة ([]) بيانات تعريف title / description نفسها عند وجود توثيق حقل مطابق.
  • ترث فروع anyOf / oneOf / allOf بيانات تعريف الوثائق نفسها أيضاً عند وجود توثيق حقل مطابق.
  • بيانات تعريف مخطط Plugin والقناة المباشرة بأفضل جهد عند إمكانية تحميل بيانات manifest وقت التشغيل.
  • مخطط احتياطي نظيف حتى عندما يكون الإعداد الحالي غير صالح.
RPC وقت التشغيل المرتبط

يعيد config.schema.lookup مسار إعداد واحداً مطبّعاً مع عقدة مخطط سطحية (title، description، type، enum، const، والحدود الشائعة)، وبيانات تعريف تلميحات واجهة المستخدم المطابقة، وملخصات الأبناء المباشرين. استخدمه للتنقيب محدود المسار في Control UI أو العملاء المخصصين.

bash
OmeniaClaw config schema

مرّره إلى ملف عندما تريد فحصه أو التحقق منه باستخدام أدوات أخرى:

bash
OmeniaClaw config schema > OmeniaClaw.schema.json

المسارات

تستخدم المسارات ترميز النقاط أو الأقواس:

bash
OmeniaClaw config get agents.defaults.workspaceOmeniaClaw config get agents.list[0].id

استخدم فهرس قائمة الوكلاء لاستهداف وكيل محدد:

bash
OmeniaClaw config get agents.listOmeniaClaw config set agents.list[1].tools.exec.node "node-id-or-name"

القيم

تُحلَّل القيم كـ JSON5 عند الإمكان؛ وإلا فتُعامل كسلاسل نصية. استخدم --strict-json لاشتراط تحليل JSON5. يظل --json مدعوماً كاسم مستعار قديم.

bash
OmeniaClaw config set agents.defaults.heartbeat.every "0m"OmeniaClaw config set gateway.port 19001 --strict-jsonOmeniaClaw config set channels.whatsapp.groups '["*"]' --strict-json

يطبع config get <path> --json القيمة الخام بصيغة JSON بدلاً من نص منسق للطرفية.

استخدم --merge عند إضافة إدخالات إلى تلك الخرائط:

bash
OmeniaClaw config set agents.defaults.models '{"openai/gpt-5.4":{}}' --strict-json --mergeOmeniaClaw config set models.providers.ollama.models '[{"id":"llama3.2","name":"Llama 3.2"}]' --strict-json --merge

استخدم --replace فقط عندما تريد عمداً أن تصبح القيمة المقدمة هي القيمة الكاملة للهدف.

أوضاع config set

يدعم OmeniaClaw config set أربعة أنماط للإسناد:

وضع القيمة

bash
OmeniaClaw config set <path> <value>

وضع بناء SecretRef

bash
OmeniaClaw config set channels.discord.token \  --ref-provider default \  --ref-source env \  --ref-id DISCORD_BOT_TOKEN

وضع بناء المزوّد

يستهدف وضع بناء المزوّد مسارات secrets.providers.<alias> فقط:

bash
OmeniaClaw config set secrets.providers.vault \  --provider-source exec \  --provider-command /usr/local/bin/OmeniaClaw-vault \  --provider-arg read \  --provider-arg openai/api-key \  --provider-timeout-ms 5000

وضع الدُفعات

bash
OmeniaClaw config set --batch-json '[  {    "path": "secrets.providers.default",    "provider": { "source": "env" }  },  {    "path": "channels.discord.token",    "ref": { "source": "env", "provider": "default", "id": "DISCORD_BOT_TOKEN" }  }]'
bash
OmeniaClaw config set --batch-file ./config-set.batch.json --dry-run

يستخدم تحليل الدُفعات دائماً حمولة الدُفعة (--batch-json/--batch-file) كمصدر للحقيقة. لا يغيّر --strict-json / --json سلوك تحليل الدُفعات.

config patch

استخدم config patch عندما تريد لصق أو تمرير تصحيح بشكل إعداد بدلاً من تشغيل العديد من أوامر config set القائمة على المسارات. الإدخال كائن JSON5. تُدمج الكائنات تكرارياً، وتستبدل المصفوفات والقيم العددية القيمة الهدف، وتحذف null المسار الهدف.

bash
OmeniaClaw config patch --file ./OmeniaClaw.patch.json5 --dry-runOmeniaClaw config patch --file ./OmeniaClaw.patch.json5

يمكنك أيضاً تمرير تصحيح عبر stdin، وهذا مفيد لبرامج إعداد الخوادم البعيدة:

bash
ssh OmeniaClaw-host 'OmeniaClaw config patch --stdin --dry-run' < ./OmeniaClaw.patch.json5ssh OmeniaClaw-host 'OmeniaClaw config patch --stdin' < ./OmeniaClaw.patch.json5

مثال على تصحيح:

json5
{  channels: {    slack: {      enabled: true,      mode: "socket",      botToken: { source: "env", provider: "default", id: "SLACK_BOT_TOKEN" },      appToken: { source: "env", provider: "default", id: "SLACK_APP_TOKEN" },      groupPolicy: "open",      requireMention: false,    },    discord: {      enabled: true,      token: { source: "env", provider: "default", id: "DISCORD_BOT_TOKEN" },      dmPolicy: "disabled",      dm: { enabled: false },      groupPolicy: "allowlist",    },  },  agents: {    defaults: {      model: { primary: "openai/gpt-5.5" },      models: {        "openai/gpt-5.5": { params: { fastMode: true } },      },    },  },}

استخدم --replace-path <path> عندما يجب أن يصبح كائن أو مصفوفة واحد بالضبط القيمة المقدمة بدلاً من تصحيحه تكرارياً:

bash
OmeniaClaw config patch --file ./discord.patch.json5 --replace-path 'channels.discord.guilds["123"].channels'

يشغّل --dry-run فحوصات المخطط وقابلية حل SecretRef بدون كتابة. تُتخطى SecretRefs المدعومة بـ exec افتراضياً أثناء التشغيل التجريبي؛ أضف --allow-exec عندما تريد عمداً أن ينفّذ التشغيل التجريبي أوامر المزوّد.

يظل وضع مسار/قيمة JSON مدعوماً لكل من SecretRefs والمزوّدين:

bash
OmeniaClaw config set channels.discord.token \  '{"source":"env","provider":"default","id":"DISCORD_BOT_TOKEN"}' \  --strict-json OmeniaClaw config set secrets.providers.vaultfile \  '{"source":"file","path":"/etc/OmeniaClaw/secrets.json","mode":"json"}' \  --strict-json

أعلام بناء المزوّد

يجب أن تستخدم أهداف بناء المزوّد secrets.providers.<alias> كمسار.

الأعلام الشائعة
  • --provider-source <env|file|exec>
  • --provider-timeout-ms <ms> (file, exec)
مزوّد Env (--provider-source env)
  • --provider-allowlist &lt;ENV_VAR&gt; (قابل للتكرار)
مزوّد File (--provider-source file)
  • --provider-path <path> (مطلوب)
  • --provider-mode <singleValue|json>
  • --provider-max-bytes <bytes>
  • --provider-allow-insecure-path
مزوّد 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 &lt;KEY=VALUE&gt; (قابل للتكرار)
  • --provider-pass-env &lt;ENV_VAR&gt; (قابل للتكرار)
  • --provider-trusted-dir <path> (قابل للتكرار)
  • --provider-allow-insecure-path
  • --provider-allow-symlink-command

مثال على مزوّد exec مقوّى:

bash
OmeniaClaw config set secrets.providers.vault \  --provider-source exec \  --provider-command /usr/local/bin/OmeniaClaw-vault \  --provider-arg read \  --provider-arg openai/api-key \  --provider-json-only \  --provider-pass-env VAULT_TOKEN \  --provider-trusted-dir /usr/local/bin \  --provider-timeout-ms 5000

التشغيل التجريبي

استخدم --dry-run للتحقق من التغييرات بدون كتابة OmeniaClaw.json.

bash
OmeniaClaw config set channels.discord.token \  --ref-provider default \  --ref-source env \  --ref-id DISCORD_BOT_TOKEN \  --dry-run OmeniaClaw config set channels.discord.token \  --ref-provider default \  --ref-source env \  --ref-id DISCORD_BOT_TOKEN \  --dry-run \  --json OmeniaClaw config set channels.discord.token \  --ref-provider vault \  --ref-source exec \  --ref-id discord/token \  --dry-run \  --allow-exec
سلوك التشغيل التجريبي
  • وضع البناء: يشغّل فحوصات قابلية حل SecretRef للمراجع/المزوّدين المتغيرين.
  • وضع JSON (--strict-json، --json، أو وضع الدُفعات): يشغّل التحقق من المخطط بالإضافة إلى فحوصات قابلية حل SecretRef.
  • يعمل التحقق من السياسة أيضاً للأسطح الهدف المعروفة غير المدعومة لـ SecretRef.
  • تقيّم فحوصات السياسة الإعداد الكامل بعد التغيير، لذلك لا يمكن لكتابات الكائن الأب (مثل تعيين hooks ككائن) تجاوز التحقق من الأسطح غير المدعومة.
  • تُتخطى فحوصات SecretRef من نوع Exec افتراضياً أثناء التشغيل التجريبي لتجنب الآثار الجانبية للأوامر.
  • استخدم --allow-exec مع --dry-run للاشتراك في فحوصات SecretRef من نوع exec (قد ينفّذ هذا أوامر المزوّد).
  • --allow-exec مخصص للتشغيل التجريبي فقط ويُنتج خطأ إذا استُخدم بدون --dry-run.
حقول --dry-run --json

يطبع --dry-run --json تقريراً قابلاً للقراءة آلياً:

  • ok: ما إذا كان التشغيل التجريبي قد نجح
  • operations: عدد التعيينات التي تم تقييمها
  • checks: ما إذا كانت فحوصات المخطط/إمكانية الحل قد شُغّلت
  • checks.resolvabilityComplete: ما إذا كانت فحوصات إمكانية الحل قد اكتملت (تكون false عند تخطي مراجع exec)
  • refsChecked: عدد المراجع التي حُلّت فعليًا أثناء التشغيل التجريبي
  • skippedExecRefs: عدد مراجع exec التي تم تخطيها لأن --allow-exec لم يكن مضبوطًا
  • errors: إخفاقات منظمة في المخطط/إمكانية الحل عندما تكون ok=false

شكل مخرجات JSON

json5
{  ok: boolean,  operations: number,  configPath: string,  inputModes: ["value" | "json" | "builder", ...],  checks: {    schema: boolean,    resolvability: boolean,    resolvabilityComplete: boolean,  },  refsChecked: number,  skippedExecRefs: number,  errors?: [    {      kind: "schema" | "resolvability",      message: string,      ref?: string, // present for resolvability errors    },  ],}

Success example

json
{  "ok": true,  "operations": 1,  "configPath": "~/.OmeniaClaw/OmeniaClaw.json",  "inputModes": ["builder"],  "checks": {    "schema": false,    "resolvability": true,    "resolvabilityComplete": true  },  "refsChecked": 1,  "skippedExecRefs": 0}

Failure example

json
{  "ok": false,  "operations": 1,  "configPath": "~/.OmeniaClaw/OmeniaClaw.json",  "inputModes": ["builder"],  "checks": {    "schema": false,    "resolvability": true,    "resolvabilityComplete": true  },  "refsChecked": 1,  "skippedExecRefs": 0,  "errors": [    {      "kind": "resolvability",      "message": "Error: Environment variable \"MISSING_TEST_SECRET\" is not set.",      "ref": "env:default:MISSING_TEST_SECRET"    }  ]}
If dry-run fails
  • 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): تخطى التشغيل التجريبي مراجع exec؛ أعد التشغيل باستخدام --allow-exec إذا كنت تحتاج إلى التحقق من إمكانية حل exec.
  • في وضع الدُفعات، أصلح الإدخالات الفاشلة وأعد تشغيل --dry-run قبل الكتابة.

أمان الكتابة

يتحقق OmeniaClaw config set وغيره من كتّاب الإعدادات المملوكين لـ OmeniaClaw من الإعدادات الكاملة بعد التغيير قبل تثبيتها على القرص. إذا فشل الحمولة الجديدة في تحقق المخطط أو بدت كاستبدال تدميري، تُترك الإعدادات النشطة كما هي وتُحفظ الحمولة المرفوضة بجانبها باسم OmeniaClaw.json.rejected.*.

فضّل الكتابة عبر CLI للتعديلات الصغيرة:

bash
OmeniaClaw config set gateway.reload.mode hybrid --dry-runOmeniaClaw config set gateway.reload.mode hybridOmeniaClaw config validate

إذا رُفضت كتابة، افحص الحمولة المحفوظة وأصلح شكل الإعدادات الكامل:

bash
CONFIG="$(OmeniaClaw config file)"ls -lt "$CONFIG".rejected.* 2>/dev/null | headOmeniaClaw config validate

ما تزال الكتابة المباشرة بالمحرر مسموحة، لكن Gateway الجاري يعاملها كغير موثوقة حتى تنجح في التحقق. تؤدي التعديلات المباشرة غير الصالحة إلى فشل بدء التشغيل أو يتم تخطيها بواسطة إعادة التحميل الساخنة؛ لا يعيد Gateway كتابة OmeniaClaw.json. شغّل OmeniaClaw doctor --fix لإصلاح الإعدادات ذات البادئات/المستبدلة أو لاستعادة آخر نسخة سليمة معروفة. راجع استكشاف أخطاء Gateway وإصلاحها.

استرداد الملف الكامل مخصص لإصلاح doctor. تبقى تغييرات مخطط Plugin أو انحراف minHostVersion واضحة بدلًا من التراجع عن إعدادات المستخدم غير المرتبطة مثل النماذج، والمزودين، وملفات تعريف المصادقة، والقنوات، وتعريض Gateway، والأدوات، والذاكرة، والمتصفح، أو إعدادات cron.

الأوامر الفرعية

  • config file: اطبع مسار ملف الإعدادات النشط (المحلول من OmeniaClaw_CONFIG_PATH أو الموقع الافتراضي). ينبغي أن يحدد المسار ملفًا عاديًا، لا رابطًا رمزيًا.

أعد تشغيل Gateway بعد التعديلات.

التحقق

تحقق من الإعدادات الحالية مقابل المخطط النشط دون بدء Gateway.

bash
OmeniaClaw config validateOmeniaClaw config validate --json

بعد نجاح OmeniaClaw config validate، يمكنك استخدام TUI المحلي لجعل وكيل مضمّن يقارن الإعدادات النشطة بالوثائق أثناء تحققك من كل تغيير من الطرفية نفسها:

bash
OmeniaClaw chat

ثم داخل TUI:

text
!OmeniaClaw config file!OmeniaClaw docs gateway auth token secretref!OmeniaClaw config validate!OmeniaClaw doctor

حلقة الإصلاح المعتادة:

  • Compare with docs

    اطلب من الوكيل مقارنة إعداداتك الحالية بصفحة الوثائق ذات الصلة واقتراح أصغر إصلاح.

  • Apply targeted edits

    طبّق تعديلات مستهدفة باستخدام OmeniaClaw config set أو OmeniaClaw configure.

  • Re-validate

    أعد تشغيل OmeniaClaw config validate بعد كل تغيير.

  • Doctor for runtime issues

    إذا نجح التحقق لكن وقت التشغيل ما يزال غير سليم، فشغّل OmeniaClaw doctor أو OmeniaClaw doctor --fix للحصول على مساعدة في الترحيل والإصلاح.

  • ذات صلة

    Was this useful?
    On this page

    On this page