Gateway CLI
يُعد Gateway خادم WebSocket الخاص بـ OpenClaw (القنوات، العُقد، الجلسات، الخطافات). الأوامر الفرعية في هذه الصفحة تقع تحتopenclaw gateway ….
مستندات ذات صلة:
تشغيل Gateway
تشغيل عملية Gateway محلية:- افتراضيًا، يرفض Gateway البدء ما لم يتم تعيين
gateway.mode=localفي~/.openclaw/openclaw.json. استخدم--allow-unconfiguredللتشغيل المؤقت/التطويري. - يتم حظر الربط خارج loopback دون مصادقة (حاجز أمان).
- يُطلق
SIGUSR1إعادة تشغيل داخل العملية عند التفويض (فعّلcommands.restartأو استخدم أداة/تهيئة gateway apply/update). - تُوقِف معالجات
SIGINT/SIGTERMعملية gateway، لكنها لا تستعيد أي حالة مخصّصة للطرفية. إذا لففت CLI بواجهة TUI أو إدخال بنمط raw، فأعِد الطرفية قبل الخروج.
الخيارات
--port <port>: منفذ WebSocket (القيمة الافتراضية تأتي من التهيئة/متغيرات البيئة؛ غالبًا18789).--bind <loopback|lan|tailnet|auto|custom>: وضع ربط المستمع.--auth <token|password>: تجاوز وضع المصادقة.--token <token>: تجاوز الرمز المميّز (ويعيّن أيضًاOPENCLAW_GATEWAY_TOKENللعملية).--password <password>: تجاوز كلمة المرور (ويعيّن أيضًاOPENCLAW_GATEWAY_PASSWORDللعملية).--tailscale <off|serve|funnel>: إتاحة Gateway عبر Tailscale.--tailscale-reset-on-exit: إعادة ضبط تهيئة Tailscale serve/funnel عند الإيقاف.--allow-unconfigured: السماح ببدء gateway دونgateway.mode=localفي التهيئة.--dev: إنشاء تهيئة تطوير + مساحة عمل إن لم تكن موجودة (يتجاوز BOOTSTRAP.md).--reset: إعادة ضبط تهيئة التطوير + بيانات الاعتماد + الجلسات + مساحة العمل (يتطلب--dev).--force: إنهاء أي مستمع موجود على المنفذ المحدد قبل البدء.--verbose: سجلات تفصيلية.--claude-cli-logs: عرض سجلات claude-cli فقط في وحدة التحكم (وتمكين stdout/stderr الخاصة به).--ws-log <auto|full|compact>: نمط سجل websocket (الافتراضيauto).--compact: اسم بديل لـ--ws-log compact.--raw-stream: تسجيل أحداث تدفق النموذج الخام إلى jsonl.--raw-stream-path <path>: مسار jsonl للتدفق الخام.
الاستعلام عن Gateway قيد التشغيل
تستخدم جميع أوامر الاستعلام WebSocket RPC. أوضاع الإخراج:- الافتراضي: قابل للقراءة البشرية (مُلوَّن في TTY).
--json: JSON قابل للقراءة الآلية (من دون تنسيق/مؤشر دوران).--no-color(أوNO_COLOR=1): تعطيل ANSI مع الحفاظ على التخطيط البشري.
--url <url>: عنوان URL لـ WebSocket الخاص بـ Gateway.--token <token>: رمز Gateway.--password <password>: كلمة مرور Gateway.--timeout <ms>: مهلة/ميزانية (تختلف حسب الأمر).--expect-final: الانتظار حتى استجابة «نهائية» (استدعاءات الوكيل).
--url، لا يعود CLI إلى التهيئة أو بيانات الاعتماد من البيئة.
مرِّر --token أو --password صراحةً. غياب بيانات اعتماد صريحة يُعد خطأً.
gateway health
gateway status
يعرض gateway status خدمة Gateway (launchd/systemd/schtasks) إضافةً إلى فحص RPC اختياري.
--url <url>: تجاوز عنوان URL للفحص.--token <token>: مصادقة الرمز المميّز للفحص.--password <password>: مصادقة كلمة المرور للفحص.--timeout <ms>: مهلة الفحص (الافتراضي10000).--no-probe: تخطي فحص RPC (عرض الخدمة فقط).--deep: فحص خدمات مستوى النظام أيضًا.
gateway probe
يُعد gateway probe أمر «تصحيح كل شيء». وهو يفحص دائمًا:
- gateway البعيد المُهيّأ لديك (إن كان مضبوطًا)، و
- localhost (loopback) حتى إذا كان البعيد مُهيّأ.
البعيد عبر SSH (تماثل تطبيق Mac)
يستخدم وضع تطبيق macOS «Remote over SSH» إعادة توجيه منفذ محلية بحيث يصبح gateway البعيد (الذي قد يكون مربوطًا على loopback فقط) متاحًا علىws://127.0.0.1:<port>.
المكافئ عبر CLI:
--ssh <target>: user@hostأوuser@host:port(المنفذ الافتراضي22).--ssh-identity <path>: ملف الهوية.--ssh-auto: اختيار أول مضيف Gateway مُكتشَف كهدف SSH (LAN/WAB فقط).
gateway.remote.sshTargetgateway.remote.sshIdentity
gateway call <method>
مساعد RPC منخفض المستوى.
إدارة خدمة Gateway
- يدعم
gateway install--port، --runtime، --token، --force، --json. - تقبل أوامر دورة الحياة
--jsonلأغراض البرمجة النصية.
اكتشاف البوابات (Bonjour)
يفحصgateway discover إشارات Gateway (_openclaw-gw._tcp).
- Multicast DNS-SD:
local. - Unicast DNS-SD (Wide-Area Bonjour): اختر نطاقًا (مثال:
openclaw.internal.) وأعِد إعداد Split DNS + خادم DNS؛ راجع /gateway/bonjour
role(تلميح دور gateway)transport(تلميح النقل، مثلgateway)gatewayPort(منفذ WebSocket، غالبًا18789)sshPort(منفذ SSH؛ الافتراضي22إذا لم يكن موجودًا)tailnetDns(اسم مضيف MagicDNS عند التوفر)gatewayTls/gatewayTlsSha256(تمكين TLS + بصمة الشهادة)cliPath(تلميح اختياري للتثبيتات البعيدة)
gateway discover
--timeout <ms>: مهلة لكل أمر (تصفّح/حل)؛ الافتراضي2000.--json: إخراج قابل للقراءة الآلية (ويعطّل أيضًا التنسيق/مؤشر الدوران).