Reference for onboardingguide¶
Dette er den fulde reference for 'openclaw onboard' CLI guide. For en oversigt på højt niveau, se Onboardingguide.
Flow-detaljer (lokal tilstand)¶
~/.openclaw/openclaw.json findes, vælg Behold / Ændr / Nulstil.
- Genkørende guiden gør ikke tørre noget, medmindre du eksplicit vælger Nulstil
(eller pass --reset).
- Hvis config er ugyldig eller indeholder ældre nøgler, guiden stopper og beder
du at køre openclaw læge før du fortsætter.
- Nulstil bruger trash (aldrig rm) og tilbyder anvendelsesområder:
- Kun konfiguration
- Config + legitimationsoplysninger + sessioner
- Fuld nulstilling (også fjerner arbejdsområde)
ANTHROPIC_API_KEY hvis den er til stede eller beder om en nøgle, så gemmer den til brug af dæmonen.
- Antropisk OAuth (Claude Code CLI): på macOS kontrollerer guiden Keychain element "Claude Code-credentials" (vælg "Altid Tillad", så launchd begynder ikke at blokere) på Linux/Windows genbruger den ~/. laude/.credentials.json«, hvis de er til stede.
- **Anthropic token (paste setup-token)**: runclaude setup-tokenpå enhver maskine, derefter indsætte token (du kan navngive det; blank = standard).
- **OpenAI Code (Codex) abonnement (Codex CLI)**: hvis~/.codex/auth.jsonfindes, kan guiden genbruge den.
- **OpenAI Code (Codex) abonnement (OAuth)**: browser flow; indsætcode#state.
- Sætteragents.defaults.modeltilopenai-codex/gpt-5.2når modellen er frakoblet elleropenai/.
- **OpenAI API-nøgle**: brugerOPENAI_API_KEYhvis den er til stede eller beder om en nøgle, så gemmer den til~/.openclaw/.envså launchd kan læse den.
- **xAI (Grok) API-nøgle**: beder omXAI_API_KEYog konfigurerer xAI som modeludbyder.
- **OpenCode Zen (multi-model proxy)**: prompts forOPENCODE_API_KEY(ellerOPENCODE_ZEN_API_KEY, få det på https://opencode.ai/auth).
- **API-nøgle **: gemmer nøglen til dig.
- **Vercel AI Gateway (multi-model proxy)**: beder omAI_GATEWAY_API_KEY.
- Flere detaljer: [Vercel AI Gateway](/providers/vercel-ai-gateway)
- **Cloudflare AI Gateway**: prompts for Account ID, Gateway ID ogCLOUDFLARE_AI_GATEWAY_API_KEY.
- Flere detaljer: [Cloudflare AI Gateway](/providers/cloudflare-ai-gateway)
- **MiniMax M2.1**: konfiguration skrives automatisk.
- Flere detaljer: [MiniMax](/providers/minimax)
- **Syntetisk (Antropisk-kompatibel)**: beder omSYNTHETIC_API_KEY.
- Flere detaljer: [Synthetic](/providers/synthetic)
- **Moonshot (Kimi K2)**: konfiguration skrives automatisk.
- **Kimi kodning**: config er automatisk skrevet.
- Flere detaljer: [Moonshot AI (Kimi + Kimi Coding)](/providers/moonshot)
- **Skip**: ingen auth konfigureret endnu.
- Vælg en standardmodel fra fundne muligheder (eller indtaste udbyder/model manuelt).
- Guiden kører et modeltjek og advarer, hvis den konfigurerede model er ukendt eller mangler auth.
- OAuth legitimationsoplysninger bor i~/.openclaw/credentials/oauth.json; auth profiler live i~/.openclaw/agents/(API-nøgler + OAuth).
- Mere detaljer: [/concepts/oauth](/concepts/oauth)
<Note>
Tip til headless/server: gennemfør OAuth på en maskine med browser, og kopiér derefter~/.openclaw/credentials/oauth.json(eller$OPENCLAW_STATE_DIR/credentials/oauth.json) til
gateway-værten.
</Note>
</Step>
<Step title="Workspace">
- Standard~/.openclaw/workspace(konfigurerbar).
- Frø de nødvendige arbejdsrumsfiler til agenten bootstrap ritual.
- Fuld workspace-layout + backup-guide: [Agent workspace](/concepts/agent-workspace)
</Step>
<Step title="Gateway">
- Port, bind, auth mode, tailscale eksponering.
- Auth anbefaling: Behold **Token** selv for loopback så lokale WS kunder skal godkende.
- Deaktivér kun auth hvis du har fuld tillid til hver lokal proces.
- Ikke- loopback bindinger kræver stadig auth.
</Step>
<Step title="Channels">
- [WhatsApp](/channels/whatsapp): valgfri QR login.
- [Telegram](/channels/telegram): bot-token.
- [Discord](/channels/discord): bot-token.
- [Google Chat](/channels/googlechat): Tjenestekonto JSON + webhook publikum.
- [Mattermost](/channels/mattermost) (plugin): bot-token + basis-URL.
- [Signal](/channels/signal): valgfri installation afsignal-cli+ kontokonfiguration.
- [BlueBubbles](/channels/bluebubbles): **anbefales til iMessage**; server URL + password + webhook.
- [iMessage](/channels/imessage): arvimsgCLI sti + DB adgang.
- DM sikkerhed: standard er parring. Første DM sender en kode. Godkend viaopenclaw parring godkendelse eller brug tilladelseslister.
</Step><code> eller brug tilladelseslister.
loginctl enable-linger <user>', så Gateway forbliver op efter logout.
- Kan bede om sudo (skriv/var/lib/systemd/linger); den prøver uden sudo først.
- **Runtime selection:** Node (anbefalet; kræves for WhatsApp/Telegram). Bun er **anbefales ikke**.
</Step>
<Step title="Health check">
- Starts the Gateway (hvis nødvendigt) and runsopenclaw health.
- Tip:openclaw status --deep` tilføjer gateway sundhed sonder til status output (kræver en nås gateway).
pnpm ui:build (auto-installér UI deps).
Ikke-interaktiv tilstand¶
Brug --non-interactive til at automatisere eller scripte onboarding:
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
Tilføj --json for en maskinlæsbar opsummering.
--json betyder ikke betyder ikke-interaktiv tilstand. Brug --non-interactive (og --workspace) til scripts.
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
Tilføj agent (ikke-interaktiv)¶
openclaw agents add work \
--workspace ~/.openclaw/workspace-work \
--model openai/gpt-5.2 \
--bind whatsapp:biz \
--non-interactive \
--json
Gateway guide RPC¶
Gateway udsætter guiden flow over RPC (wizard.start, wizard.next, wizard.cancel, wizard.status).
Kunder (macOS app, Control UI) kan gøre trin uden genimplementering onboarding logik.
Signal-opsætning (signal-cli)¶
Guiden kan installere signal-cli fra GitHub-releases:
- Downloader det passende release-asset.
- Gemmer det under
~/.openclaw/tools/signal-cli/<version>/. - Skriver
channels.signal.cliPathtil din konfiguration.
Noter:
- JVM-builds kræver Java 21.
- Native builds bruges, når de er tilgængelige.
- Windows bruger WSL2; installation af signal-cli følger Linux-flowet inde i WSL.
Hvad guiden skriver¶
Typiske felter i ~/.openclaw/openclaw.json:
agents.defaults.workspaceagents.defaults.model/models.providers(hvis Minimax er valgt)gateway.*(tilstand, binding, auth, Tailscale)channels.telegram.botToken,channels.discord.token,channels.signal.*,channels.imessage.*- Kanal-tilladelseslister (Slack/Discord/Matrix/Microsoft Teams), når du tilvælger dem under prompts (navne opløses til ID’er, når det er muligt).
skills.install.nodeManagerwizard.lastRunAtwizard.lastRunVersionwizard.lastRunCommitwizard.lastRunCommandwizard.lastRunMode
openclaw agents add skriver agents.list[] og valgfri bindings.
WhatsApp legitimationsoplysninger går under ~/.openclaw/credentials/whatsapp/<accountId>/.
Sessioner opbevares under ~/.openclaw/agents/<agentId>/sessions/.
Nogle kanaler leveres som plugins. Når du vælger en under onboarding, vil guiden bede om at installere den (npm eller en lokal sti), før den kan konfigureres.
Relaterede dokumenter¶
- Overblik over guiden: Onboarding Wizard
- Onboarding i macOS-app: Onboarding
- Konfigurationsreference: Gateway configuration
- Udbydere: WhatsApp, Telegram, Discord, Google Chat, Signal, BlueBubbles (iMessage), iMessage (legacy)
- Færdigheder: Skills, Skills config