OpenClawDocs
View as MarkdownView this page as plain textOpen in ChatGPTAsk questions about this pageOpen in ClaudeAsk questions about this page

CLI commands

Gateway

Gateway, OpenClaw का WebSocket सर्वर है (चैनल, नोड, सत्र, हुक)। नीचे दिए गए सभी उपकमांड openclaw gateway ... के अंतर्गत उपलब्ध हैं।

Bonjour खोज

स्थानीय mDNS + वाइड-एरिया DNS-SD सेटअप।
खोज का अवलोकन

OpenClaw किस प्रकार Gateway का विज्ञापन करता है और उन्हें खोजता है।
कॉन्फ़िगरेशन

शीर्ष-स्तरीय Gateway कॉन्फ़िगरेशन कुंजियाँ।

Gateway चलाएँ

bash
openclaw gatewayopenclaw gateway run   # समतुल्य, स्पष्ट रूप
स्टार्टअप व्यवहार
  • जब तक ~/.openclaw/openclaw.json में gateway.mode=local सेट न हो, यह शुरू होने से इनकार करता है। तदर्थ/डेवलपमेंट रन के लिए --allow-unconfigured का उपयोग करें; यह कॉन्फ़िगरेशन लिखे या सुधार किए बिना सुरक्षा जाँच को बायपास करता है।
  • जब स्टार्टअप को सुधार योग्य अमान्य कॉन्फ़िगरेशन मिलता है, तो इंटरैक्टिव टर्मिनल openclaw doctor --fix चलाने का प्रस्ताव देता है और सहमति मिलने के बाद एक बार फिर स्टार्टअप का प्रयास करता है। गैर-इंटरैक्टिव रन कभी भी स्वतः सुधार नहीं करते; इसके बजाय वे कमांड प्रिंट करते हैं। यदि सुधारा गया कॉन्फ़िगरेशन फिर भी अमान्य है, तो स्टार्टअप रुका रहता है।
  • openclaw onboard --mode local और openclaw setup, gateway.mode=local लिखते हैं। यदि कॉन्फ़िगरेशन फ़ाइल मौजूद है, लेकिन gateway.mode अनुपस्थित है, तो इसे क्षतिग्रस्त/अधिलेखित कॉन्फ़िगरेशन माना जाता है और Gateway आपके लिए local का अनुमान लगाने से इनकार करता है — ऑनबोर्डिंग फिर से चलाएँ, कुंजी मैन्युअल रूप से सेट करें, या --allow-unconfigured पास करें।
  • प्रमाणीकरण के बिना लूपबैक से आगे बाइंड करना अवरुद्ध है।
  • --bind के मान lan, tailnet, और custom वर्तमान में केवल IPv4 पथों पर रिज़ॉल्व होते हैं; केवल IPv6 वाले अपने-होस्ट सेटअप के लिए Gateway के आगे IPv4 साइडकार या प्रॉक्सी आवश्यक है।
  • अधिकृत होने पर SIGUSR1 प्रक्रिया के भीतर पुनरारंभ ट्रिगर करता है। commands.restart (डिफ़ॉल्ट: सक्षम) बाहर से भेजे गए SIGUSR1 को नियंत्रित करता है; मैन्युअल OS-सिग्नल पुनरारंभ अवरुद्ध करने के लिए इसे false पर सेट करें। एजेंट-सुलभ gateway टूल केवल-पढ़ने योग्य है; एजेंट मानव-अनुमोदित openclaw डेलिगेशन टूल के माध्यम से पुनरारंभ का अनुरोध करते हैं।
  • SIGINT/SIGTERM प्रक्रिया रोकते हैं, लेकिन कस्टम टर्मिनल स्थिति बहाल नहीं करते — यदि आप CLI को TUI या रॉ-मोड इनपुट में रैप करते हैं, तो बाहर निकलने से पहले टर्मिनल स्वयं बहाल करें।

विकल्प

OPENCLAW_DOCS_MARKER:paramOpen:IHBhdGg9Ii0tcG9ydCA8cG9ydA " type="number"> WebSocket पोर्ट (कॉन्फ़िगरेशन/एनवायरनमेंट से डिफ़ॉल्ट; सामान्यतः 18789)।

OPENCLAW_DOCS_MARKER:paramOpen:IHBhdGg9Ii0tYmluZCA8bW9kZQ " type="string"> बाइंड मोड: loopback (डिफ़ॉल्ट), lan, tailnet, auto, custom।

OPENCLAW_DOCS_MARKER:paramOpen:IHBhdGg9Ii0tdG9rZW4gPHRva2Vu " type="string"> connect.params.auth.token के लिए साझा टोकन। सेट होने पर डिफ़ॉल्ट रूप से OPENCLAW_GATEWAY_TOKEN।

OPENCLAW_DOCS_MARKER:paramOpen:IHBhdGg9Ii0tYXV0aCA8bW9kZQ " type="string"> प्रमाणीकरण मोड: none, token, password, trusted-proxy।

OPENCLAW_DOCS_MARKER:paramOpen:IHBhdGg9Ii0tcGFzc3dvcmQgPHBhc3N3b3Jk " type="string"> --auth password के लिए पासवर्ड।

OPENCLAW_DOCS_MARKER:paramOpen:IHBhdGg9Ii0tdGFpbHNjYWxlIDxtb2Rl " type="string"> Tailscale एक्सपोज़र: off, serve, funnel।

--tailscale-reset-on-exitboolean

शटडाउन पर Tailscale serve/funnel कॉन्फ़िगरेशन रीसेट करें।

--allow-unconfiguredboolean

gateway.mode=local लागू किए बिना शुरू करें। केवल तदर्थ/डेवलपमेंट बूटस्ट्रैप; कॉन्फ़िगरेशन को स्थायी या सुधारित नहीं करता।

--devboolean

अनुपस्थित होने पर डेवलपमेंट कॉन्फ़िगरेशन + कार्यक्षेत्र बनाएँ (BOOTSTRAP.md छोड़ देता है)।

