Aller au contenu
OpenClaw Docs

Onboarding reference

Il s’agit de la référence complète pour openclaw onboardCLI. Pour une vue d’ensemble générale, consultez Onboarding (CLI).

Détails du flux (mode local)

Section intitulée « Détails du flux (mode local) »

  1. Détection de la configuration existante

    • Si ~/.openclaw/openclaw.json existe, choisissez Conserver les valeurs actuelles, Réviser et mettre à jour ou Réinitialiser avant la configuration.
    • Le fait de relancer l’onboarding ne supprime rien à moins que vous ne choisissiez explicitement Réinitialiser (ou que vous passiez --reset).
    • La CLI --reset par défaut est config+creds+sessions ; utilisez --reset-scope full pour également supprimer l’espace de travail.
    • Si la configuration n’est pas valide ou contient des clés obsolètes, l’assistant s’arrête et vous demande d’exécuter openclaw doctor avant de continuer.
    • La réinitialisation utilise trash (jamais rm) et propose des portées :
      • Configuration uniquement
      • Configuration + identifiants + sessions
      • Réinitialisation complète (supprime également l’espace de travail)

  2. Modèle/Auth

    • Clé API AnthropicAPI : utilise ANTHROPIC_API_KEY si elle est présente ou demande une clé, puis l’enregistre pour une utilisation par le démon.
    • Clé API AnthropicAPI : choix préféré de l’assistant Anthropic dans l’onboarding/configure.
    • Jeton de configuration Anthropic : toujours disponible dans l’onboarding/configure, bien que OpenClaw préfère désormais la réutilisation du CLI Claude lorsque cela est possible.
    • Abonnement Code OpenAI (Codex) (OAuth) : flux navigateur ; collez le code#state.
      • Définit agents.defaults.model sur openai/gpt-5.5 via le runtime Codex lorsque le modèle n’est pas défini ou qu’il est déjà de la famille OpenAI.
    • Abonnement Code OpenAI (Codex) (appareil associé) : flux d’association de navigateur avec un code d’appareil à courte durée de vie.
      • Définit agents.defaults.model sur openai/gpt-5.5 via le runtime Codex lorsque le modèle n’est pas défini ou qu’il est déjà de la famille OpenAI.
    • Clé API OpenAIAPI : utilise OPENAI_API_KEY si elle est présente ou demande une clé, puis la stocke dans les profils d’authentification.
      • Définit agents.defaults.model sur openai/gpt-5.5 lorsque le modèle n’est pas défini, openai/*, ou des références de modèle Codex héritées.
    • xAI (Grok) OAuth / clé API : se connecte avec xAI OAuth lorsque cette option est choisie, ou demande XAI_API_KEY sur le chemin de la clé API-key, et configure xAI en tant que fournisseur de modèle.
    • OpenCode : demande OPENCODE_API_KEY (ou OPENCODE_ZEN_API_KEY, obtenez-le sur https://opencode.ai/auth) et vous permet de choisir le catalogue Zen ou Go.
    • Ollama : propose d’abord Cloud + Local, Cloud uniquement, ou Local uniquement. Cloud only demande OLLAMA_API_KEY et utilise https://ollama.com ; les modes pris en charge par l’hôte demandent l’URL de base Ollama, découvrent les modèles disponibles et tirent automatiquement le modèle local sélectionné si nécessaire ; Cloud + Local vérifie également si cet hôte Ollama est connecté pour l’accès cloud.
    • Plus de détails : Ollama
    • Clé API : stocke la clé pour vous.
    • Vercel AI Gateway (proxy multi-modèle) : demande AI_GATEWAY_API_KEY.
    • Plus de détails : Vercel AI Gateway
    • Gateway IA Cloudflare : demande l’ID de compte, l’ID de Gateway et CLOUDFLARE_AI_GATEWAY_API_KEY.
    • Plus de détails : Gateway IA Cloudflare
    • MiniMax : la configuration est écrite automatiquement ; l’hébergement par défaut est MiniMax-M3. La configuration de la clé API utilise minimax/..., et la configuration OAuth utilise minimax-portal/....
    • Plus de détails : MiniMax
    • StepFun : la configuration est écrite automatiquement pour StepFun standard ou Step Plan sur les terminaux Chine ou mondiaux.
    • Le standard inclut actuellement step-3.5-flash, et Step Plan inclut également step-3.5-flash-2603.
    • Plus de détails : StepFun
    • Synthétique (compatible Anthropic) : demande SYNTHETIC_API_KEY.
    • Plus de détails : Synthétique
    • Moonshot (Kimi K2) : la configuration est écrite automatiquement.
    • Kimi Coding : la configuration est écrite automatiquement.
    • Plus de détails : Moonshot AI (Kimi + Kimi Coding)
    • Ignorer : aucune authentification configurée pour le moment.
    • Choisissez un modèle par défaut parmi les options détectées (ou entrez le fournisseur/modèle manuellement). Pour une meilleure qualité et un risque moindre d’injection par prompt, choisissez le modèle de la dernière génération le plus puissant disponible dans votre pile de fournisseurs.
    • L’onboarding exécute une vérification du modèle et avertit si le modèle configuré est inconnu ou s’il manque une authentification.
    • Le mode de stockage de la clé API par défaut correspond à des valeurs de profil d’authentification en texte brut. Utilisez --secret-input-mode ref pour stocker des références prises en charge par l’environnement à la place (par exemple keyRef: { source: "env", provider: "default", id: "OPENAI_API_KEY" }).
    • Les profils d’authentification résident dans `~/.openclaw/agents/

    /agent/auth-profiles.json(clés API + OAuth).~/.openclaw/credentials/oauth.json` est un import hérité en lecture seule. - Plus de détails : /concepts/oauth

  3. Espace de travail

    • ~/.openclaw/workspace par défaut (configurable).
    • Initialise les fichiers de l’espace de travail nécessaires au rituel d’amorçage de l’agent.
    • Guide complet de la disposition et de la sauvegarde de l’espace de travail : Espace de travail de l’agent

  4. GatewayGateway

    • Port, liaison, mode d’authentification, exposition Tailscale.
    • Recommandation d’authentification : conservez le Jeton (Token), même pour la boucle locale, afin que les clients WS locaux doivent s’authentifier.
    • En mode jeton, la configuration interactive offre :
      • Générer/stocker le jeton en texte brut (par défaut)
      • Utiliser SecretRef (optionnel)
      • Le démarrage rapide réutilise les SecretRefs existants gateway.auth.token sur les fournisseurs env, file et exec pour l’amorçage de la sonde/tableau de bord d’onboarding.
      • Si ce SecretRef est configuré mais ne peut pas être résolu, l’onboarding échoue tôt avec un message de correction clair au lieu de dégrader silencieusement l’authentification d’exécution.
    • En mode mot de passe, la configuration interactive prend également en charge le stockage en texte brut ou SecretRef.
    • Chemin SecretRef du jeton en mode non interactif : `—gateway-token-ref-env

    . - Nécessite une env var non vide dans l'environnement du processus d'onboarding. - Ne peut pas être combiné avec —gateway-token`. - Désactivez l’authentification uniquement si vous faites entièrement confiance à chaque processus local. - Les liaisons non boucle locale nécessitent toujours une authentification.

  5. Canaux

    • WhatsApp : connexion QR optionnelle.
    • Telegram : jeton de bot.
    • [Discord](/en/channels/discordGoogle Chat) : jeton de bot.
    • Google Chat : JSON de compte de service + audience webhook.
    • Mattermost (plugin) : jeton de bot + URL de base.
    • Signal : installation optionnelle de signal-cliiMessage + configuration du compte.
    • iMessage : chemin du imsg CLI + accès à la base de données Messages ; utilisez un wrapper SSH lorsque le Gateway s’exécute hors Mac.
    • Sécurité DM : la valeur par défaut est le jumelage. Le premier DM envoie un code ; approuvez via `openclaw pairing approve

    ` ou utilisez des listes d’autorisation.

Mode non interactif

Section intitulée « Mode non interactif »

Utilisez --non-interactive pour automatiser ou scripter l’onboarding :

Fenêtre de terminal
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

Ajoutez --json pour un résumé lisible par machine.

SecretRef du jeton Gateway en mode non interactif :

Fenêtre de terminal
export OPENCLAW_GATEWAY_TOKEN="your-token"
openclaw onboard --non-interactive \
  --mode local \
  --auth-choice skip \
  --gateway-auth token \
  --gateway-token-ref-env OPENCLAW_GATEWAY_TOKEN

--gateway-token et --gateway-token-ref-env sont mutuellement exclusifs.

Les exemples de commandes spécifiques aux fournisseurs se trouvent dans CLI Automation. Utilisez cette page de référence pour la sémantique des indicateurs et l’ordre des étapes.

Ajouter un agent (non-interactif)

Section intitulée « Ajouter un agent (non-interactif) »
Fenêtre de terminal
openclaw agents add work \
  --workspace ~/.openclaw/workspace-work \
  --model openai/gpt-5.5 \
  --bind whatsapp:biz \
  --non-interactive \
  --json

Assistant RPC Gateway

Section intitulée « Assistant RPC Gateway »

Le Gateway expose le flux d’onboarding via RPC (wizard.start, wizard.next, wizard.cancel, wizard.status). Les clients (application macOS, UI de contrôle) peuvent afficher les étapes sans réimplémenter la logique d’onboarding.

Configuration Signal (signal-cli)

Section intitulée « Configuration Signal (signal-cli) »

L’onboarding peut installer signal-cli depuis les versions GitHub :

  • Télécharge l’actif de version approprié.
  • Le stocke sous ~/.openclaw/tools/signal-cli/<version>/.
  • Écrit channels.signal.cliPath dans votre configuration.

Notes :

  • Les builds JVM nécessitent Java 21.
  • Les builds natifs sont utilisés lorsqu’ils sont disponibles.
  • Windows utilise WSL2 ; l’installation de signal-cli suit le flux Linux à l’intérieur de WSL.

Ce que l’assistant écrit

Section intitulée « Ce que l’assistant écrit »

Champs typiques dans ~/.openclaw/openclaw.json :

  • agents.defaults.workspace
  • agents.defaults.model / models.providers (si Minimax est choisi)
  • tools.profile (l’onboarding local par défaut est "coding" si non défini ; les valeurs explicites existantes sont conservées)
  • gateway.* (mode, bind, auth, tailscale)
  • session.dmScope (détails du comportement : CLI Setup Reference)
  • channels.telegram.botToken, channels.discord.token, channels.matrix.*, channels.signal.*, channels.imessage.*
  • Listes d’autorisation de canal (Slack/Discord/Matrix/Microsoft Teams) lorsque vous acceptez lors des invites (les noms sont résolus en ID lorsque cela est possible).
  • skills.install.nodeManager
    • setup --node-manager accepte npm, pnpm ou bun.
    • La configuration manuelle peut toujours utiliser yarn en définissant directement skills.install.nodeManager.
  • wizard.lastRunAt
  • wizard.lastRunVersion
  • wizard.lastRunCommit
  • wizard.lastRunCommand
  • wizard.lastRunMode

openclaw agents add écrit agents.list[] et l’optionnel bindings.

Les identifiants WhatsApp sont placés sous ~/.openclaw/credentials/whatsapp/<accountId>/. Les sessions sont stockées sous ~/.openclaw/agents/<agentId>/sessions/.

Certains canaux sont fournis sous forme de plugins. Lorsque vous en sélectionnez un lors de la configuration, l’onboarding vous invitera à l’installer (npm ou un chemin local) avant qu’il puisse être configuré.

Documentation connexe

Section intitulée « Documentation connexe »