ऑनबोर्डिंग विज़ार्ड संदर्भ¶

यह openclaw onboard CLI विज़ार्ड के लिए पूर्ण संदर्भ है। For a high-level overview, see Onboarding Wizard.

फ़्लो विवरण (स्थानीय मोड)¶

- यदि ~/.openclaw/openclaw.json मौजूद है, तो Keep / Modify / Reset चुनें। - विज़ार्ड को दोबारा चलाने से कुछ भी मिटता नहीं है जब तक आप स्पष्ट रूप से Reset नहीं चुनते। (या --reset पास करें)। - यदि कॉन्फ़िग अमान्य है या उसमें लेगेसी कुंजियाँ हैं, तो विज़ार्ड रुक जाता है और पूछता है कि आगे बढ़ने से पहले आप openclaw doctor चलाएँ। - Reset में trash (कभी भी rm नहीं) का उपयोग होता है और यह निम्न विकल्प प्रदान करता है: - केवल कॉन्फ़िग - कॉन्फ़िग + क्रेडेंशियल्स + सेशन्स - Full reset (also removes workspace)
- Anthropic API key (recommended): uses ANTHROPIC_API_KEY if present or prompts for a key, then saves it for daemon use. - Anthropic OAuth (Claude Code CLI): on macOS the wizard checks Keychain item "Claude Code-credentials" (choose "Always Allow" so launchd starts don't block); on Linux/Windows it reuses ~/.claude/.credentials.json if present. - Anthropic token (paste setup-token): run claude setup-token on any machine, then paste the token (you can name it; blank = default). - OpenAI Code (Codex) सब्सक्रिप्शन (Codex CLI): यदि ~/.codex/auth.json मौजूद है, तो विज़ार्ड इसे पुनः उपयोग कर सकता है। - OpenAI Code (Codex) subscription (OAuth): browser flow; paste the code#state. - Sets agents.defaults.model to openai-codex/gpt-5.2 when model is unset or openai/*. - OpenAI API key: यदि मौजूद हो तो OPENAI_API_KEY का उपयोग करता है या कुंजी के लिए पूछता है, फिर इसे ~/.openclaw/.env में सहेजता है ताकि launchd इसे पढ़ सके। - xAI (Grok) API key: prompts for XAI_API_KEY and configures xAI as a model provider. - OpenCode Zen (multi-model proxy): prompts for OPENCODE_API_KEY (or OPENCODE_ZEN_API_KEY, get it at https://opencode.ai/auth). - API key: आपके लिए कुंजी सहेजता है। - Vercel AI Gateway (multi-model proxy): prompts for AI_GATEWAY_API_KEY. - More detail: Vercel AI Gateway - Cloudflare AI Gateway: prompts for Account ID, Gateway ID, and CLOUDFLARE_AI_GATEWAY_API_KEY. - More detail: Cloudflare AI Gateway - MiniMax M2.1: config is auto-written. - More detail: MiniMax - Synthetic (Anthropic-compatible): prompts for SYNTHETIC_API_KEY. - More detail: Synthetic - Moonshot (Kimi K2): config is auto-written. - Kimi Coding: config is auto-written. - More detail: Moonshot AI (Kimi + Kimi Coding) - Skip: no auth configured yet. - Pick a default model from detected options (or enter provider/model manually). - Wizard runs a model check and warns if the configured model is unknown or missing auth. - OAuth credentials live in ~/.openclaw/credentials/oauth.json; auth profiles live in ~/.openclaw/agents/<agentId>/agent/auth-profiles.json (API keys + OAuth). - अधिक विवरण: /concepts/oauth
हेडलेस/सर्वर सुझाव: ब्राउज़र वाली मशीन पर OAuth पूरा करें, फिर ~/.openclaw/credentials/oauth.json (या $OPENCLAW_STATE_DIR/credentials/oauth.json) को Gateway होस्ट पर कॉपी करें। - Default ~/.openclaw/workspace (configurable). - Seeds the workspace files needed for the agent bootstrap ritual. - पूर्ण वर्कस्पेस लेआउट + बैकअप मार्गदर्शिका: Agent workspace
- Port, bind, auth mode, tailscale exposure. - Auth recommendation: keep Token even for loopback so local WS clients must authenticate. - Disable auth only if you fully trust every local process. - Non‑loopback binds still require auth. - WhatsApp: optional QR login. - Telegram: bot token. - Discord: bot token. - Google Chat: service account JSON + webhook audience. - Mattermost (plugin): bot token + base URL. - Signal: optional signal-cli install + account config. - BlueBubbles: iMessage के लिए अनुशंसित; सर्वर URL + पासवर्ड + वेबहुक। - iMessage: लेगेसी imsg CLI पाथ + DB एक्सेस। - DM सुरक्षा: डिफ़ॉल्ट रूप से पेयरिंग। पहला DM एक कोड भेजता है; openclaw pairing approve के ज़रिए अनुमोदित करें के माध्यम से अनुमोदित करें या allowlists का उपयोग करें। </Step><code> या allowlists का उपयोग करें। - macOS: LaunchAgent - लॉग‑इन किया हुआ यूज़र सेशन आवश्यक; हेडलेस के लिए कस्टम LaunchDaemon उपयोग करें (शिप नहीं किया गया)। - Linux (और Windows via WSL2): systemd यूज़र यूनिट - विज़ार्ड loginctl enable-linger <user> के ज़रिए lingering सक्षम करने की कोशिश करता है ताकि लॉगआउट के बाद भी Gateway चालू रहे। - sudo के लिए पूछ सकता है (/var/lib/systemd/linger लिखता है); पहले बिना sudo के कोशिश करता है। - Runtime चयन: Node (अनुशंसित; WhatsApp/Telegram के लिए आवश्यक)। Bun अनुशंसित नहीं है। - Gateway शुरू करता है (यदि आवश्यक हो) और openclaw health चलाता है। - टिप: openclaw status --deep स्टेटस आउटपुट में गेटवे हेल्थ प्रोब जोड़ता है (पहुंच योग्य गेटवे आवश्यक)। - उपलब्ध स्किल्स पढ़ता है और आवश्यकताओं की जाँच करता है।

- आपको नोड मैनेजर चुनने देता है: npm / pnpm (bun अनुशंसित नहीं)। - वैकल्पिक डिपेंडेंसीज़ इंस्टॉल करता है (कुछ macOS पर Homebrew का उपयोग करती हैं)।

Non-interactive मोड¶

ऑनबोर्डिंग को स्वचालित या स्क्रिप्ट करने के लिए --non-interactive का उपयोग करें:

openclaw onboard --non-interactive \
  --mode local \
  --auth-choice apiKey \
  --anthropic-api-key "$ANTHROPIC_API_KEY" \
  --gateway-port 18789 \
  --gateway-bind loopback \
  --install-daemon \
  --daemon-runtime node \
  --skip-skills

मशीन‑पठनीय सारांश के लिए --json जोड़ें।

- सारांश + अगले कदम, जिनमें अतिरिक्त फीचर्स के लिए iOS/Android/macOS ऐप्स शामिल हैं।

bash openclaw onboard --non-interactive \ --mode local \ --auth-choice gemini-api-key \ --gemini-api-key "$GEMINI_API_KEY" \ --gateway-port 18789 \ --gateway-bind loopback bash openclaw onboard --non-interactive \ --mode local \ --auth-choice zai-api-key \ --zai-api-key "$ZAI_API_KEY" \ --gateway-port 18789 \ --gateway-bind loopback bash openclaw onboard --non-interactive \ --mode local \ --auth-choice ai-gateway-api-key \ --ai-gateway-api-key "$AI_GATEWAY_API_KEY" \ --gateway-port 18789 \ --gateway-bind loopback bash openclaw onboard --non-interactive \ --mode local \ --auth-choice cloudflare-ai-gateway-api-key \ --cloudflare-ai-gateway-account-id "your-account-id" \ --cloudflare-ai-gateway-gateway-id "your-gateway-id" \ --cloudflare-ai-gateway-api-key "$CLOUDFLARE_AI_GATEWAY_API_KEY" \ --gateway-port 18789 \ --gateway-bind loopback bash openclaw onboard --non-interactive \ --mode local \ --auth-choice moonshot-api-key \ --moonshot-api-key "$MOONSHOT_API_KEY" \ --gateway-port 18789 \ --gateway-bind loopback bash openclaw onboard --non-interactive \ --mode local \ --auth-choice synthetic-api-key \ --synthetic-api-key "$SYNTHETIC_API_KEY" \ --gateway-port 18789 \ --gateway-bind loopback bash openclaw onboard --non-interactive \ --mode local \ --auth-choice opencode-zen \ --opencode-zen-api-key "$OPENCODE_API_KEY" \ --gateway-port 18789 \ --gateway-bind loopback

एजेंट जोड़ें (non-interactive)¶

openclaw agents add work \
  --workspace ~/.openclaw/workspace-work \
  --model openai/gpt-5.2 \
  --bind whatsapp:biz \
  --non-interactive \
  --json

Gateway wizard RPC¶

यदि कोई GUI नहीं मिलता, तो विज़ार्ड ब्राउज़र खोलने के बजाय Control UI के लिए SSH पोर्ट‑फ़ॉरवर्ड निर्देश प्रिंट करता है। यदि Control UI एसेट्स गायब हैं, तो विज़ार्ड उन्हें बिल्ड करने की कोशिश करता है; फ़ॉलबैक pnpm ui:build है (UI डिपेंडेंसीज़ ऑटो‑इंस्टॉल करता है)।

Signal सेटअप (signal-cli)¶

विज़ार्ड GitHub releases से signal-cli इंस्टॉल कर सकता है:

• उपयुक्त release asset डाउनलोड करता है।
• इसे ~/.openclaw/tools/signal-cli/<version>/ के अंतर्गत संग्रहीत करता है।
• आपके विन्यास में channels.signal.cliPath लिखता है।

टिप्पणियाँ:

• JVM बिल्ड्स के लिए Java 21 आवश्यक है।
• जहाँ उपलब्ध हो, native बिल्ड्स का उपयोग किया जाता है।
• Windows WSL2 का उपयोग करता है; signal-cli इंस्टॉल WSL के भीतर Linux फ़्लो का पालन करता है।

विज़ार्ड क्या लिखता है¶

~/.openclaw/openclaw.json में सामान्य फ़ील्ड्स:

• agents.defaults.workspace
• agents.defaults.model / models.providers (यदि Minimax चुना गया हो)
• gateway.* (mode, bind, auth, tailscale)
• channels.telegram.botToken, channels.discord.token, channels.signal.*, channels.imessage.*
• जब आप प्रॉम्प्ट्स के दौरान ऑप्ट‑इन करते हैं, तब चैनल allowlists (Slack/Discord/Matrix/Microsoft Teams) (जहाँ संभव हो नाम IDs में रेज़ॉल्व होते हैं)।
• skills.install.nodeManager
• wizard.lastRunAt
• wizard.lastRunVersion
• wizard.lastRunCommit
• wizard.lastRunCommand
• wizard.lastRunMode

openclaw agents add agents.list[] और वैकल्पिक bindings लिखता है।

--json का मतलब नॉन‑इंटरएक्टिव मोड नहीं होता। स्क्रिप्ट्स के लिए --non-interactive (और --workspace) का उपयोग करें।

Gateway RPC के ज़रिए विज़ार्ड फ़्लो एक्सपोज़ करता है (wizard.start, wizard.next, wizard.cancel, wizard.status)। क्लाइंट्स (macOS ऐप, Control UI) ऑनबोर्डिंग लॉजिक को दोबारा इम्प्लीमेंट किए बिना स्टेप्स रेंडर कर सकते हैं।

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

• विज़ार्ड अवलोकन: Onboarding Wizard
• macOS ऐप ऑनबोर्डिंग: Onboarding
• Config संदर्भ: Gateway configuration
• प्रदाता: WhatsApp, Telegram, Discord, Google Chat, Signal, BlueBubbles (iMessage), iMessage (legacy)
• Skills: Skills, Skills config