--dev-ambient-channelsboolean

डेवलपमेंट Gateway को परिवेशी एनवायरनमेंट वेरिएबल से चैनल स्वतः कॉन्फ़िगर करने दें। --dev आवश्यक है।

--resetboolean

डेवलपमेंट कॉन्फ़िगरेशन, क्रेडेंशियल, सत्र और कार्यक्षेत्र रीसेट करें। --dev आवश्यक है।

--forceboolean

शुरू करने से पहले लक्ष्य पोर्ट पर किसी भी मौजूदा लिसनर को समाप्त करें। गैर-इंटरैक्टिव शेल में यह सत्यापित Gateway लिसनर को समाप्त करने से इनकार करता है; इसके बजाय --dev या खाली पोर्ट वाले पृथक --profile का उपयोग करें।

--verboseboolean

stdout/stderr पर विस्तृत लॉगिंग।

--cli-backend-logsboolean

कंसोल में केवल CLI बैकएंड लॉग दिखाएँ (stdout/stderr भी सक्षम करता है)।

OPENCLAW_DOCS_MARKER:paramOpen:IHBhdGg9Ii0td3MtbG9nIDxzdHlsZQ " type="string" default="auto"> WebSocket लॉग शैली: auto, full, compact।

--compactboolean

--ws-log compact का उपनाम।

--raw-streamboolean

रॉ मॉडल स्ट्रीम इवेंट को JSONL में लॉग करें।

--claude-cli-logs, --cli-backend-logs का अप्रचलित उपनाम है।

--bind custom के लिए gateway.customBindHost को IPv4 पते पर सेट करें। 127.0.0.1 या 0.0.0.0 के अलावा किसी भी पते के लिए समान-होस्ट क्लाइंट हेतु उसी पोर्ट पर 127.0.0.1 भी आवश्यक है; यदि कोई भी लिसनर बाइंड नहीं कर पाता, तो स्टार्टअप विफल हो जाता है। वाइल्डकार्ड 0.0.0.0 कोई अलग आवश्यक उपनाम नहीं जोड़ता। केवल IPv6 वाले अपने-होस्ट सेटअप के लिए Gateway के आगे IPv4 साइडकार या प्रॉक्सी आवश्यक है।

Gateway पुनरारंभ करें

bash
openclaw gateway restartopenclaw gateway restart --safeopenclaw gateway restart --safe --skip-deferralopenclaw gateway restart --forceopenclaw gateway restart --wait 30s

--safe चालू Gateway से सक्रिय कार्य की पूर्व-जाँच करने और उस कार्य के समाप्त होने के बाद एक समेकित पुनरारंभ शेड्यूल करने को कहता है। प्रतीक्षा 5 मिनट तक सीमित है; समय-सीमा समाप्त होने पर पुनरारंभ बाध्य किया जाता है। --safe को --force या --wait के साथ संयोजित नहीं किया जा सकता।

--skip-deferral सुरक्षित पुनरारंभ पर सक्रिय-कार्य स्थगन गेट को बायपास करता है, इसलिए रिपोर्ट किए गए अवरोधकों के बावजूद Gateway तुरंत पुनरारंभ होता है। इसके लिए --safe आवश्यक है — इसका उपयोग तब करें जब स्थगन किसी अनियंत्रित कार्य पर अटक गया हो।

--wait <duration> साधारण (गैर-सुरक्षित) पुनरारंभ के लिए ड्रेन समय-सीमा को ओवरराइड करता है। बिना इकाई वाले मिलीसेकंड या इकाई प्रत्यय ms, s, m, h, d स्वीकार करता है (जैसे 30s, 5m, 1h30m); --wait 0 अनिश्चितकाल तक प्रतीक्षा करता है। --force या --safe के साथ संगत नहीं है।

--force सक्रिय-कार्य ड्रेन छोड़ देता है और तुरंत पुनरारंभ करता है। साधारण restart (कोई फ़्लैग नहीं) मौजूदा सेवा-प्रबंधक पुनरारंभ व्यवहार बनाए रखता है।

बाहरी सुपरवाइज़र

OPENCLAW_SUPERVISOR_MODE=external केवल तभी सेट करें जब कोई अन्य प्रक्रिया प्रबंधक Gateway के जीवनचक्र का स्वामी हो। इस मोड में:

  • openclaw gateway restart launchd, systemd या Task Scheduler के बजाय सत्यापित चालू Gateway को लक्षित करते हुए मौजूदा सुरक्षित, बाध्य और सीमित-प्रतीक्षा व्यवहार बनाए रखता है।
  • बाहरी सुपरवाइज़र का उपयोग करने के निर्देश के साथ नेटिव सेवा इंस्टॉल, प्रारंभ, रोकने और अनइंस्टॉल करने की कार्रवाइयाँ अस्वीकार कर दी जाती हैं।
  • OpenClaw का स्वयं-अपडेट अस्वीकार कर दिया जाता है, ताकि सुपरवाइज़र Gateway को रोक सके, रनटाइम को बदलकर अंतिम रूप दे सके और उसे सुरक्षित रूप से पुनरारंभ कर सके।
  • नई प्रक्रिया वाला पुनरारंभ स्वच्छ रूप से बाहर निकलने से पहले SQLite में सीमित हैंडऑफ़ लिखता है। यदि स्थायित्व विफल होता है, तो उपभोग योग्य हैंडऑफ़ के बिना बाहर निकलने के बजाय Gateway प्रक्रिया के भीतर पुनरारंभ पर वापस जाता है।

OPENCLAW_SERVICE_REPAIR_POLICY=external एक अलग Doctor सुधार नीति बनी रहती है। यह रनटाइम स्वामित्व घोषित नहीं करती; जिन सुपरवाइज़र को दोनों व्यवहार चाहिए, उन्हें दोनों वेरिएबल सेट करने चाहिए।

बाहरी सुपरवाइज़र छिपे हुए मशीन अनुबंध के माध्यम से पुनरारंभ हैंडऑफ़ पर सहमति बना सकते हैं और उसका उपभोग कर सकते हैं:

