Passer au contenu principal

Documentation Index

Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

Ceci est la référence complète pour openclaw onboard. Pour une vue d’ensemble, consultez Onboarding (CLI).

​
Détails du flux (mode local)

1

Détection de la configuration existante

  • Si ~/.openclaw/openclaw.json existe, choisissez Conserver les valeurs actuelles, Vérifier et mettre à jour ou Réinitialiser avant la configuration.
  • Relancer l’onboarding n’efface rien sauf si vous choisissez explicitement Réinitialiser (ou si vous passez --reset).
  • Le --reset de la CLI utilise par défaut config+creds+sessions ; utilisez --reset-scope full pour supprimer aussi l’espace de travail.
  • Si la configuration est invalide ou contient des clés héritées, 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 les périmètres suivants :
    • Configuration uniquement
    • Configuration + identifiants + sessions
    • Réinitialisation complète (supprime aussi l’espace de travail)
2

Modèle/Auth

  • Clé API Anthropic : utilise ANTHROPIC_API_KEY si elle est présente, ou demande une clé, puis l’enregistre pour l’utilisation par le daemon.
  • Clé API Anthropic : choix d’assistant Anthropic préféré dans l’onboarding/la configuration.
  • setup-token Anthropic : toujours disponible dans l’onboarding/la configuration, même si OpenClaw privilégie désormais la réutilisation de la CLI Claude lorsqu’elle est disponible.
  • Abonnement OpenAI Code (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 appartient déjà à la famille OpenAI.
  • Abonnement OpenAI Code (Codex) (appairage d’appareil) : flux d’appairage navigateur avec un code d’appareil de courte durée.
    • Définit agents.defaults.model sur openai/gpt-5.5 via le runtime Codex lorsque le modèle n’est pas défini ou appartient déjà à la famille OpenAI.
  • Clé API OpenAI : 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, est openai/* ou openai-codex/*.
  • Clé API xAI (Grok) : demande XAI_API_KEY et configure xAI comme fournisseur de modèles.
  • OpenCode : demande OPENCODE_API_KEY (ou OPENCODE_ZEN_API_KEY, à obtenir sur https://opencode.ai/auth) et vous laisse 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 adossés à un hôte demandent l’URL de base Ollama, découvrent les modèles disponibles et téléchargent automatiquement le modèle local sélectionné si nécessaire ; Cloud + Local vérifie aussi 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
  • Cloudflare AI Gateway : demande l’ID de compte, l’ID du Gateway et CLOUDFLARE_AI_GATEWAY_API_KEY.
  • Plus de détails : Cloudflare AI Gateway
  • MiniMax : la configuration est écrite automatiquement ; la valeur par défaut hébergée est MiniMax-M2.7. La configuration par 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 points de terminaison chinois ou mondiaux.
  • Standard inclut actuellement step-3.5-flash, et Step Plan inclut aussi step-3.5-flash-2603.
  • Plus de détails : StepFun
  • Synthetic (compatible Anthropic) : demande SYNTHETIC_API_KEY.
  • Plus de détails : Synthetic
  • 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 n’est encore configurée.
  • Choisissez un modèle par défaut parmi les options détectées (ou saisissez le fournisseur/modèle manuellement). Pour une qualité optimale et un risque d’injection de prompt plus faible, choisissez le modèle de dernière génération le plus puissant disponible dans votre pile fournisseur.
  • L’onboarding exécute une vérification du modèle et avertit si le modèle configuré est inconnu ou si l’authentification manque.
  • Le mode de stockage des clés API utilise par défaut des valeurs de profil d’authentification en texte clair. Utilisez --secret-input-mode ref pour stocker à la place des références adossées à l’environnement (par exemple keyRef: { source: "env", provider: "default", id: "OPENAI_API_KEY" }).
  • Les profils d’authentification se trouvent dans ~/.openclaw/agents/<agentId>/agent/auth-profiles.json (clés API + OAuth). ~/.openclaw/credentials/oauth.json sert uniquement à l’import hérité.
  • Plus de détails : /concepts/oauth
Astuce sans interface graphique/serveur : terminez OAuth sur une machine avec un navigateur, puis copiez le fichier auth-profiles.json de cet agent (par exemple ~/.openclaw/agents/<agentId>/agent/auth-profiles.json, ou le chemin $OPENCLAW_STATE_DIR/... correspondant) vers l’hôte du Gateway. credentials/oauth.json est seulement une source d’import héritée.
3

Espace de travail

  • Valeur par défaut ~/.openclaw/workspace (configurable).
  • Amorce les fichiers d’espace de travail nécessaires au rituel d’amorçage de l’agent.
  • Disposition complète de l’espace de travail + guide de sauvegarde : Espace de travail de l’agent
4

Gateway

  • Port, liaison, mode d’authentification, exposition Tailscale.
  • Recommandation d’authentification : conservez Jeton même pour le bouclage afin que les clients WS locaux doivent s’authentifier.
  • En mode jeton, la configuration interactive propose :
    • Générer/stocker un jeton en texte clair (par défaut)
    • Utiliser SecretRef (opt-in)
    • Le démarrage rapide réutilise les SecretRefs gateway.auth.token existants via les fournisseurs env, file et exec pour la sonde d’onboarding/l’amorçage du tableau de bord.
    • 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 du runtime.
  • En mode mot de passe, la configuration interactive prend aussi en charge le stockage en texte clair ou SecretRef.
  • Chemin SecretRef de jeton non interactif : --gateway-token-ref-env <ENV_VAR>.
    • Nécessite une variable d’environnement 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 hors bouclage nécessitent toujours une authentification.
5

Canaux

  • WhatsApp : connexion QR facultative.
  • Telegram : jeton de bot.
  • Discord : jeton de bot.
  • Google Chat : JSON de compte de service + audience du webhook.
  • Mattermost (plugin) : jeton de bot + URL de base.
  • Signal : installation facultative de signal-cli + configuration du compte.
  • iMessage : chemin de la CLI imsg + accès à la base de données Messages ; utilisez un wrapper SSH lorsque le Gateway s’exécute hors Mac.
  • Sécurité des DM : l’appairage est la valeur par défaut. Le premier DM envoie un code ; approuvez via openclaw pairing approve <channel> <code> ou utilisez des listes d’autorisation.
6

Recherche Web

  • Choisissez un fournisseur pris en charge, comme Brave, DuckDuckGo, Exa, Firecrawl, Gemini, Grok, Kimi, MiniMax Search, Ollama Web Search, Perplexity, SearXNG ou Tavily (ou ignorez cette étape).
  • Les fournisseurs adossés à une API peuvent utiliser des variables d’environnement ou la configuration existante pour une configuration rapide ; les fournisseurs sans clé utilisent plutôt leurs prérequis propres.
  • Ignorez avec --skip-search.
  • Configurer plus tard : openclaw configure --section web.
7

Installation du daemon

  • macOS : LaunchAgent
    • Nécessite une session utilisateur connectée ; pour le mode sans interface, utilisez un LaunchDaemon personnalisé (non fourni).
  • Linux (et Windows via WSL2) : unité utilisateur systemd
    • L’onboarding tente d’activer la persistance via loginctl enable-linger <user> afin que le Gateway reste actif après la déconnexion.
    • Peut demander sudo (écrit dans /var/lib/systemd/linger) ; il essaie d’abord sans sudo.
  • Sélection du runtime : Node (recommandé ; requis pour WhatsApp/Telegram). Bun n’est pas recommandé.
  • Si l’authentification par jeton nécessite un jeton et que gateway.auth.token est géré par SecretRef, l’installation du daemon le valide mais ne persiste pas les valeurs de jeton en texte clair résolues dans les métadonnées d’environnement du service superviseur.
  • Si l’authentification par jeton nécessite un jeton et que le SecretRef de jeton configuré n’est pas résolu, l’installation du daemon est bloquée avec des instructions exploitables.
  • Si gateway.auth.token et gateway.auth.password sont tous deux configurés et que gateway.auth.mode n’est pas défini, l’installation du daemon est bloquée jusqu’à ce que le mode soit défini explicitement.
8

Contrôle d’intégrité

  • Démarre le Gateway (si nécessaire) et exécute openclaw health.
  • Astuce : openclaw status --deep ajoute la sonde d’intégrité du gateway en direct à la sortie d’état, y compris les sondes de canaux lorsqu’elles sont prises en charge (nécessite un gateway joignable).
9

Skills (recommandé)

  • Lit les skills disponibles et vérifie les exigences.
  • Vous laisse choisir un gestionnaire de Node : npm / pnpm (bun non recommandé).
  • Installe les dépendances facultatives (certaines utilisent Homebrew sur macOS).
10

Terminer

  • Résumé + étapes suivantes, y compris l’invite Comment voulez-vous faire éclore votre agent ? pour Terminal, Navigateur ou plus tard.
Si aucune interface graphique n’est détectée, l’onboarding affiche des instructions de redirection de port SSH pour l’interface de contrôle au lieu d’ouvrir un navigateur. Si les ressources de l’interface de contrôle sont absentes, l’onboarding tente de les compiler ; la solution de repli est pnpm ui:build (installe automatiquement les dépendances de l’interface).

​
Mode non interactif

Utilisez --non-interactive pour automatiser ou scripter l’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
Ajoutez --json pour un résumé lisible par machine. SecretRef de jeton Gateway en mode non interactif : 
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 s’excluent mutuellement.
--json n’implique pas le mode non interactif. Utilisez --non-interactive (et --workspace) pour les scripts.
Des exemples de commandes propres aux fournisseurs se trouvent dans Automatisation CLI. Utilisez cette page de référence pour la sémantique des options et l’ordre des étapes.

​
Ajouter un agent (non interactif)

openclaw agents add work \
  --workspace ~/.openclaw/workspace-work \
  --model openai/gpt-5.5 \
  --bind whatsapp:biz \
  --non-interactive \
  --json

​
RPC de l’assistant Gateway

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

​
Configuration de Signal (signal-cli)

L’onboarding peut installer signal-cli depuis les versions GitHub :
  • Télécharge l’artefact 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

Champs typiques dans ~/.openclaw/openclaw.json :
  • agents.defaults.workspace
  • agents.defaults.model / models.providers (si Minimax est choisi)
  • tools.profile (l’onboarding local utilise par défaut "coding" lorsqu’il n’est pas défini ; les valeurs explicites existantes sont préservées)
  • gateway.* (mode, bind, auth, tailscale)
  • session.dmScope (détails du comportement : Référence de configuration CLI)
  • channels.telegram.botToken, channels.discord.token, channels.matrix.*, channels.signal.*, channels.imessage.*
  • Listes d’autorisation des canaux (Slack/Discord/Matrix/Microsoft Teams) lorsque vous les activez pendant les invites (les noms sont résolus en IDs lorsque c’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 les bindings facultatifs. 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 comme plugins. Lorsque vous en choisissez un pendant la configuration, l’onboarding vous invitera à l’installer (npm ou un chemin local) avant de pouvoir le configurer.

​
Documentation associée