First steps
ऑनबोर्डिंग (CLI)
CLI ऑनबोर्डिंग macOS, Linux, या Windows पर OpenClaw के लिए अनुशंसित टर्मिनल सेटअप पथ है। Windows डेस्कटॉप उपयोगकर्ता Windows Hub से भी शुरू कर सकते हैं। यह एक निर्देशित फ़्लो में local Gateway या रिमोट Gateway कनेक्शन, साथ में चैनल, Skills, और वर्कस्पेस डिफ़ॉल्ट कॉन्फ़िगर करता है।
openclaw onboardQuickStart में आम तौर पर केवल कुछ मिनट लगते हैं, लेकिन पूर्ण ऑनबोर्डिंग में अधिक समय लग सकता है
जब प्रोवाइडर साइन-इन, चैनल पेयरिंग, daemon इंस्टॉल, नेटवर्क डाउनलोड,
Skills, या वैकल्पिक Plugin को अतिरिक्त सेटअप की ज़रूरत हो। विज़र्ड यह समयरेखा पहले ही दिखा देता है,
और वैकल्पिक चरण छोड़े जा सकते हैं और बाद में
openclaw configure के साथ फिर देखे जा सकते हैं।
लोकेल
CLI विज़र्ड स्थिर ऑनबोर्डिंग कॉपी को स्थानीयकृत करता है। यह लोकेल को
OPENCLAW_LOCALE, फिर LC_ALL, फिर LC_MESSAGES, फिर LANG से हल करता है, और
English पर फ़ॉलबैक करता है। समर्थित विज़र्ड लोकेल en, zh-CN, और zh-TW हैं।
OPENCLAW_LOCALE=zh-CN openclaw onboardनाम और स्थिर पहचानकर्ता शाब्दिक रहते हैं: OpenClaw, Gateway, Tailscale,
कमांड, config keys, URLs, provider IDs, model IDs, और plugin/channel labels
अनुवादित नहीं होते।
बाद में फिर से कॉन्फ़िगर करने के लिए:
openclaw configureopenclaw agents add <name>QuickStart बनाम Advanced
ऑनबोर्डिंग QuickStart (डिफ़ॉल्ट) बनाम Advanced (पूर्ण नियंत्रण) से शुरू होती है।
QuickStart (defaults)
- Local gateway (loopback)
- वर्कस्पेस डिफ़ॉल्ट (या मौजूदा वर्कस्पेस)
- Gateway पोर्ट 18789
- Gateway auth Token (स्वतः जनरेटेड, loopback पर भी)
- नए local सेटअप के लिए टूल नीति डिफ़ॉल्ट:
tools.profile: "coding"(मौजूदा स्पष्ट प्रोफ़ाइल सुरक्षित रहती है) - DM isolation डिफ़ॉल्ट: local ऑनबोर्डिंग unset होने पर
session.dmScope: "per-channel-peer"लिखती है। विवरण: CLI Setup Reference - Tailscale exposure Off
- Telegram + WhatsApp DMs का डिफ़ॉल्ट allowlist है (आपसे आपका फ़ोन नंबर पूछा जाएगा)
Advanced (full control)
- हर चरण दिखाता है (मोड, वर्कस्पेस, Gateway, चैनल, daemon, Skills).
ऑनबोर्डिंग क्या कॉन्फ़िगर करती है
Local मोड (डिफ़ॉल्ट) आपको इन चरणों से गुज़ारता है:
- Model/Auth — कोई भी समर्थित प्रोवाइडर/auth फ़्लो चुनें (API key, OAuth, या provider-specific manual auth), जिसमें Custom Provider
(OpenAI-compatible, Anthropic-compatible, या Unknown auto-detect) शामिल है। एक डिफ़ॉल्ट मॉडल चुनें।
सुरक्षा नोट: यदि यह एजेंट टूल चलाएगा या webhook/hooks सामग्री प्रोसेस करेगा, तो उपलब्ध सबसे मज़बूत latest-generation मॉडल को प्राथमिकता दें और टूल नीति को सख्त रखें। कमजोर/पुराने tiers prompt-inject करना आसान होते हैं।
non-interactive रन के लिए,
--secret-input-mode refplaintext API key values के बजाय auth profiles में env-backed refs स्टोर करता है। non-interactiverefमोड में, provider env var सेट होना चाहिए; उस env var के बिना inline key flags पास करने पर तुरंत विफलता होती है। interactive रन में, secret reference mode चुनने से आप environment variable या configured provider ref (fileयाexec) की ओर संकेत कर सकते हैं, सेव करने से पहले तेज़ preflight validation के साथ। Anthropic के लिए, interactive onboarding/configure पसंदीदा local path के रूप में Anthropic Claude CLI और अनुशंसित production path के रूप में Anthropic API key प्रदान करता है। Anthropic setup-token भी समर्थित token-auth path के रूप में उपलब्ध रहता है। - वर्कस्पेस — एजेंट फ़ाइलों का स्थान (डिफ़ॉल्ट
~/.openclaw/workspace)। bootstrap फ़ाइलें seed करता है। - Gateway — पोर्ट, bind address, auth mode, Tailscale exposure।
interactive token मोड में, डिफ़ॉल्ट plaintext token storage चुनें या SecretRef में opt in करें।
Non-interactive token SecretRef path:
--gateway-token-ref-env <ENV_VAR>. - चैनल — built-in और official Plugin चैट चैनल जैसे iMessage, Discord, Feishu, Google Chat, Mattermost, Microsoft Teams, QQ Bot, Signal, Slack, Telegram, WhatsApp, और अधिक।
- Daemon — LaunchAgent (macOS), systemd user unit (Linux/WSL2), या per-user Startup-folder fallback के साथ native Windows Scheduled Task इंस्टॉल करता है।
यदि token auth को token की आवश्यकता है और
gateway.auth.tokenSecretRef-managed है, तो daemon install इसे validate करता है लेकिन resolved token को supervisor service environment metadata में persist नहीं करता। यदि token auth को token की आवश्यकता है और configured token SecretRef unresolved है, तो daemon install actionable guidance के साथ block होता है। यदिgateway.auth.tokenऔरgateway.auth.passwordदोनों configured हैं औरgateway.auth.modeunset है, तो daemon install तब तक block होता है जब तक mode स्पष्ट रूप से set न हो। - Health check — Gateway शुरू करता है और सत्यापित करता है कि यह चल रहा है।
- Skills — अनुशंसित Skills और वैकल्पिक dependencies इंस्टॉल करता है।
Remote मोड केवल local client को कहीं और मौजूद Gateway से कनेक्ट करने के लिए कॉन्फ़िगर करता है। यह remote host पर कुछ भी install या change नहीं करता।
दूसरा एजेंट जोड़ें
अपने स्वयं के वर्कस्पेस,
sessions, और auth profiles के साथ एक अलग एजेंट बनाने के लिए openclaw agents add <name> का उपयोग करें। --workspace के बिना चलाने पर ऑनबोर्डिंग शुरू होती है।
यह क्या सेट करता है:
agents.list[].nameagents.list[].workspaceagents.list[].agentDir
नोट्स:
- डिफ़ॉल्ट वर्कस्पेस
~/.openclaw/workspace-<agentId>का अनुसरण करते हैं। - inbound messages route करने के लिए
bindingsजोड़ें (ऑनबोर्डिंग यह कर सकती है)। - Non-interactive flags:
--model,--agent-dir,--bind,--non-interactive.
पूर्ण संदर्भ
विस्तृत step-by-step breakdowns और config outputs के लिए, देखें CLI Setup Reference. non-interactive उदाहरणों के लिए, देखें CLI Automation. गहरे तकनीकी संदर्भ के लिए, जिसमें RPC details शामिल हैं, देखें Onboarding Reference.
संबंधित docs
- CLI command reference:
openclaw onboard - Onboarding overview: Onboarding Overview
- macOS app onboarding: Onboarding
- Agent first-run ritual: Agent Bootstrapping