bash
openclaw gateway restart-handoff capabilities --jsonopenclaw gateway restart-handoff consume --expected-pid <pid> --json

प्रोटोकॉल संस्करण 1, consume ऑपरेशन का समर्थन करता है। उपभोग एक तत्काल SQLite ट्रांज़ैक्शन में अपेक्षित PID और सीमित हैंडऑफ़ फ़ील्ड सत्यापित करता है। सफलता लौटाने से पहले स्वीकृत हैंडऑफ़ हटा दिया जाता है, इसलिए समवर्ती या पुनः चलाए गए उपभोक्ता दोनों इसे स्वीकार नहीं कर सकते। PID असंगति को मेल खाने वाले स्वामी के लिए रखा जाता है; अनुपस्थित, समय-सीमा समाप्त और अमान्य पंक्तियाँ पुनरारंभ अधिकृत नहीं करतीं।

मान्य मशीन अनुरोध एग्ज़िट कोड 0 के साथ JSON लौटाते हैं, जिसमें गैर-पुनरारंभ परिणाम भी शामिल हैं। अमान्य आर्ग्युमेंट एग्ज़िट कोड 2 के साथ reason: "invalid-expected-pid" लौटाते हैं; स्टेट-स्टोर विफलताएँ एग्ज़िट कोड 1 के साथ reason: "store-unavailable" लौटाती हैं। सुपरवाइज़र को OpenClaw संस्करण स्ट्रिंग से समर्थन का अनुमान लगाने या निजी SQLite स्कीमा सीधे पढ़ने के बजाय, उपयोग किए जाने वाले सटीक रनटाइम या लॉन्चर पर capabilities की जाँच करनी चाहिए।

Gateway प्रोफ़ाइलिंग

  • OPENCLAW_GATEWAY_STARTUP_TRACE=1 स्टार्टअप के दौरान चरण समय लॉग करता है, जिसमें प्रत्येक चरण की eventLoopMax देरी और Plugin लुकअप-टेबल समय (इंस्टॉल किया गया इंडेक्स, मैनिफ़ेस्ट रजिस्ट्री, स्टार्टअप योजना, स्वामी-मैप कार्य) शामिल हैं।
  • OPENCLAW_GATEWAY_RESTART_TRACE=1 पुनरारंभ-स्कोप वाली restart trace: पंक्तियाँ लॉग करता है: सिग्नल प्रबंधन, सक्रिय-कार्य ड्रेन, शटडाउन चरण, अगला प्रारंभ, तैयार होने का समय और मेमोरी मेट्रिक्स।
  • OPENCLAW_DIAGNOSTICS=timeline, OPENCLAW_DIAGNOSTICS_TIMELINE_PATH=<path> के साथ बाहरी QA हार्नेस के लिए सर्वोत्तम-प्रयास वाली JSONL स्टार्टअप निदान टाइमलाइन लिखता है (कॉन्फ़िगरेशन diagnostics.flags: ["timeline"] के समतुल्य; पथ अब भी केवल एनवायरनमेंट से सेट होता है)। इवेंट-लूप नमूने शामिल करने के लिए OPENCLAW_DIAGNOSTICS_EVENT_LOOP=1 जोड़ें।
  • pnpm build और फिर pnpm test:startup:gateway -- --runs 5 --warmup 1, निर्मित CLI एंट्री के सापेक्ष Gateway स्टार्टअप का बेंचमार्क करते हैं: प्रथम प्रक्रिया आउटपुट, /healthz, /readyz, स्टार्टअप ट्रेस समय, इवेंट-लूप देरी और Plugin लुकअप-टेबल समय।
  • pnpm build और फिर pnpm test:restart:gateway -- --case skipChannels --runs 1 --restarts 5, macOS या Linux पर प्रक्रिया के भीतर पुनरारंभ का बेंचमार्क करते हैं (Windows पर समर्थित नहीं; पुनरारंभ के लिए SIGUSR1 आवश्यक है)। यह SIGUSR1 का उपयोग करता है, चाइल्ड प्रक्रिया में दोनों ट्रेस सक्षम करता है और अगला /healthz, अगला /readyz, डाउनटाइम, तैयार होने का समय, CPU, RSS और पुनरारंभ ट्रेस मेट्रिक्स रिकॉर्ड करता है।
  • /healthz जीवित होने का संकेत है; /readyz उपयोग योग्य तत्परता है। ट्रेस पंक्तियों और बेंचमार्क आउटपुट को स्वामी-अभिज्ञान संकेत मानें, न कि किसी एक अवधि या नमूने से निकला संपूर्ण प्रदर्शन निष्कर्ष।

चल रहे Gateway से क्वेरी करें

सभी क्वेरी कमांड WebSocket RPC का उपयोग करते हैं।

आउटपुट मोड

  • डिफ़ॉल्ट: मानव-पठनीय (TTY में रंगीन)।
  • --json: मशीन-पठनीय JSON (कोई स्टाइलिंग/स्पिनर नहीं)।
  • --no-color (या NO_COLOR=1): मानव-पठनीय लेआउट बनाए रखते हुए ANSI अक्षम करें।

साझा विकल्प

  • --url <url>: Gateway WebSocket URL।
  • --token <token>: Gateway टोकन।
  • --password <password>: Gateway पासवर्ड।
  • --timeout <ms>: टाइमआउट/समय-सीमा (डिफ़ॉल्ट प्रत्येक कमांड के अनुसार अलग होता है; नीचे प्रत्येक कमांड देखें)।
  • --expect-final: "अंतिम" प्रतिक्रिया की प्रतीक्षा करें (एजेंट कॉल)।

gateway health

bash
openclaw gateway health --url ws://127.0.0.1:18789openclaw gateway health --port 18789

