CLI-Einrichtungsreferenz

Diese Seite ist die vollständige Referenz für openclaw onboard. Die Kurz Anleitung finden Sie unter Onboarding (CLI).

# Was der Assistent macht

Der lokale Modus (Standard) führt Sie durch:

• Modell- und Auth-Einrichtung (OpenAI Code-Abonnement-OAuth, Anthropic Claude CLI oder API-Schlüssel sowie Optionen für MiniMax, GLM, Ollama, Moonshot, StepFun und AI Gateway)
• Workspace-Speicherort und Bootstrap-Dateien
• Gateway-Einstellungen (Port, Bind-Adresse, Auth, Tailscale)
• Kanäle und Provider (Telegram, WhatsApp, Discord, Google Chat, Mattermost, Signal, BlueBubbles und andere mitgelieferte Kanal-Plugins)
• Daemon-Installation (LaunchAgent, systemd-Benutzereinheit oder native Windows-Aufgabenplanung mit Startup-Ordner-Fallback)
• Zustandsprüfung
• Skills-Einrichtung

Der Remote-Modus konfiguriert diesen Computer so, dass er eine Verbindung zu einem Gateway an einem anderen Ort herstellt. Er installiert oder ändert nichts auf dem Remote-Host.

# Details zum lokalen Ablauf

# Details zum Remote-Modus

Der Remote-Modus konfiguriert diesen Computer so, dass er eine Verbindung zu einem Gateway an einem anderen Ort herstellt.

Was Sie festlegen:

• Remote-Gateway-URL (ws://...)
• Token, wenn Remote-Gateway-Auth erforderlich ist (empfohlen)

# Auth- und Modelloptionen

Modellverhalten:

• Standardmodell aus erkannten Optionen auswählen oder Provider und Modell manuell eingeben.
• Das Onboarding für benutzerdefinierte Provider leitet Bildunterstützung für gängige Modell-IDs ab und fragt nur, wenn der Modellname unbekannt ist.
• Wenn das Onboarding mit einer Provider-Auth-Auswahl startet, bevorzugt die Modellauswahl diesen Provider automatisch. Für Volcengine und BytePlus stimmt dieselbe Präferenz auch mit deren Coding-Plan-Varianten überein (volcengine-plan/*, byteplus-plan/*).
• Wenn dieser bevorzugte Provider-Filter leer wäre, fällt die Auswahl auf den vollständigen Katalog zurück, statt keine Modelle anzuzeigen.
• Der Assistent führt eine Modellprüfung aus und warnt, wenn das konfigurierte Modell unbekannt ist oder Auth fehlt.

Pfade für Zugangsdaten und Profile:

• Auth-Profile (API-Schlüssel + OAuth): ~/.openclaw/agents/<agentId>/agent/auth-profiles.json
• Legacy-OAuth-Import: ~/.openclaw/credentials/oauth.json

Speichermodus für Zugangsdaten:

• Das Standardverhalten des Onboardings speichert API-Schlüssel als Klartextwerte in Auth-Profilen.
• --secret-input-mode ref aktiviert den Referenzmodus anstelle der Klartext-Schlüsselspeicherung. In der interaktiven Einrichtung können Sie eines von beiden wählen:
  • Umgebungsvariablen-Ref (zum Beispiel keyRef: { source: "env", provider: "default", id: "OPENAI_API_KEY" })
  • konfigurierte Provider-Ref (file oder exec) mit Provider-Alias + ID
• Der interaktive Referenzmodus führt vor dem Speichern eine schnelle Preflight-Validierung aus.
  • Env-Refs: validiert Variablenname + nicht leeren Wert in der aktuellen Onboarding-Umgebung.
  • Provider-Refs: validiert Provider-Konfiguration und löst die angeforderte ID auf.
  • Wenn Preflight fehlschlägt, zeigt das Onboarding den Fehler an und lässt Sie es erneut versuchen.
• Im nicht interaktiven Modus ist --secret-input-mode ref nur env-gestützt.
  • Setzen Sie die Provider-Umgebungsvariable in der Prozessumgebung des Onboardings.
  • Inline-Schlüssel-Flags (zum Beispiel --openai-api-key) erfordern, dass diese Umgebungsvariable gesetzt ist; andernfalls schlägt das Onboarding schnell fehl.
  • Für benutzerdefinierte Provider speichert der nicht interaktive Modus ref models.providers.<id>.apiKey als { source: "env", provider: "default", id: "CUSTOM_API_KEY" }.
  • In diesem Fall eines benutzerdefinierten Providers erfordert --custom-api-key, dass CUSTOM_API_KEY gesetzt ist; andernfalls schlägt das Onboarding schnell fehl.
• Gateway-Auth-Zugangsdaten unterstützen in der interaktiven Einrichtung Klartext- und SecretRef-Optionen:
  • Token-Modus: Klartext-Token generieren/speichern (Standard) oder SecretRef verwenden.
  • Passwortmodus: Klartext oder SecretRef.
• Nicht interaktiver Token-SecretRef-Pfad: --gateway-token-ref-env <ENV_VAR>.
• Vorhandene Klartext-Einrichtungen funktionieren unverändert weiter.

# Ausgaben und Interna

Typische Felder in ~/.openclaw/openclaw.json:

• agents.defaults.workspace
• agents.defaults.skipBootstrap, wenn --skip-bootstrap übergeben wird
• agents.defaults.model / models.providers (wenn Minimax ausgewählt wurde)
• tools.profile (lokales Onboarding verwendet standardmäßig "coding", wenn nicht gesetzt; vorhandene explizite Werte bleiben erhalten)
• gateway.* (mode, bind, auth, tailscale)
• session.dmScope (lokales Onboarding setzt dies standardmäßig auf per-channel-peer, wenn nicht gesetzt; vorhandene explizite Werte bleiben erhalten)
• channels.telegram.botToken, channels.discord.token, channels.matrix.*, channels.signal.*, channels.imessage.*
• Kanal-Allowlists (Slack, Discord, Matrix, Microsoft Teams), wenn Sie während der Eingabeaufforderungen zustimmen (Namen werden nach Möglichkeit in IDs aufgelöst)
• skills.install.nodeManager
  • Das Flag setup --node-manager akzeptiert npm, pnpm oder bun.
  • Eine manuelle Konfiguration kann später weiterhin skills.install.nodeManager: "yarn" setzen.
• wizard.lastRunAt
• wizard.lastRunVersion
• wizard.lastRunCommit
• wizard.lastRunCommand
• wizard.lastRunMode

openclaw agents add schreibt agents.list[] und optionale bindings.

WhatsApp-Anmeldedaten werden unter ~/.openclaw/credentials/whatsapp/<accountId>/ abgelegt. Sitzungen werden unter ~/.openclaw/agents/<agentId>/sessions/ gespeichert.

Gateway-Assistent-RPC:

• wizard.start
• wizard.next
• wizard.cancel
• wizard.status

Clients (macOS-App und Control UI) können Schritte darstellen, ohne die Onboarding-Logik erneut zu implementieren.

Signal-Einrichtungsverhalten:

• Lädt das passende Release-Asset herunter
• Speichert es unter ~/.openclaw/tools/signal-cli/<version>/
• Schreibt channels.signal.cliPath in die Konfiguration
• JVM-Builds erfordern Java 21
• Native Builds werden verwendet, wenn verfügbar
• Windows verwendet WSL2 und folgt innerhalb von WSL dem Linux-signal-cli-Ablauf

# Zugehörige Dokumentation

• Onboarding-Hub: Onboarding (CLI)
• Automatisierung und Skripte: CLI-Automatisierung
• Befehlsreferenz: openclaw onboard