For plaintext private-network ws:// targets (trusted networks only), set
OPENCLAW_ALLOW_INSECURE_PRIVATE_WS=1 in the onboarding process environment.Non-interactive custom provider:
--custom-base-url defaults to http://127.0.0.1:11434. --custom-model-id is optional; if omitted, onboarding uses Ollama’s suggested defaults. Cloud model IDs such as kimi-k2.5:cloud also work here.Store provider keys as refs instead of plaintext:
With --secret-input-mode ref, onboarding writes env-backed refs instead of plaintext key values.
For auth-profile backed providers this writes keyRef entries; for custom providers this writes models.providers.<id>.apiKey as an env ref (for example { source: "env", provider: "default", id: "CUSTOM_API_KEY" }).Non-interactive ref mode contract:
Set the provider env var in the onboarding process environment (for example OPENAI_API_KEY).
Do not pass inline key flags (for example --openai-api-key) unless that env var is also set.
If an inline key flag is passed without the required env var, onboarding fails fast with guidance.
Gateway token options in non-interactive mode:
--gateway-auth token --gateway-token <token> stores a plaintext token.
--gateway-auth token --gateway-token-ref-env <name> stores gateway.auth.token as an env SecretRef.
--gateway-token and --gateway-token-ref-env are mutually exclusive.
--gateway-token-ref-env requires a non-empty env var in the onboarding process environment.
With --install-daemon, when token auth requires a token, SecretRef-managed gateway tokens are validated but not persisted as resolved plaintext in supervisor service environment metadata.
With --install-daemon, if token mode requires a token and the configured token SecretRef is unresolved, onboarding fails closed with remediation guidance.
With --install-daemon, if both gateway.auth.token and gateway.auth.password are configured and gateway.auth.mode is unset, onboarding blocks install until mode is set explicitly.
Unless you pass --skip-health, onboarding waits for a reachable local gateway before it exits successfully.
--install-daemon starts the managed gateway install path first. Without it, you must already have a local gateway running, for example openclaw gateway run.
If you only want config/workspace/bootstrap writes in automation, use --skip-health.
On native Windows, --install-daemon tries Scheduled Tasks first and falls back to a per-user Startup-folder login item if task creation is denied.
Interactive onboarding behavior with reference mode:
Choose Use secret reference when prompted.
Then choose either:
Environment variable
Configured secret provider (file or exec)
Onboarding performs a fast preflight validation before saving the ref.
If validation fails, onboarding shows the error and lets you retry.
Non-interactive Z.AI endpoint choices:Note: --auth-choice zai-api-key now auto-detects the best Z.AI endpoint for your key (prefers the general API with zai/glm-5).
If you specifically want the GLM Coding Plan endpoints, pick zai-coding-global or zai-coding-cn.
Fastest first chat: openclaw dashboard (Control UI, no channel setup).
Custom Provider: connect any OpenAI or Anthropic compatible endpoint,
including hosted providers not listed. Use Unknown to auto-detect.
Common follow-up commands
openclaw configureopenclaw agents add <name>
--json does not imply non-interactive mode. Use --non-interactive for scripts.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"OpenClaw","description":"Self-hosted gateway that connects WhatsApp, Telegram, Discord, iMessage, and more to AI coding agents. Run a single Gateway process on your own machine and message your AI assistant from anywhere.","colors":{"primary":"#FF5A36","light":"#FF8A6B","dark":"#FF5A36"},"logo":{"light":"https://mintcdn.com/openclaw-kr/B73x02YIFtMp9Kvs/assets/pixel-lobster.svg?fit=max\u0026auto=format\u0026n=B73x02YIFtMp9Kvs\u0026q=85\u0026s=e434488dbd56bce8dbaf35572a6c600c","dark":"https://mintcdn.com/openclaw-kr/B73x02YIFtMp9Kvs/assets/pixel-lobster.svg?fit=max\u0026auto=format\u0026n=B73x02YIFtMp9Kvs\u0026q=85\u0026s=e434488dbd56bce8dbaf35572a6c600c"},"favicon":"/assets/pixel-lobster.svg","navbar":{"links":[{"icon":"github","href":"https://github.com/jakekwak/openclaw","label":"GitHub"},{"icon":"package","href":"https://github.com/openclaw/openclaw/releases","label":"Releases"},{"icon":"discord","href":"https://discord.com/invite/clawd","label":"Discord"}]},"fonts":{"heading":{"family":"DM Sans"},"body":{"family":"Fragment Mono"}},"icons":{"library":"lucide"},"styling":{"codeblocks":{"theme":{"light":"min-light","dark":"min-dark"}},"latex":true},"navigation":{"languages":[{"language":"ko","default":true,"href":"ko-KR"},{"language":"en","href":""},{"language":"zh-Hans","href":"zh-CN"},{"language":"ja","href":"ja-JP"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"openclaw-kr","hasAudioNarration":false,"actualSubdomain":"openclaw-kr","customDomains":["docs.openclaw.kr"],"gitSource":{"type":"github","owner":"jakekwak","repo":"openclaw","deployBranch":"korean","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae94808a0daa1d41e01b32e:success","clientVersion":"0.0.4248","searchFilterCounts":[{"language":"en","tag":"Reference","count":75},{"language":"zh-Hans","tag":"参考","count":65},{"language":"en","tag":"Tools \u0026 Plugins","count":61},{"language":"ko","tag":"참조","count":59},{"language":"en","tag":"Gateway \u0026 Ops","count":55},{"language":"ko","tag":"도구","count":54},{"language":"zh-Hans","tag":"工具","count":48},{"language":"en","tag":"CLI commands","count":47},{"language":"en","tag":"Models","count":41},{"language":"zh-Hans","tag":"CLI 命令","count":41},{"language":"ko","tag":"CLI commands","count":37},{"language":"ko","tag":"게이트웨이 및 운영","count":37},{"language":"zh-Hans","tag":"网关与运维","count":37},{"language":"en","tag":"Providers","count":36},{"language":"en","tag":"Gateway","count":34},{"language":"en","tag":"Channels","count":30},{"language":"ko","tag":"Gateway","count":28},{"language":"zh-Hans","tag":"消息渠道","count":28},{"language":"en","tag":"Install","count":27},{"language":"en","tag":"Tools","count":27},{"language":"ko","tag":"모델","count":26},{"language":"zh-Hans","tag":"网关","count":26},{"language":"zh-Hans","tag":"平台","count":26},{"language":"ko","tag":"플랫폼","count":24},{"language":"zh-Hans","tag":"模型","count":24},{"language":"ko","tag":"채널","count":23},{"language":"ko","tag":"설치","count":23},{"language":"ko","tag":"Providers","count":21},{"language":"zh-Hans","tag":"帮助","count":20},{"language":"zh-Hans","tag":"消息平台","count":20},{"language":"ja","tag":"はじめに","count":3},{"language":"ja","tag":"初回セットアップ","count":2},{"language":"ja","tag":"概要","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"#content>h1:first-of-type{display:none!important}.nav-tabs{position:relative}.nav-tabs-item>div{opacity:0}.nav-tabs-underline{position:absolute;left:0;bottom:0;height:1.5px;width:var(--nav-tab-underline-width, 0);transform:translateX(var(--nav-tab-underline-x, 0));background-color:rgb(var(--primary));border-radius:999px;pointer-events:none;opacity:0;transition:transform 260ms ease-in-out,\n width 260ms ease-in-out,\n opacity 160ms ease-in-out;will-change:transform, width}html.dark .nav-tabs-underline{background-color:rgb(var(--primary-light))}.nav-tabs-underline-ready .nav-tabs-underline{opacity:1}"}]}
{"page":{"pagePath":"cli/onboard","slug":"/cli/onboard","pageMetadata":{"summary":"CLI reference for `openclaw onboard` (interactive onboarding)","read_when":["You want guided setup for gateway, workspace, auth, channels, and skills"],"title":"onboard","description":null,"href":"/cli/onboard"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`1`,id:`openclaw-onboard`,children:_jsx(_components.code,{children:`openclaw onboard`})}),`\n`,_jsx(_components.p,{children:`Interactive onboarding for local or remote Gateway setup.`}),`\n`,_jsx(Heading,{level:`2`,id:`related-guides`,children:`Related guides`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`CLI onboarding hub: `,_jsx(_components.a,{href:`/start/wizard`,children:`Onboarding (CLI)`})]}),`\n`,_jsxs(_components.li,{children:[`Onboarding overview: `,_jsx(_components.a,{href:`/start/onboarding-overview`,children:`Onboarding Overview`})]}),`\n`,_jsxs(_components.li,{children:[`CLI onboarding reference: `,_jsx(_components.a,{href:`/start/wizard-cli-reference`,children:`CLI Setup Reference`})]}),`\n`,_jsxs(_components.li,{children:[`CLI automation: `,_jsx(_components.a,{href:`/start/wizard-cli-automation`,children:`CLI Automation`})]}),`\n`,_jsxs(_components.li,{children:[`macOS onboarding: `,_jsx(_components.a,{href:`/start/onboarding`,children:`Onboarding (macOS App)`})]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`examples`,children:`Examples`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes min-light min-dark`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#1f1f1f`,color:`#24292eff`,\"--shiki-dark\":`#b392f0`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`4`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#6F42C1`,\"--shiki-dark\":`#B392F0`},children:`openclaw`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` onboard`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#6F42C1`,\"--shiki-dark\":`#B392F0`},children:`openclaw`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` onboard`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` --flow`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` quickstart`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#6F42C1`,\"--shiki-dark\":`#B392F0`},children:`openclaw`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` onboard`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` --flow`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` manual`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#6F42C1`,\"--shiki-dark\":`#B392F0`},children:`openclaw`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` onboard`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` --mode`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` remote`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` --remote-url`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` wss://gateway-host:18789`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`For plaintext private-network `,_jsx(_components.code,{children:`ws://`}),` targets (trusted networks only), set\n`,_jsx(_components.code,{children:`OPENCLAW_ALLOW_INSECURE_PRIVATE_WS=1`}),` in the onboarding process environment.`]}),`\n`,_jsx(_components.p,{children:`Non-interactive custom provider:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`7`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes min-light min-dark`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#1f1f1f`,color:`#24292eff`,\"--shiki-dark\":`#b392f0`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`7`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#6F42C1`,\"--shiki-dark\":`#B392F0`},children:`openclaw`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` onboard`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` --non-interactive`}),_jsx(_components.span,{style:{color:`#24292EFF`,\"--shiki-dark\":`#B392F0`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` --auth-choice`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` custom-api-key`}),_jsx(_components.span,{style:{color:`#24292EFF`,\"--shiki-dark\":`#B392F0`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` --custom-base-url`}),_jsx(_components.span,{style:{color:`#22863A`,\"--shiki-dark\":`#FFAB70`},children:` \"https://llm.example.com/v1\"`}),_jsx(_components.span,{style:{color:`#24292EFF`,\"--shiki-dark\":`#B392F0`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` --custom-model-id`}),_jsx(_components.span,{style:{color:`#22863A`,\"--shiki-dark\":`#FFAB70`},children:` \"foo-large\"`}),_jsx(_components.span,{style:{color:`#24292EFF`,\"--shiki-dark\":`#B392F0`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` --custom-api-key`}),_jsx(_components.span,{style:{color:`#22863A`,\"--shiki-dark\":`#FFAB70`},children:` \"$CUSTOM_API_KEY\"`}),_jsx(_components.span,{style:{color:`#24292EFF`,\"--shiki-dark\":`#B392F0`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` --secret-input-mode`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` plaintext`}),_jsx(_components.span,{style:{color:`#24292EFF`,\"--shiki-dark\":`#B392F0`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` --custom-compatibility`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` openai`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`--custom-api-key`}),` is optional in non-interactive mode. If omitted, onboarding checks `,_jsx(_components.code,{children:`CUSTOM_API_KEY`}),`.`]}),`\n`,_jsx(_components.p,{children:`Non-interactive Ollama:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`5`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes min-light min-dark`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#1f1f1f`,color:`#24292eff`,\"--shiki-dark\":`#b392f0`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`5`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#6F42C1`,\"--shiki-dark\":`#B392F0`},children:`openclaw`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` onboard`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` --non-interactive`}),_jsx(_components.span,{style:{color:`#24292EFF`,\"--shiki-dark\":`#B392F0`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` --auth-choice`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` ollama`}),_jsx(_components.span,{style:{color:`#24292EFF`,\"--shiki-dark\":`#B392F0`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` --custom-base-url`}),_jsx(_components.span,{style:{color:`#22863A`,\"--shiki-dark\":`#FFAB70`},children:` \"http://ollama-host:11434\"`}),_jsx(_components.span,{style:{color:`#24292EFF`,\"--shiki-dark\":`#B392F0`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` --custom-model-id`}),_jsx(_components.span,{style:{color:`#22863A`,\"--shiki-dark\":`#FFAB70`},children:` \"qwen3.5:27b\"`}),_jsx(_components.span,{style:{color:`#24292EFF`,\"--shiki-dark\":`#B392F0`},children:` \\\\`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` --accept-risk`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`--custom-base-url`}),` defaults to `,_jsx(_components.code,{children:`http://127.0.0.1:11434`}),`. `,_jsx(_components.code,{children:`--custom-model-id`}),` is optional; if omitted, onboarding uses Ollama’s suggested defaults. Cloud model IDs such as `,_jsx(_components.code,{children:`kimi-k2.5:cloud`}),` also work here.`]}),`\n`,_jsx(_components.p,{children:`Store provider keys as refs instead of plaintext:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes min-light min-dark`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#1f1f1f`,color:`#24292eff`,\"--shiki-dark\":`#b392f0`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`4`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#6F42C1`,\"--shiki-dark\":`#B392F0`},children:`openclaw`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` onboard`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` --non-interactive`}),_jsx(_components.span,{style:{color:`#24292EFF`,\"--shiki-dark\":`#B392F0`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` --auth-choice`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` openai-api-key`}),_jsx(_components.span,{style:{color:`#24292EFF`,\"--shiki-dark\":`#B392F0`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` --secret-input-mode`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` ref`}),_jsx(_components.span,{style:{color:`#24292EFF`,\"--shiki-dark\":`#B392F0`},children:` \\\\`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` --accept-risk`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`With `,_jsx(_components.code,{children:`--secret-input-mode ref`}),`, onboarding writes env-backed refs instead of plaintext key values.\nFor auth-profile backed providers this writes `,_jsx(_components.code,{children:`keyRef`}),` entries; for custom providers this writes `,_jsx(_components.code,{children:`models.providers.\u003cid>.apiKey`}),` as an env ref (for example `,_jsx(_components.code,{children:`{ source: \"env\", provider: \"default\", id: \"CUSTOM_API_KEY\" }`}),`).`]}),`\n`,_jsxs(_components.p,{children:[`Non-interactive `,_jsx(_components.code,{children:`ref`}),` mode contract:`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`Set the provider env var in the onboarding process environment (for example `,_jsx(_components.code,{children:`OPENAI_API_KEY`}),`).`]}),`\n`,_jsxs(_components.li,{children:[`Do not pass inline key flags (for example `,_jsx(_components.code,{children:`--openai-api-key`}),`) unless that env var is also set.`]}),`\n`,_jsx(_components.li,{children:`If an inline key flag is passed without the required env var, onboarding fails fast with guidance.`}),`\n`]}),`\n`,_jsx(_components.p,{children:`Gateway token options in non-interactive mode:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`--gateway-auth token --gateway-token \u003ctoken>`}),` stores a plaintext token.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`--gateway-auth token --gateway-token-ref-env \u003cname>`}),` stores `,_jsx(_components.code,{children:`gateway.auth.token`}),` as an env SecretRef.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`--gateway-token`}),` and `,_jsx(_components.code,{children:`--gateway-token-ref-env`}),` are mutually exclusive.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`--gateway-token-ref-env`}),` requires a non-empty env var in the onboarding process environment.`]}),`\n`,_jsxs(_components.li,{children:[`With `,_jsx(_components.code,{children:`--install-daemon`}),`, when token auth requires a token, SecretRef-managed gateway tokens are validated but not persisted as resolved plaintext in supervisor service environment metadata.`]}),`\n`,_jsxs(_components.li,{children:[`With `,_jsx(_components.code,{children:`--install-daemon`}),`, if token mode requires a token and the configured token SecretRef is unresolved, onboarding fails closed with remediation guidance.`]}),`\n`,_jsxs(_components.li,{children:[`With `,_jsx(_components.code,{children:`--install-daemon`}),`, if both `,_jsx(_components.code,{children:`gateway.auth.token`}),` and `,_jsx(_components.code,{children:`gateway.auth.password`}),` are configured and `,_jsx(_components.code,{children:`gateway.auth.mode`}),` is unset, onboarding blocks install until mode is set explicitly.`]}),`\n`]}),`\n`,_jsx(_components.p,{children:`Example:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`7`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes min-light min-dark`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#1f1f1f`,color:`#24292eff`,\"--shiki-dark\":`#b392f0`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`7`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#D32F2F`,\"--shiki-dark\":`#F97583`},children:`export`}),_jsx(_components.span,{style:{color:`#24292EFF`,\"--shiki-dark\":`#B392F0`},children:` OPENCLAW_GATEWAY_TOKEN`}),_jsx(_components.span,{style:{color:`#D32F2F`,\"--shiki-dark\":`#F97583`},children:`=`}),_jsx(_components.span,{style:{color:`#22863A`,\"--shiki-dark\":`#FFAB70`},children:`\"your-token\"`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#6F42C1`,\"--shiki-dark\":`#B392F0`},children:`openclaw`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` onboard`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` --non-interactive`}),_jsx(_components.span,{style:{color:`#24292EFF`,\"--shiki-dark\":`#B392F0`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` --mode`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` local`}),_jsx(_components.span,{style:{color:`#24292EFF`,\"--shiki-dark\":`#B392F0`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` --auth-choice`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` skip`}),_jsx(_components.span,{style:{color:`#24292EFF`,\"--shiki-dark\":`#B392F0`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` --gateway-auth`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` token`}),_jsx(_components.span,{style:{color:`#24292EFF`,\"--shiki-dark\":`#B392F0`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` --gateway-token-ref-env`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` OPENCLAW_GATEWAY_TOKEN`}),_jsx(_components.span,{style:{color:`#24292EFF`,\"--shiki-dark\":`#B392F0`},children:` \\\\`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` --accept-risk`})}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`Non-interactive local gateway health:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`Unless you pass `,_jsx(_components.code,{children:`--skip-health`}),`, onboarding waits for a reachable local gateway before it exits successfully.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`--install-daemon`}),` starts the managed gateway install path first. Without it, you must already have a local gateway running, for example `,_jsx(_components.code,{children:`openclaw gateway run`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`If you only want config/workspace/bootstrap writes in automation, use `,_jsx(_components.code,{children:`--skip-health`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`On native Windows, `,_jsx(_components.code,{children:`--install-daemon`}),` tries Scheduled Tasks first and falls back to a per-user Startup-folder login item if task creation is denied.`]}),`\n`]}),`\n`,_jsx(_components.p,{children:`Interactive onboarding behavior with reference mode:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`Choose `,_jsx(_components.strong,{children:`Use secret reference`}),` when prompted.`]}),`\n`,_jsxs(_components.li,{children:[`Then choose either:`,`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Environment variable`}),`\n`,_jsxs(_components.li,{children:[`Configured secret provider (`,_jsx(_components.code,{children:`file`}),` or `,_jsx(_components.code,{children:`exec`}),`)`]}),`\n`]}),`\n`]}),`\n`,_jsxs(_components.li,{children:[`Onboarding performs a fast preflight validation before saving the ref.`,`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`If validation fails, onboarding shows the error and lets you retry.`}),`\n`]}),`\n`]}),`\n`]}),`\n`,_jsx(_components.p,{children:`Non-interactive Z.AI endpoint choices:`}),`\n`,_jsxs(_components.p,{children:[`Note: `,_jsx(_components.code,{children:`--auth-choice zai-api-key`}),` now auto-detects the best Z.AI endpoint for your key (prefers the general API with `,_jsx(_components.code,{children:`zai/glm-5`}),`).\nIf you specifically want the GLM Coding Plan endpoints, pick `,_jsx(_components.code,{children:`zai-coding-global`}),` or `,_jsx(_components.code,{children:`zai-coding-cn`}),`.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`9`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes min-light min-dark`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#1f1f1f`,color:`#24292eff`,\"--shiki-dark\":`#b392f0`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`9`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#C2C3C5`,\"--shiki-dark\":`#6B737C`},children:`# Promptless endpoint selection`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#6F42C1`,\"--shiki-dark\":`#B392F0`},children:`openclaw`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` onboard`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` --non-interactive`}),_jsx(_components.span,{style:{color:`#24292EFF`,\"--shiki-dark\":`#B392F0`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` --auth-choice`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` zai-coding-global`}),_jsx(_components.span,{style:{color:`#24292EFF`,\"--shiki-dark\":`#B392F0`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` --zai-api-key`}),_jsx(_components.span,{style:{color:`#22863A`,\"--shiki-dark\":`#FFAB70`},children:` \"$ZAI_API_KEY\"`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#C2C3C5`,\"--shiki-dark\":`#6B737C`},children:`# Other Z.AI endpoint choices:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#C2C3C5`,\"--shiki-dark\":`#6B737C`},children:`# --auth-choice zai-coding-cn`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#C2C3C5`,\"--shiki-dark\":`#6B737C`},children:`# --auth-choice zai-global`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#C2C3C5`,\"--shiki-dark\":`#6B737C`},children:`# --auth-choice zai-cn`})}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`Non-interactive Mistral example:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes min-light min-dark`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#1f1f1f`,color:`#24292eff`,\"--shiki-dark\":`#b392f0`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`3`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#6F42C1`,\"--shiki-dark\":`#B392F0`},children:`openclaw`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` onboard`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` --non-interactive`}),_jsx(_components.span,{style:{color:`#24292EFF`,\"--shiki-dark\":`#B392F0`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` --auth-choice`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` mistral-api-key`}),_jsx(_components.span,{style:{color:`#24292EFF`,\"--shiki-dark\":`#B392F0`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` --mistral-api-key`}),_jsx(_components.span,{style:{color:`#22863A`,\"--shiki-dark\":`#FFAB70`},children:` \"$MISTRAL_API_KEY\"`})]}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`Flow notes:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`quickstart`}),`: minimal prompts, auto-generates a gateway token.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`manual`}),`: full prompts for port/bind/auth (alias of `,_jsx(_components.code,{children:`advanced`}),`).`]}),`\n`,_jsxs(_components.li,{children:[`Local onboarding DM scope behavior: `,_jsx(_components.a,{href:`/start/wizard-cli-reference#outputs-and-internals`,children:`CLI Setup Reference`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`Fastest first chat: `,_jsx(_components.code,{children:`openclaw dashboard`}),` (Control UI, no channel setup).`]}),`\n`,_jsx(_components.li,{children:`Custom Provider: connect any OpenAI or Anthropic compatible endpoint,\nincluding hosted providers not listed. Use Unknown to auto-detect.`}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`common-follow-up-commands`,children:`Common follow-up commands`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes min-light min-dark`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#1f1f1f`,color:`#24292eff`,\"--shiki-dark\":`#b392f0`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#6F42C1`,\"--shiki-dark\":`#B392F0`},children:`openclaw`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` configure`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#6F42C1`,\"--shiki-dark\":`#B392F0`},children:`openclaw`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` agents`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` add`}),_jsx(_components.span,{style:{color:`#D32F2F`,\"--shiki-dark\":`#F97583`},children:` \u003c`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:`nam`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:`e`}),_jsx(_components.span,{style:{color:`#D32F2F`,\"--shiki-dark\":`#F97583`},children:`>`})]}),`\n`]})})}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`--json`}),` does not imply non-interactive mode. Use `,_jsx(_components.code,{children:`--non-interactive`}),` for scripts.`]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":{"theme":{"light":"min-light","dark":"min-dark"}},"config":{},"pageMetadata":{"summary":"CLI reference for `openclaw onboard` (interactive onboarding)","read_when":["You want guided setup for gateway, workspace, auth, channels, and skills"],"title":"onboard","description":null,"href":"/cli/onboard"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"openclaw onboard","slug":"openclaw-onboard","depth":1,"children":[]},{"title":"Related guides","slug":"related-guides","depth":2,"children":[]},{"title":"Examples","slug":"examples","depth":2,"children":[]},{"title":"Common follow-up commands","slug":"common-follow-up-commands","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/openclaw-kr/27fa1e35cfee10a0/nav-tabs-underline.js"],"subdomain":"openclaw-kr","siteName":"OpenClaw","title":"onboard - OpenClaw","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"ko":{"href":"/ko-KR","matchLevel":4},"en":{"href":"/cli/onboard","matchLevel":0},"zh-Hans":{"href":"/zh-CN/cli/onboard","matchLevel":1},"ja":{"href":"/ja-JP","matchLevel":4}}},"lastModified":"2026-03-23T13:36:44.323Z","originalFileLocation":"cli/onboard.md","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"OpenClaw\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/openclaw-kr/peKcUxWdKF2x2iDA/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/openclaw-kr/peKcUxWdKF2x2iDA/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/openclaw-kr/peKcUxWdKF2x2iDA/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/openclaw-kr/peKcUxWdKF2x2iDA/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/openclaw-kr/peKcUxWdKF2x2iDA/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/openclaw-kr/peKcUxWdKF2x2iDA/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/openclaw-kr/peKcUxWdKF2x2iDA/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/openclaw-kr/peKcUxWdKF2x2iDA/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/openclaw-kr/peKcUxWdKF2x2iDA/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"onboard - OpenClaw\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"OpenClaw\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.openclaw.kr/cli/onboard\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://openclaw-kr.mintlify.site/_mintlify/api/og/v2?division=Gateway+and+service\u0026amp;title=onboard\u0026amp;theme=f074cb351d13ab59f8ada668\u0026amp;signature=ab16d2a012af38bd513182cef1496e2e27cf023cc8ff9e66ee16f11c8a6de4f7\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"onboard - OpenClaw\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://openclaw-kr.mintlify.site/_mintlify/api/og/v2?division=Gateway+and+service\u0026amp;title=onboard\u0026amp;theme=f074cb351d13ab59f8ada668\u0026amp;signature=ab16d2a012af38bd513182cef1496e2e27cf023cc8ff9e66ee16f11c8a6de4f7\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/openclaw-kr/peKcUxWdKF2x2iDA/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"OpenClaw\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF5A36\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.openclaw.kr/cli/onboard\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/cli/onboard.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.openclaw.kr/cli/onboard\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"zh-Hans\" href=\"https://docs.openclaw.kr/zh-CN/cli/onboard\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.openclaw.kr/#organization\",\"name\":\"OpenClaw\",\"url\":\"https://docs.openclaw.kr\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/openclaw-kr/B73x02YIFtMp9Kvs/assets/pixel-lobster.svg?fit=max\u0026auto=format\u0026n=B73x02YIFtMp9Kvs\u0026q=85\u0026s=e434488dbd56bce8dbaf35572a6c600c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.openclaw.kr#website\",\"name\":\"OpenClaw\",\"url\":\"https://docs.openclaw.kr\",\"publisher\":{\"@id\":\"https://docs.openclaw.kr/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.openclaw.kr/cli/onboard#webpage\",\"url\":\"https://docs.openclaw.kr/cli/onboard\",\"name\":\"onboard\",\"dateModified\":\"2026-03-23T13:36:44.323Z\",\"isPartOf\":{\"@id\":\"https://docs.openclaw.kr#website\"},\"breadcrumb\":{\"@id\":\"https://docs.openclaw.kr/cli/onboard#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.openclaw.kr/cli/onboard#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"CLI commands\",\"item\":\"https://docs.openclaw.kr/cli\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Gateway and service\",\"item\":\"https://docs.openclaw.kr/cli/backup\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"onboard\",\"item\":\"https://docs.openclaw.kr/cli/onboard\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.openclaw.kr/cli/onboard#article\",\"headline\":\"onboard\",\"name\":\"onboard\",\"url\":\"https://docs.openclaw.kr/cli/onboard\",\"mainEntityOfPage\":{\"@id\":\"https://docs.openclaw.kr/cli/onboard#webpage\"},\"dateModified\":\"2026-03-23T13:36:44.323Z\",\"publisher\":{\"@id\":\"https://docs.openclaw.kr/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.openclaw.kr#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"OpenClaw\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"OpenClaw\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/cli/onboard.md","siteName":"OpenClaw","nav":{"global":null,"languages":[{"language":"ko","default":true,"pages":[{"title":"ko","href":"/ko-KR"}]},{"language":"en","tabs":[{"tab":"Get started","pages":[{"title":"Get started","href":""}]},{"tab":"Install","pages":[{"title":"Install","href":"/install"}]},{"tab":"Channels","pages":[{"title":"Channels","href":"/channels"}]},{"tab":"Agents","pages":[{"title":"Agents","href":"/concepts/architecture"}]},{"tab":"Tools \u0026 Plugins","pages":[{"title":"Tools \u0026 Plugins","href":"/tools"}]},{"tab":"Models","pages":[{"title":"Models","href":"/providers"}]},{"tab":"Platforms","pages":[{"title":"Platforms","href":"/platforms"}]},{"tab":"Gateway \u0026 Ops","pages":[{"title":"Gateway \u0026 Ops","href":"/gateway"}]},{"tab":"Reference","groups":[{"group":"CLI commands","pages":[{"title":"CLI Reference","href":"/cli"},{"group":"Gateway and service","pages":[{"title":"backup","href":"/cli/backup"},{"title":"daemon","href":"/cli/daemon"},{"title":"doctor","href":"/cli/doctor"},{"title":"gateway","href":"/cli/gateway"},{"title":"health","href":"/cli/health"},{"title":"logs","description":null,"href":"/cli/logs"},{"title":"onboard","href":"/cli/onboard"},{"title":"reset","description":null,"href":"/cli/reset"},{"title":"secrets","href":"/cli/secrets"},{"title":"security","href":"/cli/security"},{"title":"setup","href":"/cli/setup"},{"title":"status","href":"/cli/status"},{"title":"uninstall","href":"/cli/uninstall"},{"title":"update","href":"/cli/update"}]},{"group":"Agents and sessions","pages":[{"title":"agent","href":"/cli/agent"},{"title":"agents","href":"/cli/agents"},{"title":"hooks","href":"/cli/hooks"},{"title":"memory","href":"/cli/memory"},{"title":"message","href":"/cli/message"},{"title":"models","href":"/cli/models"},{"title":"sessions","href":"/cli/sessions"},{"title":"system","href":"/cli/system"}]},{"group":"Channels and messaging","pages":[{"title":"channels","href":"/cli/channels"},{"title":"devices","href":"/cli/devices"},{"title":"directory","href":"/cli/directory"},{"title":"pairing","href":"/cli/pairing"},{"title":"qr","href":"/cli/qr"},{"title":"voicecall","href":"/cli/voicecall"}]},{"group":"Tools and execution","pages":[{"title":"approvals","href":"/cli/approvals"},{"title":"browser","href":"/cli/browser"},{"title":"cron","href":"/cli/cron"},{"title":"node","href":"/cli/node"},{"title":"nodes","href":"/cli/nodes"},{"title":"Sandbox CLI","href":"/cli/sandbox"}]},{"group":"Configuration","pages":[{"title":"config","href":"/cli/config"},{"title":"configure","href":"/cli/configure"},{"title":"webhooks","href":"/cli/webhooks"}]},{"group":"Plugins and skills","pages":[{"title":"plugins","href":"/cli/plugins"},{"title":"skills","href":"/cli/skills"}]},{"group":"Interfaces","pages":[{"title":"dashboard","href":"/cli/dashboard"},{"title":"tui","href":"/cli/tui"}]},{"group":"Utility","pages":[{"title":"acp","href":"/cli/acp"},{"title":"clawbot","href":"/cli/clawbot"},{"title":"completion","href":"/cli/completion"},{"title":"dns","href":"/cli/dns"},{"title":"docs","href":"/cli/docs"}]}]},{"group":"RPC and API","pages":[{"title":"RPC Adapters","href":"/reference/rpc"},{"title":"Device Model Database","href":"/reference/device-models"}]},{"group":"Templates","pages":[{"title":"Default AGENTS.md","href":"/reference/AGENTS.default"},{"title":"AGENTS.md Template","href":"/reference/templates/AGENTS"},{"title":"BOOT.md Template","href":"/reference/templates/BOOT"},{"title":"BOOTSTRAP.md Template","href":"/reference/templates/BOOTSTRAP"},{"title":"HEARTBEAT.md Template","href":"/reference/templates/HEARTBEAT"},{"title":"IDENTITY Template","href":"/reference/templates/IDENTITY"},{"title":"SOUL.md Template","href":"/reference/templates/SOUL"},{"title":"TOOLS.md Template","href":"/reference/templates/TOOLS"},{"title":"USER Template","href":"/reference/templates/USER"}]},{"group":"Technical reference","pages":[{"title":"Pi Integration Architecture","href":"/pi"},{"title":"Onboarding Reference","sidebarTitle":"Onboarding Reference","href":"/reference/wizard"},{"title":"Token Use and Costs","href":"/reference/token-use"},{"title":"SecretRef Credential Surface","href":"/reference/secretref-credential-surface"},{"title":"Prompt Caching","href":"/reference/prompt-caching"},{"title":"API Usage and Costs","href":"/reference/api-usage-costs"},{"title":"Transcript Hygiene","href":"/reference/transcript-hygiene"},{"title":"Memory configuration reference","href":"/reference/memory-config"},{"title":"Date and Time","href":"/date-time"}]},{"group":"Concept internals","pages":[{"title":"TypeBox","href":"/concepts/typebox"},{"title":"Markdown Formatting","href":"/concepts/markdown-formatting"},{"title":"Typing Indicators","href":"/concepts/typing-indicators"},{"title":"Usage Tracking","href":"/concepts/usage-tracking"},{"title":"Timezones","href":"/concepts/timezone"}]},{"group":"Project","pages":[{"title":"Credits","href":"/reference/credits"}]},{"group":"Release policy","pages":[{"title":"Release Policy","href":"/reference/RELEASING"},{"title":"Tests","href":"/reference/test"}]}]},{"tab":"Help","pages":[{"title":"Help","href":"/help"}]}]},{"language":"zh-Hans","pages":[{"title":"zh-Hans","href":"/zh-CN/cli/onboard"}]},{"language":"ja","pages":[{"title":"ja","href":"/ja-JP"}]}]},"basePath":"","title":"onboard - OpenClaw","deploymentId":"dpl_2pTxFtyBudBMYZiCw1MyvoA1wxpd","buildId":"dpl_2pTxFtyBudBMYZiCw1MyvoA1wxpd","dynamics":[],"chunks":[]}