/healthz एक लाइवनेस प्रोब है: जैसे ही सर्वर HTTP का उत्तर दे सकता है, यह लौट आता है। /readyz अधिक सख्त है और स्टार्टअप Plugin साइडकार, चैनल या कॉन्फ़िगर किए गए हुक के स्थिर होने तक लाल रहता है। स्थानीय या प्रमाणीकृत विस्तृत /readyz प्रतिक्रियाओं में एक eventLoop डायग्नोस्टिक ब्लॉक (विलंब, उपयोग, CPU-कोर अनुपात, degraded फ़्लैग) शामिल होता है।

OPENCLAW_DOCS_MARKER:paramOpen:IHBhdGg9Ii0tcG9ydCA8cG9ydA " type="number"> इस पोर्ट पर स्थानीय लूपबैक Gateway को लक्षित करें। इस कॉल के लिए OPENCLAW_GATEWAY_URL और OPENCLAW_GATEWAY_PORT को ओवरराइड करता है।

gateway usage-cost

सेशन लॉग से उपयोग-लागत सारांश प्राप्त करें।

bash
openclaw gateway usage-costopenclaw gateway usage-cost --days 7openclaw gateway usage-cost --agent work --jsonopenclaw gateway usage-cost --all-agentsopenclaw gateway usage-cost --json
"--days
"--agent
--all-agentsboolean

सभी कॉन्फ़िगर किए गए एजेंटों में एकत्रित करें। --agent के साथ संयोजित नहीं किया जा सकता।

gateway stability

चल रहे Gateway से हाल का डायग्नोस्टिक स्थिरता रिकॉर्डर प्राप्त करें।

bash
openclaw gateway stabilityopenclaw gateway stability --type payload.largeopenclaw gateway stability --bundle latestopenclaw gateway stability --bundle latest --exportopenclaw gateway stability --json

OPENCLAW_DOCS_MARKER:paramOpen:IHBhdGg9Ii0tbGltaXQgPGxpbWl0 " type="number" default="25"> शामिल किए जाने वाले हाल के ईवेंट की अधिकतम संख्या (अधिकतम 1000)।

OPENCLAW_DOCS_MARKER:paramOpen:IHBhdGg9Ii0tdHlwZSA8dHlwZQ " type="string"> डायग्नोस्टिक ईवेंट प्रकार के अनुसार फ़िल्टर करें, जैसे payload.large या diagnostic.memory.pressure।

"--since-seq
--bundle [path]string

चल रहे Gateway को कॉल करने के बजाय स्थायी रूप से सहेजा गया स्थिरता बंडल पढ़ें। --bundle latest (या केवल --bundle) स्टेट डायरेक्टरी के अंतर्गत नवीनतम बंडल चुनता है; आप सीधे बंडल JSON पथ भी दे सकते हैं।

--exportboolean

स्थिरता विवरण प्रिंट करने के बजाय साझा करने योग्य सहायता डायग्नोस्टिक्स zip लिखें।

OPENCLAW_DOCS_MARKER:paramOpen:IHBhdGg9Ii0tb3V0cHV0IDxwYXRo " type="string"> --export के लिए आउटपुट पथ।

गोपनीयता और बंडल व्यवहार
  • रिकॉर्ड परिचालन मेटाडेटा रखते हैं: ईवेंट नाम, गणनाएँ, बाइट आकार, मेमोरी रीडिंग, क्यू/सेशन स्थिति, अनुमोदन आईडी, चैनल/Plugin नाम और संशोधित सेशन सारांश। इनमें चैट टेक्स्ट, Webhook बॉडी, टूल आउटपुट, अपरिष्कृत अनुरोध/प्रतिक्रिया बॉडी, टोकन, कुकी, गुप्त मान, होस्टनाम और अपरिष्कृत सेशन आईडी शामिल नहीं होते। रिकॉर्डर को पूरी तरह अक्षम करने के लिए diagnostics.enabled: false सेट करें।
  • घातक Gateway निकास, शटडाउन टाइमआउट और पुनः आरंभ की स्टार्टअप विफलताएँ, रिकॉर्डर में ईवेंट होने पर उसी डायग्नोस्टिक स्नैपशॉट को ~/.openclaw/logs/stability/openclaw-stability-*.json में लिखती हैं। नवीनतम बंडल का openclaw gateway stability --bundle latest से निरीक्षण करें; --limit, --type और --since-seq बंडल आउटपुट पर भी लागू होते हैं।

gateway diagnostics export

बग रिपोर्ट के लिए डिज़ाइन की गई स्थानीय डायग्नोस्टिक्स zip लिखें। गोपनीयता मॉडल और बंडल सामग्री के लिए डायग्नोस्टिक्स निर्यात देखें।

bash
openclaw gateway diagnostics exportopenclaw gateway diagnostics export --output openclaw-diagnostics.zipopenclaw gateway diagnostics export --json
"--log-lines
"--log-bytes
"--url
"--token
"--password
"--timeout
--no-stability-bundleboolean

स्थायी रूप से सहेजे गए स्थिरता बंडल की खोज छोड़ें।

--jsonboolean

लिखे गए पथ, आकार और मैनिफ़ेस्ट को JSON के रूप में प्रिंट करें।

निर्यात में ये बंडल होते हैं: manifest.json (फ़ाइल सूची), summary.md (Markdown सारांश), diagnostics.json (शीर्ष-स्तरीय कॉन्फ़िगरेशन/लॉग/डिस्कवरी/स्थिरता/स्थिति/हेल्थ सारांश), config/sanitized.json, status/gateway-status.json, health/gateway-health.json, logs/openclaw-sanitized.jsonl, और बंडल मौजूद होने पर stability/latest.json।

