सेटअप

संक्षेप में

आप कितनी बार अपडेट चाहते हैं और क्या आप Gateway स्वयं चलाना चाहते हैं, इसके आधार पर सेटअप कार्यप्रवाह चुनें:

• अनुकूलन रेपो के बाहर रहता है: अपना कॉन्फ़िगरेशन और कार्यक्षेत्र ~/.openclaw/openclaw.json और ~/.openclaw/workspace/ में रखें, ताकि रेपो अपडेट उन्हें प्रभावित न करें।
• स्थिर कार्यप्रवाह (अधिकांश लोगों के लिए अनुशंसित): macOS ऐप इंस्टॉल करें और उसे बंडल किया गया Gateway चलाने दें।
• अत्याधुनिक कार्यप्रवाह (डेवलपमेंट): pnpm gateway:watch के माध्यम से Gateway स्वयं चलाएँ, फिर macOS ऐप को Local मोड में उससे कनेक्ट होने दें।

पूर्वापेक्षाएँ (स्रोत से)

• Node 24.15+ अनुशंसित है (Node 22 LTS, वर्तमान में 22.22.3+, अब भी समर्थित है)
• स्रोत चेकआउट के लिए pnpm आवश्यक है। OpenClaw डेवलपमेंट मोड में बंडल किए गए plugins को extensions/* pnpm कार्यक्षेत्र पैकेजों से लोड करता है, इसलिए रूट npm install पूरे स्रोत ट्री को तैयार नहीं करता।
• Docker (वैकल्पिक; केवल कंटेनरीकृत सेटअप/e2e के लिए—Docker देखें)

अनुकूलन रणनीति (ताकि अपडेट नुकसान न पहुँचाएँ)

यदि आप "100% मेरे अनुरूप" और आसान अपडेट चाहते हैं, तो अपना अनुकूलन इनमें रखें:

• कॉन्फ़िगरेशन: ~/.openclaw/openclaw.json (JSON/लगभग JSON5)
• कार्यक्षेत्र: ~/.openclaw/workspace (skills, प्रॉम्प्ट, स्मृतियाँ; इसे निजी git रेपो बनाएँ)

पूरा ऑनबोर्डिंग विज़ार्ड चलाए बिना, कॉन्फ़िगरेशन/कार्यक्षेत्र फ़ोल्डर एक बार बूटस्ट्रैप करें:

openclaw setup --baseline

अभी तक ग्लोबल इंस्टॉल नहीं किया है? इसके बजाय इसे इस रेपो से चलाएँ:

pnpm openclaw setup --baseline

(--baseline के बिना केवल openclaw setup, openclaw onboard का उपनाम है और पूरा इंटरैक्टिव विज़ार्ड चलाता है।)

इस रेपो से Gateway चलाएँ

pnpm build के बाद, आप पैकेज किया गया CLI सीधे चला सकते हैं:

node openclaw.mjs gateway --port 18789 --verbose

स्थिर कार्यप्रवाह (पहले macOS ऐप)

1. OpenClaw.app (मेनू बार) इंस्टॉल करके लॉन्च करें।
2. ऑनबोर्डिंग/अनुमति चेकलिस्ट (TCC प्रॉम्प्ट) पूरी करें।
3. सुनिश्चित करें कि Gateway Local है और चल रहा है (ऐप इसे प्रबंधित करता है)।
4. सतहें लिंक करें (उदाहरण: WhatsApp):

openclaw channels login

5. त्वरित जाँच:

openclaw health

यदि आपके बिल्ड में ऑनबोर्डिंग उपलब्ध नहीं है:

• openclaw setup चलाएँ, फिर openclaw channels login चलाएँ, उसके बाद Gateway मैन्युअल रूप से शुरू करें (openclaw gateway)।

अत्याधुनिक कार्यप्रवाह (टर्मिनल में Gateway)

लक्ष्य: TypeScript Gateway पर काम करना, हॉट रीलोड पाना और macOS ऐप UI को कनेक्ट रखना।

0) (वैकल्पिक) macOS ऐप भी स्रोत से चलाएँ

यदि आप macOS ऐप को भी अत्याधुनिक संस्करण पर रखना चाहते हैं:

./scripts/restart-mac.sh

1) डेवलपमेंट Gateway शुरू करें

pnpm install# केवल पहली बार (या स्थानीय OpenClaw कॉन्फ़िगरेशन/कार्यक्षेत्र रीसेट करने के बाद)pnpm openclaw setuppnpm gateway:watch

gateway:watch नामित tmux सत्र (openclaw-gateway-watch-main) में Gateway वॉच प्रक्रिया शुरू या पुनः शुरू करता है और इंटरैक्टिव टर्मिनलों से स्वतः जुड़ता है। गैर-इंटरैक्टिव शेल अलग रहते हैं और tmux attach -t openclaw-gateway-watch-main प्रिंट करते हैं; इंटरैक्टिव रन को अलग रखने के लिए OPENCLAW_GATEWAY_WATCH_ATTACH=0 pnpm gateway:watch या फ़ोरग्राउंड वॉच मोड के लिए pnpm gateway:watch:raw का उपयोग करें। वॉचर कॉन्फ़िगर किया गया/डिफ़ॉल्ट पोर्ट अपने नियंत्रण में लेने से पहले सक्रिय प्रोफ़ाइल की इंस्टॉल की गई Gateway सेवा रोक देता है, जिससे सेवा सुपरवाइज़र स्रोत प्रक्रिया को प्रतिस्थापित नहीं कर पाता। सेवा इंस्टॉल रहती है; वॉचिंग समाप्त करने पर pnpm openclaw gateway start चलाएँ। स्टार्टअप विफल होने के बाद भी tmux पेन उपलब्ध रहता है, ताकि दूसरा टर्मिनल या एजेंट उससे जुड़ सके या उसके लॉग कैप्चर कर सके। संबंधित स्रोत, कॉन्फ़िगरेशन और बंडल किए गए plugin मेटाडेटा में बदलाव होने पर वॉचर रीलोड करता है। यदि वॉच किया जा रहा Gateway स्टार्टअप के दौरान बंद हो जाता है, तो gateway:watch एक बार openclaw doctor --fix --non-interactive चलाकर पुनः प्रयास करता है; केवल डेवलपमेंट के लिए यह सुधार चरण अक्षम करने हेतु OPENCLAW_GATEWAY_WATCH_AUTO_DOCTOR=0 सेट करें। pnpm gateway:watch, dist/control-ui को दोबारा बिल्ड नहीं करता, इसलिए ui/ में बदलाव के बाद pnpm ui:build दोबारा चलाएँ या Control UI विकसित करते समय pnpm ui:dev का उपयोग करें।

2) macOS ऐप को अपने चल रहे Gateway पर निर्देशित करें

OpenClaw.app में:

• Connection Mode: Local ऐप कॉन्फ़िगर किए गए पोर्ट पर चल रहे gateway से कनेक्ट हो जाएगा।

3) सत्यापित करें

• ऐप में Gateway की स्थिति "Using existing gateway …" दिखानी चाहिए
• या CLI के माध्यम से:

openclaw health

सामान्य गलतियाँ

• गलत पोर्ट: Gateway WS का डिफ़ॉल्ट ws://127.0.0.1:18789 है; ऐप और CLI को एक ही पोर्ट पर रखें।
• स्थिति कहाँ रहती है:
  • चैनल/प्रदाता स्थिति: ~/.openclaw/credentials/
  • मॉडल प्रमाणीकरण प्रोफ़ाइल: ~/.openclaw/agents/<agentId>/agent/auth-profiles.json
  • सत्र और प्रतिलेख: ~/.openclaw/agents/<agentId>/agent/openclaw-agent.sqlite
  • पुराने/संग्रहित सत्र आर्टिफ़ैक्ट: ~/.openclaw/agents/<agentId>/sessions/
  • लॉग: /tmp/openclaw/

क्रेडेंशियल भंडारण मानचित्र

प्रमाणीकरण डीबग करते समय या किसका बैकअप लेना है यह तय करते समय इसका उपयोग करें:

• WhatsApp: ~/.openclaw/credentials/whatsapp/<accountId>/creds.json
• Telegram बॉट टोकन: कॉन्फ़िगरेशन/env या channels.telegram.tokenFile (केवल नियमित फ़ाइल; सिमलिंक अस्वीकृत)
• Discord बॉट टोकन: कॉन्फ़िगरेशन/env या SecretRef (env/file/exec प्रदाता)
• Slack टोकन: कॉन्फ़िगरेशन/env (channels.slack.*)
• पेयरिंग अनुमति-सूचियाँ:
  • ~/.openclaw/credentials/<channel>-allowFrom.json (डिफ़ॉल्ट खाता)
  • ~/.openclaw/credentials/<channel>-<accountId>-allowFrom.json (गैर-डिफ़ॉल्ट खाते)
• मॉडल प्रमाणीकरण प्रोफ़ाइल: ~/.openclaw/agents/<agentId>/agent/auth-profiles.json
• फ़ाइल-समर्थित सीक्रेट पेलोड (वैकल्पिक): ~/.openclaw/secrets.json
• पुराना OAuth आयात: ~/.openclaw/credentials/oauth.json अधिक विवरण: सुरक्षा।

अपडेट करना (अपने सेटअप को खराब किए बिना)

• ~/.openclaw/workspace और ~/.openclaw/ को "अपनी सामग्री" के रूप में रखें; व्यक्तिगत प्रॉम्प्ट/कॉन्फ़िगरेशन को openclaw रेपो में न रखें।
• स्रोत अपडेट करना: git pull + pnpm install + pnpm gateway:watch का उपयोग जारी रखें।

Linux (systemd उपयोगकर्ता सेवा)

Linux इंस्टॉल systemd user सेवा का उपयोग करते हैं। डिफ़ॉल्ट रूप से, systemd लॉगआउट/निष्क्रियता पर उपयोगकर्ता सेवाएँ रोक देता है, जिससे Gateway बंद हो जाता है। ऑनबोर्डिंग आपके लिए लिंगरिंग सक्षम करने का प्रयास करती है (sudo के लिए संकेत मिल सकता है)। यदि यह अब भी बंद है, तो चलाएँ:

sudo loginctl enable-linger $USER

हमेशा चालू या बहु-उपयोगकर्ता सर्वर के लिए, उपयोगकर्ता सेवा के बजाय system सेवा पर विचार करें (लिंगरिंग की आवश्यकता नहीं)। systemd संबंधी टिप्पणियों के लिए Gateway रनबुक देखें।

संबंधित दस्तावेज़

• Gateway रनबुक (फ़्लैग, पर्यवेक्षण, पोर्ट)
• Gateway कॉन्फ़िगरेशन (कॉन्फ़िगरेशन स्कीमा + उदाहरण)
• Discord और Telegram (उत्तर टैग + replyToMode सेटिंग)
• OpenClaw सहायक सेटअप
• macOS ऐप (gateway जीवनचक्र)