Documentation Index

Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

​

openclaw onboard

​

الأدلة ذات الصلة

​

أمثلة

openclaw onboard
openclaw onboard --modern
openclaw onboard --flow quickstart
openclaw onboard --flow manual
openclaw onboard --flow import
openclaw onboard --import-from hermes --import-source ~/.hermes
openclaw onboard --skip-bootstrap
openclaw onboard --mode remote --remote-url wss://gateway-host:18789

openclaw onboard --non-interactive \
  --auth-choice custom-api-key \
  --custom-base-url "https://llm.example.com/v1" \
  --custom-model-id "foo-large" \
  --custom-api-key "$CUSTOM_API_KEY" \
  --secret-input-mode plaintext \
  --custom-compatibility openai \
  --custom-image-input

openclaw onboard --non-interactive \
  --auth-choice lmstudio \
  --custom-base-url "http://localhost:1234/v1" \
  --custom-model-id "qwen/qwen3.5-9b" \
  --lmstudio-api-key "$LM_API_TOKEN" \
  --accept-risk

openclaw onboard --non-interactive \
  --auth-choice ollama \
  --custom-base-url "http://ollama-host:11434" \
  --custom-model-id "qwen3.5:27b" \
  --accept-risk

openclaw onboard --non-interactive \
  --auth-choice openai-api-key \
  --secret-input-mode ref \
  --accept-risk

• عيّن متغير بيئة الموفر في بيئة عملية الإعداد (على سبيل المثال OPENAI_API_KEY).
• لا تمرر أعلام مفاتيح مضمنة (على سبيل المثال --openai-api-key) إلا إذا كان متغير البيئة ذلك معيّنًا أيضًا.
• إذا مُرر علم مفتاح مضمن من دون متغير البيئة المطلوب، يفشل الإعداد بسرعة مع إرشادات.

• يخزّن --gateway-auth token --gateway-token <token> رمزًا بنص عادي.
• يخزّن --gateway-auth token --gateway-token-ref-env <name> قيمة gateway.auth.token كـ SecretRef للبيئة.
• --gateway-token و--gateway-token-ref-env متنافيان.
• يتطلب --gateway-token-ref-env متغير بيئة غير فارغ في بيئة عملية الإعداد.
• مع --install-daemon، عندما تتطلب مصادقة الرمز رمزًا، تُتحقق رموز Gateway المُدارة بـ SecretRef ولكن لا تُحفظ كنص عادي محلول في بيانات تعريف بيئة خدمة المشرف.
• مع --install-daemon، إذا كان وضع الرمز يتطلب رمزًا وكان SecretRef المهيأ للرمز غير محلول، يفشل الإعداد مغلقًا مع إرشادات معالجة.
• مع --install-daemon، إذا كان كل من gateway.auth.token وgateway.auth.password مهيأين وكان gateway.auth.mode غير معيّن، يمنع الإعداد التثبيت حتى يُعيّن الوضع صراحة.
• يكتب الإعداد المحلي gateway.mode="local" في التهيئة. إذا كان ملف تهيئة لاحق يفتقد gateway.mode، فتعامل مع ذلك كتلف في التهيئة أو تعديل يدوي غير مكتمل، وليس كاختصار صالح للوضع المحلي.
• يثبّت الإعداد المحلي Plugins القابلة للتنزيل المحددة عندما يتطلبها مسار الإعداد المختار.
• يكتب الإعداد البعيد معلومات الاتصال فقط لـ Gateway البعيد ولا يثبّت حزم plugin محلية.
• --allow-unconfigured هو فتحة هروب منفصلة لوقت تشغيل Gateway. لا يعني أن الإعداد يجوز له حذف gateway.mode.

export OPENCLAW_GATEWAY_TOKEN="your-token"
openclaw onboard --non-interactive \
  --mode local \
  --auth-choice skip \
  --gateway-auth token \
  --gateway-token-ref-env OPENCLAW_GATEWAY_TOKEN \
  --accept-risk

• ما لم تمرر --skip-health، ينتظر الإعداد Gateway محليًا يمكن الوصول إليه قبل أن يخرج بنجاح.
• يبدأ --install-daemon مسار تثبيت Gateway المُدار أولًا. من دونه، يجب أن يكون لديك Gateway محلي قيد التشغيل مسبقًا، على سبيل المثال openclaw gateway run.
• إذا كنت تريد فقط كتابة التهيئة/مساحة العمل/bootstrap في الأتمتة، فاستخدم --skip-health.
• إذا كنت تدير ملفات مساحة العمل بنفسك، فمرّر --skip-bootstrap لتعيين agents.defaults.skipBootstrap: true وتخطي إنشاء AGENTS.md وSOUL.md وTOOLS.md وIDENTITY.md وUSER.md وHEARTBEAT.md وBOOTSTRAP.md.
• على Windows الأصلي، يحاول --install-daemon استخدام Scheduled Tasks أولًا ثم يتراجع إلى عنصر تسجيل دخول في مجلد Startup لكل مستخدم إذا رُفض إنشاء المهمة.

• اختر استخدام مرجع سر عند مطالبتك.
• ثم اختر أحد الخيارين:
  • متغير بيئة
  • موفر أسرار مهيأ (file أو exec)
• يجري الإعداد تحققًا أوليًا سريعًا قبل حفظ المرجع.
  • إذا فشل التحقق، يعرض الإعداد الخطأ ويتيح لك إعادة المحاولة.

​

اختيارات نقطة نهاية Z.AI غير التفاعلية

# Promptless endpoint selection
openclaw onboard --non-interactive \
  --auth-choice zai-coding-global \
  --zai-api-key "$ZAI_API_KEY"

# Other Z.AI endpoint choices:
# --auth-choice zai-coding-cn
# --auth-choice zai-global
# --auth-choice zai-cn

openclaw onboard --non-interactive \
  --auth-choice mistral-api-key \
  --mistral-api-key "$MISTRAL_API_KEY"

​

ملاحظات التدفق

​

أوامر متابعة شائعة

openclaw channels add
openclaw configure
openclaw agents add <name>