इसे साझा करने के लिए डिज़ाइन किया गया है। यह डीबगिंग के लिए उपयोगी परिचालन विवरण रखता है—सुरक्षित लॉग फ़ील्ड, सबसिस्टम नाम, स्थिति कोड, अवधियाँ, कॉन्फ़िगर किए गए मोड, पोर्ट, Plugin/प्रदाता आईडी, गैर-गुप्त सुविधा सेटिंग और संशोधित परिचालन लॉग संदेश—और चैट टेक्स्ट, Webhook बॉडी, टूल आउटपुट, क्रेडेंशियल, कुकी, खाता/संदेश पहचानकर्ता, प्रॉम्प्ट/निर्देश टेक्स्ट, होस्टनाम और गुप्त मान छोड़ देता है या संशोधित करता है। जब कोई लॉग संदेश उपयोगकर्ता/चैट/टूल पेलोड टेक्स्ट जैसा दिखता है (जैसे "उपयोगकर्ता ने कहा", "चैट टेक्स्ट", "टूल आउटपुट", "Webhook बॉडी"), तो निर्यात केवल यह तथ्य रखता है कि संदेश छोड़ा गया था और साथ में उसकी बाइट संख्या रखता है।

gateway status

Gateway सेवा (launchd/systemd/schtasks) के साथ वैकल्पिक कनेक्टिविटी/प्रमाणीकरण प्रोब दिखाता है।

bash
openclaw gateway statusopenclaw gateway status --jsonopenclaw gateway status --require-rpc
"--url
"--token
"--password
"--timeout
--no-probeboolean

कनेक्टिविटी प्रोब छोड़ें (केवल-सेवा दृश्य)।

--deepboolean

सिस्टम-स्तरीय सेवाओं को भी स्कैन करें।

--require-rpcboolean

कनेक्टिविटी प्रोब को रीड प्रोब में अपग्रेड करें और उसके विफल होने पर गैर-शून्य स्थिति के साथ बाहर निकलें। --no-probe के साथ संयोजित नहीं किया जा सकता।

स्थिति का अर्थ
  • स्थानीय CLI कॉन्फ़िगरेशन के अनुपस्थित या अमान्य होने पर भी डायग्नोस्टिक्स के लिए उपलब्ध रहता है।
  • डिफ़ॉल्ट आउटपुट सेवा की स्थिति, WebSocket कनेक्शन और हैंडशेक के समय दिखाई देने वाली प्रमाणीकरण क्षमता प्रमाणित करता है—रीड/राइट/एडमिन संचालन नहीं।
  • पहली बार के डिवाइस प्रमाणीकरण के लिए प्रोब कोई बदलाव नहीं करते: मौजूदा कैश किया गया डिवाइस टोकन होने पर वे उसका पुनः उपयोग करते हैं, लेकिन केवल स्थिति जाँचने के लिए कभी नई CLI डिवाइस पहचान या केवल-पढ़ने योग्य पेयरिंग रिकॉर्ड नहीं बनाते।
  • संभव होने पर प्रोब प्रमाणीकरण के लिए कॉन्फ़िगर किए गए प्रमाणीकरण SecretRefs को रिज़ॉल्व करता है। यदि कोई आवश्यक SecretRef अनरिज़ॉल्व्ड है, तो प्रोब कनेक्टिविटी/प्रमाणीकरण विफल होने पर --json, rpc.authWarning रिपोर्ट करता है; --token/--password स्पष्ट रूप से दें या गुप्त स्रोत ठीक करें। प्रोब सफल हो जाने पर अनरिज़ॉल्व्ड-प्रमाणीकरण चेतावनियाँ दबा दी जाती हैं।
  • जब चल रहा Gateway इसे रिपोर्ट करता है, तो JSON आउटपुट में gateway.version शामिल होता है; यदि हैंडशेक प्रोब संस्करण मेटाडेटा उपलब्ध नहीं करा सकता, तो --require-rpc, status.runtimeVersion RPC पेलोड पर फ़ॉलबैक कर सकता है।
  • स्क्रिप्ट/ऑटोमेशन में --require-rpc का उपयोग करें, जब केवल सुन रही सेवा पर्याप्त न हो और रीड-स्कोप RPC का भी स्वस्थ होना आवश्यक हो।
  • --deep अतिरिक्त launchd/systemd/schtasks इंस्टॉलेशन के लिए स्कैन करता है; कई Gateway-जैसी सेवाएँ मिलने पर मानव-पठनीय आउटपुट सफ़ाई संकेत प्रिंट करता है (आमतौर पर प्रति मशीन एक Gateway चलाएँ) और प्रासंगिक होने पर हालिया सुपरवाइज़र रीस्टार्ट हैंडऑफ़ रिपोर्ट करता है।
  • --deep Plugin-जागरूक मोड (pluginValidation: "full") में कॉन्फ़िगरेशन सत्यापन भी चलाता है और Plugin मैनिफ़ेस्ट चेतावनियाँ दिखाता है (जैसे अनुपस्थित चैनल कॉन्फ़िगरेशन मेटाडेटा)। डिफ़ॉल्ट gateway status तेज़ केवल-पढ़ने योग्य पथ रखता है, जो Plugin सत्यापन छोड़ देता है।
  • मानव-पठनीय आउटपुट में रिज़ॉल्व किया गया फ़ाइल लॉग पथ और CLI-बनाम-सेवा कॉन्फ़िगरेशन पथ/वैधता शामिल होती है, ताकि प्रोफ़ाइल या स्टेट-डायरेक्टरी विचलन का निदान करने में सहायता मिले।
  • मानव-पठनीय आउटपुट में लागू सीमा और उसकी अनुकूली व्युत्पत्ति के साथ Gateway heap: शामिल होता है। JSON आउटपुट उसी रिपोर्ट को service.gatewayHeap के रूप में प्रदर्शित करता है।
Linux systemd प्रमाणीकरण-विचलन जाँच
  • सेवा प्रमाणीकरण विचलन जाँच यूनिट से Environment= और EnvironmentFile= दोनों पढ़ती है (%h, उद्धृत पथ, कई फ़ाइलें और वैकल्पिक - फ़ाइलें सहित)।
  • मर्ज किए गए रनटाइम env का उपयोग करके gateway.auth.token SecretRefs को रिज़ॉल्व करता है (पहले सेवा कमांड env, फिर प्रक्रिया env फ़ॉलबैक)।
  • जब टोकन प्रमाणीकरण प्रभावी रूप से सक्रिय नहीं होता, तो टोकन-विचलन जाँच कॉन्फ़िगरेशन टोकन रिज़ॉल्यूशन छोड़ देती है (gateway.auth.mode स्पष्ट रूप से password/none/trusted-proxy, या मोड अनसेट हो जहाँ पासवर्ड प्राथमिक हो सकता है और कोई टोकन उम्मीदवार प्राथमिक नहीं हो सकता)।

