CLI-Einrichtungsreferenz

Diese Seite beschreibt Schritt für Schritt das Onboarding-Verhalten, die Ausgaben und die internen Abläufe. Eine Anleitung finden Sie unter Onboarding (CLI). Die vollständige Referenz der CLI-Flags (alle --flag-Optionen, nicht interaktive Beispiele und providerspezifische Befehle) finden Sie unter openclaw onboard.

Funktionsweise des Assistenten

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

• Modell- und Authentifizierungseinrichtung (Anthropic, OAuth für das OpenAI-Code-Abonnement, xAI, OpenCode, benutzerdefinierte Endpunkte und weitere providerseitige Authentifizierungsabläufe)
• Workspace-Speicherort und Bootstrap-Dateien
• Gateway-Einstellungen (Port, Bindung, Authentifizierung, Tailscale)
• Kanäle und Provider (Discord, Feishu, Google Chat, iMessage, Mattermost, Microsoft Teams, QQ Bot, Signal, Slack, Telegram, WhatsApp und andere gebündelte oder Plugin-Kanäle)
• Provider für die Websuche (optional)
• Daemon-Installation (LaunchAgent, systemd-Benutzereinheit oder native geplante Windows-Aufgabe mit Ausweichlösung über den Autostartordner)
• Integritätsprüfung
• Einrichtung der Skills

Der Remote-Modus konfiguriert diesen Rechner für die Verbindung mit einem Gateway an einem anderen Ort. Er installiert oder ändert nichts auf dem Remote-Host.

Details zum lokalen Ablauf

Details zum Remote-Modus

Der Remote-Modus konfiguriert diesen Rechner für die Verbindung mit einem Gateway an einem anderen Ort. Er installiert oder ändert nichts auf dem Remote-Host.

Ihre Einstellungen:

