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.

CLI onboarding est la méthode recommandée pour configurer OpenClaw sur macOS, Linux ou Windows (via WSL2 ; fortement recommandé). Elle configure un Gateway local ou une connexion à un Gateway distant, ainsi que les canaux, les Skills et les paramètres par défaut de l’espace de travail dans un seul flux guidé. 
openclaw onboard
Premier échange le plus rapide : ouvrez l’interface de contrôle (aucune configuration de canal nécessaire). Exécutez openclaw dashboard et discutez dans le navigateur. Docs : Tableau de bord.
Pour reconfigurer plus tard : 
openclaw configure
openclaw agents add <name>
--json n’implique pas le mode non interactif. Pour les scripts, utilisez --non-interactive.
CLI onboarding inclut une étape de recherche web où vous pouvez choisir un fournisseur tel que Brave, DuckDuckGo, Exa, Firecrawl, Gemini, Grok, Kimi, MiniMax Search, Ollama Web Search, Perplexity, SearXNG ou Tavily. Certains fournisseurs exigent une clé d’API, tandis que d’autres n’en nécessitent pas. Vous pouvez aussi configurer cela plus tard avec openclaw configure --section web. Docs : Outils web.

​
Démarrage rapide vs Avancé

L’onboarding commence par Démarrage rapide (paramètres par défaut) ou Avancé (contrôle complet).
  • Gateway local (loopback)
  • Espace de travail par défaut (ou espace de travail existant)
  • Port du Gateway 18789
  • Authentification du Gateway Token (généré automatiquement, même en loopback)
  • Politique d’outils par défaut pour les nouvelles configurations locales : tools.profile: "coding" (le profil explicite existant est conservé)
  • Isolation des MP par défaut : l’onboarding local écrit session.dmScope: "per-channel-peer" lorsqu’elle n’est pas définie. Détails : Référence de configuration CLI
  • Exposition Tailscale désactivée
  • Les MP Telegram + WhatsApp utilisent allowlist par défaut (votre numéro de téléphone vous sera demandé)

​
Ce que configure l’onboarding

Le mode local (par défaut) vous guide dans ces étapes :
  1. Modèle/Auth — choisissez n’importe quel fournisseur/flux d’authentification pris en charge (clé d’API, OAuth ou authentification manuelle propre au fournisseur), y compris Custom Provider (compatible OpenAI, compatible Anthropic ou auto-détection Unknown). Choisissez un modèle par défaut. Note de sécurité : si cet agent exécutera des outils ou traitera du contenu Webhook/hooks, préférez le modèle de dernière génération le plus robuste disponible et gardez une politique d’outils stricte. Les niveaux plus faibles/anciens sont plus faciles à soumettre à une injection de prompt. Pour les exécutions non interactives, --secret-input-mode ref stocke des références basées sur l’environnement dans les profils d’authentification au lieu de valeurs de clé d’API en texte clair. En mode non interactif ref, la variable d’environnement du fournisseur doit être définie ; transmettre des indicateurs de clé inline sans cette variable d’environnement échoue immédiatement. Dans les exécutions interactives, choisir le mode de référence secrète vous permet de pointer vers une variable d’environnement ou vers une référence de fournisseur configurée (file ou exec), avec une validation préliminaire rapide avant l’enregistrement. Pour Anthropic, l’onboarding/configuration interactif propose Anthropic Claude CLI comme chemin local préféré et Anthropic API key comme chemin de production recommandé. Anthropic setup-token reste également disponible comme chemin d’authentification par jeton pris en charge.
  2. Espace de travail — emplacement des fichiers de l’agent (par défaut ~/.openclaw/workspace). Amorçage des fichiers bootstrap.
  3. Gateway — port, adresse de liaison, mode d’authentification, exposition Tailscale. En mode jeton interactif, choisissez le stockage de jeton en texte clair par défaut ou optez pour SecretRef. Chemin SecretRef du jeton non interactif : --gateway-token-ref-env <ENV_VAR>.
  4. Canaux — canaux de discussion intégrés et groupés tels que iMessage, Discord, Feishu, Google Chat, Mattermost, Microsoft Teams, QQ Bot, Signal, Slack, Telegram, WhatsApp, et plus encore.
  5. Daemon — installe un LaunchAgent (macOS), une unité utilisateur systemd (Linux/WSL2) ou une tâche planifiée Windows native avec solution de repli par dossier de démarrage propre à l’utilisateur. Si l’authentification par jeton exige un jeton et que gateway.auth.token est géré par SecretRef, l’installation du daemon le valide mais ne persiste pas le jeton résolu dans les métadonnées d’environnement du service superviseur. Si l’authentification par jeton exige un jeton et que la SecretRef du jeton configurée n’est pas résolue, l’installation du daemon est bloquée avec des indications 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.
  6. Vérification d’état — démarre le Gateway et vérifie qu’il fonctionne.
  7. Skills — installe les Skills recommandées et les dépendances facultatives.
Relancer l’onboarding n’efface rien sauf si vous choisissez explicitement Réinitialiser (ou passez --reset). CLI --reset cible par défaut la configuration, les identifiants et les sessions ; utilisez --reset-scope full pour inclure l’espace de travail. Si la configuration est invalide ou contient des clés héritées, l’onboarding vous demande d’exécuter d’abord openclaw doctor.
Le mode distant configure uniquement le client local pour se connecter à un Gateway ailleurs. Il n’installe ni ne modifie rien sur l’hôte distant.

​
Ajouter un autre agent

Utilisez openclaw agents add <name> pour créer un agent séparé avec son propre espace de travail, ses sessions et ses profils d’authentification. Une exécution sans --workspace lance l’onboarding. Ce qu’il définit :
  • agents.list[].name
  • agents.list[].workspace
  • agents.list[].agentDir
Notes :
  • Les espaces de travail par défaut suivent ~/.openclaw/workspace-<agentId>.
  • Ajoutez bindings pour router les messages entrants (l’onboarding peut le faire).
  • Indicateurs non interactifs : --model, --agent-dir, --bind, --non-interactive.

​
Référence complète

Pour des explications détaillées étape par étape et les sorties de configuration, consultez Référence de configuration CLI. Pour des exemples non interactifs, consultez Automatisation CLI. Pour la référence technique plus approfondie, y compris les détails RPC, consultez Référence de l’onboarding.

​
Docs associées