gateway probe

"सब कुछ डीबग करें" कमांड। यह हमेशा इनका प्रोब करता है:

  • आपका कॉन्फ़िगर किया गया रिमोट Gateway (यदि सेट है), और
  • localhost (लूपबैक), भले ही रिमोट कॉन्फ़िगर किया गया हो।

--url देने से वह स्पष्ट लक्ष्य इन दोनों से पहले जुड़ जाता है। मानव-पठनीय आउटपुट लक्ष्यों को URL (explicit), Remote (configured) / Remote (configured, inactive), और Local loopback लेबल देता है।

bash
openclaw gateway probeopenclaw gateway probe --jsonopenclaw gateway probe --port 18789

OPENCLAW_DOCS_MARKER:paramOpen:IHBhdGg9Ii0tcG9ydCA8cG9ydA " type="number"> स्थानीय लूपबैक प्रोब लक्ष्य और SSH टनल रिमोट पोर्ट के लिए इस पोर्ट का उपयोग करें। --url के बिना, यह कॉन्फ़िगर किए गए Gateway परिवेश URL, परिवेश पोर्ट या रिमोट लक्ष्यों के बजाय केवल स्थानीय लूपबैक लक्ष्य चुनता है।

व्याख्या
  • Reachable: yes का अर्थ है कि कम-से-कम एक लक्ष्य ने WebSocket कनेक्शन स्वीकार किया।
  • Capability: read-only|write-capable|admin-capable|pairing-pending|connect-only पहुँच-योग्यता से अलग यह रिपोर्ट करता है कि प्रोब प्रमाणीकरण के बारे में क्या प्रमाणित कर सका।
  • Read probe: ok का अर्थ है कि रीड-स्कोप विस्तृत RPC कॉल (health/status/system-presence/config.get) भी सफल रहे।
  • Read probe: limited - missing scope: operator.read का अर्थ है कि कनेक्शन सफल रहा, लेकिन रीड-स्कोप RPC सीमित है। इसे पूर्ण विफलता नहीं, बल्कि अवनत पहुँच-योग्यता के रूप में रिपोर्ट किया जाता है।
  • Connect: ok के बाद Read probe: failed का अर्थ है कि WebSocket कनेक्ट हो गया, लेकिन बाद की रीड डायग्नोस्टिक्स का समय समाप्त हो गया या वे विफल रहीं—यह भी अगम्य नहीं, बल्कि अवनत है।
  • gateway status की तरह, प्रोब मौजूदा कैश किए गए डिवाइस प्रमाणीकरण का पुनः उपयोग करता है, लेकिन पहली बार की डिवाइस पहचान या पेयरिंग स्थिति नहीं बनाता।
  • निकास कोड केवल तभी गैर-शून्य होता है, जब प्रोब किया गया कोई भी लक्ष्य पहुँच योग्य न हो।
JSON आउटपुट

शीर्ष स्तर:

  • ok: कम-से-कम एक लक्ष्य पहुँच योग्य है।
  • degraded: कम-से-कम एक लक्ष्य ने कनेक्शन स्वीकार किया, लेकिन पूर्ण-विवरण RPC निदान पूरा नहीं किया।
  • capability: पहुँच योग्य लक्ष्यों में देखी गई सर्वोत्तम क्षमता (read_only, write_capable, admin_capable, pairing_pending, connected_no_operator_scope, या unknown)।
  • primaryTargetId: सक्रिय विजेता मानने के लिए सर्वोत्तम लक्ष्य, इस क्रम में: स्पष्ट URL, SSH टनल, कॉन्फ़िगर किया गया रिमोट, स्थानीय लूपबैक।
  • warnings[]: code, message, और वैकल्पिक targetIds वाले सर्वोत्तम-प्रयास चेतावनी रिकॉर्ड।
  • network: वर्तमान कॉन्फ़िगरेशन और होस्ट नेटवर्किंग से प्राप्त स्थानीय लूपबैक/टेलनेट URL संकेत।
  • discovery.timeoutMs / discovery.count: इस जाँच चरण के लिए उपयोग की गई वास्तविक खोज सीमा/परिणाम संख्या।

प्रति लक्ष्य (targets[].connect): ok (पहुँच योग्यता + अवनत वर्गीकरण), rpcOk (पूर्ण-विवरण RPC सफलता), scopeLimited (ऑपरेटर स्कोप अनुपलब्ध होने के कारण विवरण RPC विफल)।

प्रति लक्ष्य (targets[].auth): उपलब्ध होने पर hello-ok में रिपोर्ट किए गए role और scopes, साथ ही प्रदर्शित capability वर्गीकरण।

सामान्य चेतावनी कोड
  • ssh_tunnel_failed: SSH टनल सेटअप विफल रहा; कमांड ने प्रत्यक्ष जाँच का सहारा लिया।
  • multiple_gateways: अलग-अलग Gateway पहचानें पहुँच योग्य थीं, या OpenClaw यह सिद्ध नहीं कर सका कि पहुँच योग्य लक्ष्य एक ही Gateway हैं। उसी Gateway के लिए SSH टनल, प्रॉक्सी URL, या कॉन्फ़िगर किया गया रिमोट URL इसे ट्रिगर नहीं करता।
  • auth_secretref_unresolved: विफल लक्ष्य के लिए कॉन्फ़िगर किए गए प्रमाणीकरण SecretRef का समाधान नहीं किया जा सका।
  • probe_scope_limited: WebSocket कनेक्शन सफल रहा, लेकिन operator.read अनुपलब्ध होने के कारण पठन जाँच सीमित थी।
  • local_tls_runtime_unavailable: स्थानीय Gateway TLS सक्षम है, लेकिन OpenClaw स्थानीय प्रमाणपत्र फ़िंगरप्रिंट लोड नहीं कर सका।