• Remote-Gateway-URL (ws://... oder wss://...)
• Token, Passwort oder keine Authentifizierung, entsprechend der Konfiguration des Remote-Gateways

Authentifizierungs- und Modelloptionen

Wenn ein Schritt zur Provider-Einrichtung beim interaktiven Onboarding fehlschlägt (beispielsweise eine Option zur Wiederverwendung der CLI ohne lokale Anmeldung), zeigt der Assistent den Fehler an und kehrt zur Providerauswahl zurück, anstatt beendet zu werden. Explizite Ausführungen mit --auth-choice schlagen für Automatisierungen weiterhin sofort fehl.

Modellverhalten:

• Wählen Sie das Standardmodell aus den erkannten Optionen aus oder geben Sie Provider und Modell manuell ein.
• Wenn die Ersteinrichtung mit der Auswahl einer Provider-Authentifizierung beginnt, bevorzugt die Modellauswahl automatisch diesen Provider. Bei Volcengine und BytePlus umfasst diese Präferenz auch deren Coding-Plan-Varianten (volcengine-plan/*, byteplus-plan/*).
• Wenn dieser Filter für den bevorzugten Provider keine Ergebnisse liefern würde, greift die Auswahl auf den vollständigen Katalog zurück, statt keine Modelle anzuzeigen.
• Der Assistent führt eine Modellprüfung durch und warnt, wenn das konfigurierte Modell unbekannt ist oder die Authentifizierung fehlt.

Pfade für Anmeldedaten und Profile:

• Authentifizierungsprofile (API-Schlüssel + OAuth): ~/.openclaw/agents/<agentId>/agent/auth-profiles.json
• Import von älterem OAuth: ~/.openclaw/credentials/oauth.json

Speichermodus für Anmeldedaten:

• Standardmäßig speichert die Ersteinrichtung API-Schlüssel als Klartextwerte in Authentifizierungsprofilen.
• --secret-input-mode ref aktiviert den Referenzmodus anstelle der Speicherung von Schlüsseln im Klartext. Bei der interaktiven Einrichtung können Sie zwischen Folgendem wählen:
  • Umgebungsvariablenreferenz (zum Beispiel keyRef: { source: "env", provider: "default", id: "OPENAI_API_KEY" })
  • konfigurierte Provider-Referenz (file oder exec) mit Provider-Alias und ID
• Der interaktive Referenzmodus führt vor dem Speichern eine schnelle Vorabvalidierung durch.
  • Umgebungsreferenzen: Überprüft den Variablennamen und einen nicht leeren Wert in der aktuellen Ersteinrichtungsumgebung.
  • Provider-Referenzen: Überprüft die Provider-Konfiguration und löst die angeforderte ID auf.
  • Wenn die Vorabvalidierung fehlschlägt, zeigt die Ersteinrichtung den Fehler an und ermöglicht einen erneuten Versuch.
• Im nicht interaktiven Modus wird --secret-input-mode ref ausschließlich durch Umgebungsvariablen unterstützt.
  • Legen Sie die Provider-Umgebungsvariable in der Prozessumgebung der Ersteinrichtung fest.
  • Direkte Schlüssel-Flags (zum Beispiel --openai-api-key) setzen voraus, dass diese Umgebungsvariable festgelegt ist; andernfalls bricht die Ersteinrichtung sofort ab.
  • Bei benutzerdefinierten Providern speichert der nicht interaktive Modus ref den Wert models.providers.<id>.apiKey als { source: "env", provider: "default", id: "CUSTOM_API_KEY" }.
  • In diesem Fall eines benutzerdefinierten Providers setzt --custom-api-key voraus, dass CUSTOM_API_KEY festgelegt ist; andernfalls bricht die Ersteinrichtung sofort ab.
• Gateway-Authentifizierungsdaten unterstützen bei der interaktiven Einrichtung Klartext- und SecretRef-Optionen:
  • Token-Modus: Klartext-Token generieren/speichern (Standard) oder SecretRef verwenden.
  • Passwortmodus: Klartext oder SecretRef.
• Nicht interaktiver SecretRef-Pfad für Token: --gateway-token-ref-env <ENV_VAR>.
• Bestehende 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 (bei lokaler Ersteinrichtung standardmäßig "coding", wenn nicht festgelegt; vorhandene explizite Werte bleiben erhalten)
• gateway.* (Modus, Bindung, Authentifizierung, Tailscale)
• session.dmScope (bei lokaler Ersteinrichtung standardmäßig per-channel-peer, wenn nicht festgelegt; vorhandene explizite Werte bleiben erhalten)
• channels.telegram.botToken, channels.discord.token, channels.matrix.*, channels.signal.*, channels.imessage.*
• Kanal-Zulassungslisten (Discord, iMessage, Signal, Slack, Telegram, WhatsApp), wenn Sie diese während der Eingabeaufforderungen aktivieren; Discord und Slack lösen eingegebene Namen außerdem in IDs auf
• skills.install.nodeManager
  • Das Flag setup --node-manager akzeptiert npm, pnpm oder bun.
  • Bei manueller Konfiguration kann später weiterhin skills.install.nodeManager: "yarn" festgelegt werden.
• wizard.lastRunAt
• wizard.lastRunVersion
• wizard.lastRunCommit
• wizard.lastRunCommand
• wizard.lastRunMode
• wizard.securityAcknowledgedAt

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

WhatsApp-Anmeldedaten werden unter ~/.openclaw/credentials/whatsapp/<accountId>/ gespeichert. Aktive Sitzungen und Transkripte werden in ~/.openclaw/agents/<agentId>/agent/openclaw-agent.sqlite gespeichert. Das Verzeichnis ~/.openclaw/agents/<agentId>/sessions/ wird für Eingaben älterer Migrationen und Archiv-/Supportartefakte verwendet.

Nicht interaktive Einrichtung

--non-interactive erfordert --accept-risk (bestätigt, dass Agenten leistungsfähig sind und vollständiger Systemzugriff riskant ist):

openclaw onboard --non-interactive --accept-risk \  --auth-choice apiKey \  --anthropic-api-key "$ANTHROPIC_API_KEY"

Vollständige Flag-Referenz und providerspezifische Beispiele: openclaw onboard, CLI-Automatisierung.

Gateway-Assistent-RPC

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

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

Verhalten bei der Signal-Einrichtung

• Lädt das passende Release-Artefakt aus den offiziellen GitHub-Releases von signal-cli herunter (nativer Build, nur Linux x86-64)
• Auf anderen Plattformen (macOS, Linux ohne x64) erfolgt die Installation stattdessen über Homebrew
• Speichert die Installation des Release-Artefakts unter ~/.openclaw/tools/signal-cli/<version>/
• Schreibt channels.signal.cliPath in die Konfiguration
• Natives Windows wird noch nicht unterstützt; führen Sie die Ersteinrichtung innerhalb von WSL2 aus, um den Linux-Installationspfad zu erhalten

Verwandte Dokumentation

• Ersteinrichtungsübersicht: Ersteinrichtung (CLI)
• Automatisierung und Skripte: CLI-Automatisierung
• Befehlsreferenz: openclaw onboard