SSH पर रिमोट (Mac ऐप के अनुरूप)

macOS ऐप का "Remote over SSH" मोड स्थानीय पोर्ट-फ़ॉरवर्ड का उपयोग करता है, ताकि केवल लूपबैक वाला रिमोट Gateway ws://127.0.0.1:<port> पर पहुँच योग्य हो जाए।

CLI समकक्ष:

bash
openclaw gateway probe --ssh user@gateway-host

OPENCLAW_DOCS_MARKER:paramOpen:IHBhdGg9Ii0tc3NoIDx0YXJnZXQ " type="string"> user@host या user@host:port (पोर्ट का डिफ़ॉल्ट 22 है)।

--ssh-autoboolean

समाधान किए गए खोज एंडपॉइंट (local. और कॉन्फ़िगर किया गया वाइड-एरिया डोमेन, यदि कोई हो) से पहले खोजे गए Gateway होस्ट को SSH लक्ष्य के रूप में चुनें। केवल-TXT संकेतों को अनदेखा किया जाता है।

कॉन्फ़िगरेशन डिफ़ॉल्ट (वैकल्पिक): gateway.remote.sshTarget, gateway.remote.sshIdentity।

gateway call <method>

निम्न-स्तरीय RPC सहायक।

bash
openclaw gateway call statusopenclaw gateway call logs.tail --params '{"limit": 200}'
"--params
"--url
"--token
"--password
"--timeout
--expect-finalboolean

मुख्यतः एजेंट-शैली RPC के लिए, जो अंतिम पेलोड से पहले मध्यवर्ती इवेंट स्ट्रीम करते हैं।

--jsonboolean

मशीन-पठनीय JSON आउटपुट।

Gateway सेवा प्रबंधित करें

bash
openclaw gateway installopenclaw gateway startopenclaw gateway stopopenclaw gateway restartopenclaw gateway uninstall

रैपर के साथ इंस्टॉल करें

जब प्रबंधित सेवा को किसी अन्य एक्ज़िक्यूटेबल के माध्यम से शुरू होना आवश्यक हो, जैसे सीक्रेट मैनेजर शिम या रन-ऐज़ सहायक, तब --wrapper का उपयोग करें। रैपर सामान्य Gateway आर्ग्युमेंट प्राप्त करता है और अंततः उन्हीं आर्ग्युमेंट के साथ openclaw या Node को निष्पादित करने के लिए उत्तरदायी होता है।

bash
cat > ~/.local/bin/openclaw-doppler <<'EOF'#!/usr/bin/env bashset -euo pipefailexec doppler run --project my-project --config production -- openclaw "$@"EOFchmod +x ~/.local/bin/openclaw-doppler openclaw gateway install --wrapper ~/.local/bin/openclaw-doppler --forceopenclaw gateway restart

आप पर्यावरण के माध्यम से भी रैपर सेट कर सकते हैं। gateway install सत्यापित करता है कि पथ एक एक्ज़िक्यूटेबल फ़ाइल है, रैपर को सेवा ProgramArguments में लिखता है, और बाद के बाध्य पुनः-इंस्टॉल, अपडेट तथा डॉक्टर मरम्मत के लिए सेवा पर्यावरण में OPENCLAW_WRAPPER को बनाए रखता है।

bash
OPENCLAW_WRAPPER="$HOME/.local/bin/openclaw-doppler" openclaw gateway install --forceopenclaw doctor

बनाए रखे गए रैपर को हटाने के लिए, पुनः इंस्टॉल करते समय OPENCLAW_WRAPPER को खाली करें:

bash
OPENCLAW_WRAPPER= openclaw gateway install --forceopenclaw gateway restart
कमांड विकल्प
  • gateway status: --url, --token, --password, --timeout, --no-probe, --require-rpc, --deep, --json
  • gateway install: --port, --runtime <node> (डिफ़ॉल्ट: node), --token, --wrapper <path>, --force, --json
  • gateway restart: --safe, --skip-deferral, --force, --wait <duration>, --json
  • gateway uninstall|start: --json
  • gateway stop: --disable, --force, --json
जीवनचक्र व्यवहार
  • gateway start आइडेम्पोटेंट है: जब प्रबंधित सेवा पहले से चल रही होती है, तो यह चल रही प्रक्रिया की रिपोर्ट करता है और उसे अपरिवर्तित छोड़ देता है। लोड की गई लेकिन रुकी हुई सेवा पहले की तरह शुरू की जाती है।
  • प्रबंधित सेवा को पुनः आरंभ करने के लिए gateway restart का उपयोग करें। पुनः आरंभ के विकल्प के रूप में gateway stop और gateway start को क्रमबद्ध न करें।
  • गैर-इंटरैक्टिव शेल में, gateway stop के लिए --force आवश्यक है। इंटरैक्टिव टर्मिनल मौजूदा प्रॉम्प्ट-मुक्त व्यवहार बनाए रखते हैं। स्वचालन और परीक्षणों के लिए, gateway run --dev या उपलब्ध पोर्ट वाले पृथक --profile को प्राथमिकता दें।
  • macOS पर, gateway stop डिफ़ॉल्ट रूप से launchctl bootout का उपयोग करता है, जो अक्षम स्थिति बनाए रखे बिना वर्तमान बूट सत्र से LaunchAgent को हटा देता है—भविष्य की क्रैश के लिए KeepAlive स्वतः-पुनर्प्राप्ति सक्रिय रहती है और gateway start बिना मैन्युअल launchctl enable के साफ़-सुथरे ढंग से पुनः सक्षम करता है। KeepAlive और RunAtLoad को स्थायी रूप से दबाने के लिए --disable दें, ताकि अगला स्पष्ट gateway start होने तक Gateway फिर से शुरू न हो; इसका उपयोग तब करें जब मैन्युअल रोक रीबूट के बाद भी बनी रहनी चाहिए।
  • Gateway जीवनचक्र परिवर्तन CLI प्रारंभ, रोक और पुनः आरंभ संचालन, सुरक्षित पुनः आरंभ अनुरोध, सुपरवाइज़र पुनः आरंभ तथा अलग किए गए हैंडऑफ़ सहित सर्वोत्तम-प्रयास कुंजी-मूल्य ऑडिट रिकॉर्ड <state-dir>/logs/gateway-restart.log में जोड़ते हैं।
  • जीवनचक्र कमांड स्क्रिप्टिंग के लिए --json स्वीकार करते हैं।
प्रबंधित Gateway हीप आकार निर्धारण
  • gateway install प्रबंधित Gateway सेवा के लिए केवल-हीप NODE_OPTIONS मान लिखता है। जब Node किसी कंटेनर या सेवा सीमा की रिपोर्ट करता है, तो यह सीमित मेमोरी के 50% को लक्षित करता है; अन्यथा भौतिक मेमोरी के 50% को।
  • नाममात्र लक्ष्य सीमा 2048–8192 MiB है, साथ में मूल मेमोरी हेडरूम की अतिरिक्त 75% सीमा है। छोटे होस्ट पर यह हेडरूम सीमा लागू सीमा को नाममात्र 2048 MiB न्यूनतम से नीचे रख सकती है।
  • इंस्टॉल की गई सेवा में पहले से संग्रहित मान्य स्पष्ट --max-old-space-size को बाध्य पुनः-इंस्टॉल और डॉक्टर मरम्मत के दौरान सुरक्षित रखा जाता है। अन्य NODE_OPTIONS फ़्लैग प्रबंधित सेवा में नहीं ले जाए जाते।
  • परिवेशी शेल NODE_OPTIONS इस नीति को ओवरराइड नहीं करता। इंस्टॉल किए गए मान का निरीक्षण करने के लिए gateway status या doctor का उपयोग करें; बिना प्रबंधित हीप सेटिंग वाले पुराने सेवा मेटाडेटा को पुनः उत्पन्न करने के लिए openclaw gateway install --force चलाएँ।
  • यह नीति केवल प्रबंधित Gateway सेवा पर लागू होती है। अग्रभूमि gateway run, Node सेवाएँ और हाथ से लिखी गई सुपरवाइज़र इकाइयाँ अपना स्वयं का रनटाइम कॉन्फ़िगरेशन बनाए रखती हैं।
इंस्टॉल के समय प्रमाणीकरण और SecretRefs
  • जब टोकन प्रमाणीकरण के लिए टोकन आवश्यक हो और gateway.auth.token SecretRef द्वारा प्रबंधित हो, तो gateway install सत्यापित करता है कि SecretRef का समाधान किया जा सकता है, लेकिन समाधान किए गए टोकन को सेवा पर्यावरण मेटाडेटा में बनाए नहीं रखता।
  • यदि टोकन प्रमाणीकरण के लिए टोकन आवश्यक है और कॉन्फ़िगर किए गए टोकन SecretRef का समाधान नहीं होता, तो इंस्टॉल फ़ॉलबैक सादा पाठ बनाए रखने के बजाय सुरक्षित रूप से विफल हो जाता है।
  • gateway run पर पासवर्ड प्रमाणीकरण के लिए, इनलाइन --password के बजाय OPENCLAW_GATEWAY_PASSWORD, --password-file, या SecretRef-समर्थित gateway.auth.password को प्राथमिकता दें।
  • अनुमानित प्रमाणीकरण मोड में, केवल-शेल OPENCLAW_GATEWAY_PASSWORD इंस्टॉल टोकन आवश्यकताओं को शिथिल नहीं करता; प्रबंधित सेवा इंस्टॉल करते समय स्थायी कॉन्फ़िगरेशन (gateway.auth.password या कॉन्फ़िगरेशन env) का उपयोग करें।
  • यदि gateway.auth.token और gateway.auth.password दोनों कॉन्फ़िगर किए गए हैं तथा gateway.auth.mode सेट नहीं है, तो मोड स्पष्ट रूप से सेट किए जाने तक इंस्टॉल अवरुद्ध रहता है।

Gateway खोजें (Bonjour)

gateway discover Gateway बीकन (_openclaw-gw._tcp) के लिए स्कैन करता है।

  • मल्टीकास्ट DNS-SD: local.
  • यूनिकास्ट DNS-SD (वाइड-एरिया Bonjour): कोई डोमेन चुनें (उदाहरण: openclaw.internal.) और स्प्लिट DNS + DNS सर्वर सेट अप करें; Bonjour देखें।

केवल वे Gateway बीकन का प्रसारण करते हैं जिनमें Bonjour खोज सक्षम है (डिफ़ॉल्ट)।

प्रत्येक बीकन पर TXT संकेत: role (Gateway भूमिका संकेत), transport (ट्रांसपोर्ट संकेत, जैसे gateway), gatewayPort (WebSocket पोर्ट, सामान्यतः 18789), tailnetDns (MagicDNS होस्टनाम, उपलब्ध होने पर), gatewayTls / gatewayTlsSha256 (TLS सक्षम + प्रमाणपत्र फ़िंगरप्रिंट)। sshPort और cliPath केवल पूर्ण खोज मोड (discovery.mdns.mode: "full"; डिफ़ॉल्ट "minimal" है, जो इन्हें छोड़ देता है—इसके बाद क्लाइंट SSH लक्ष्य को डिफ़ॉल्ट रूप से पोर्ट 22 पर सेट करते हैं) में प्रकाशित किए जाते हैं।

gateway discover

bash
openclaw gateway discover
"--timeout
--jsonboolean

मशीन-पठनीय आउटपुट (स्टाइलिंग/स्पिनर भी अक्षम करता है)।

उदाहरण:

bash
openclaw gateway discover --timeout 4000openclaw gateway discover --json | jq '.beacons[].wsUrl'

संबंधित

Was this useful?
On this page

On this page