Onboarding (CLI)

Onboarding (CLI)

L’onboarding via CLI est la méthode recommandée pour configurer OpenClaw sur macOS, Linux ou Windows (via WSL2 ; fortement recommandé). Il configure une passerelle (Gateway) locale ou une connexion à une passerelle distante, ainsi que les canaux, les compétences et les valeurs par défaut de l’espace de travail dans un processus guidé unique.

openclaw onboard

Info

Première discussion la plus rapide : ouvrez l’interface de contrôle (aucune configuration de channel nécessaire). Exécutez

openclaw dashboard

et discutez dans le navigateur. Documentation :

Dashboard

.

Pour reconfigurer plus tard :

openclaw configure
openclaw agents add <name>

Note

--json

n’implique pas le mode non interactif. Pour les scripts, utilisez

--non-interactive

.

Tip

L’onboarding CLI comprend une étape de recherche Web où vous pouvez choisir un provider (Perplexity, Brave, Gemini, Grok ou Kimi) et coller votre clé API pour que l’agent puisse utiliser

web_search

. Vous pouvez également configurer cela ultérieurement avec

openclaw configure --section web

. Documentation :

Web tools

.

Démarrage rapide vs Avancé

L’onboarding commence par QuickStart (valeurs par défaut) ou Advanced (contrôle total).

QuickStart (défauts)Avancé (contrôle total)

• Gateway local (boucle locale) - Espace de travail par défaut (ou espace de travail existant) - Port du Gateway 18789 - Auth du CLI Token (auto‑généré, même en boucle locale) - Stratégie d’outil par défaut pour les nouvelles configurations locales : tools.profile: "coding" (le profil explicite existant est conservé) - Isolation des DM par défaut : l’onboarding local écrit session.dmScope: "per-channel-peer" si non défini. Détails : Référence de la configuration Tailscale - Exposition Telegram Désactivée - Les DM WhatsApp + WhatsApp sont par défaut sur allowlist (votre numéro de téléphone vous sera demandé)

• Expose chaque étape (mode, espace de travail, passerelle, canaux, démon, compétences).

Ce que configure l’onboarding

Le mode local (par défaut) vous guide à travers ces étapes :

1. Modèle/Auth — choisissez n’importe quel flux de fournisseur/authentification pris en charge (clé API, OAuth, ou jeton de configuration), y compris le Fournisseur Personnalisé (compatible OpenAI, compatible Anthropic, ou détection automatique Inconnue). Choisissez un modèle par défaut. Remarque de sécurité : si cet agent exécutera des outils ou traitera le contenu des webhooks/hooks, préférez le modèle le plus récent et le plus robuste disponible et gardez la stratégie d’outil stricte. Les niveaux plus faibles ou plus anciens sont plus faciles à injecter via des invites. Pour les exécutions non interactives, --secret-input-mode ref stocke des références basées sur des variables d’environnement dans les profils d’authentification au lieu des valeurs de clé API en clair. En mode non interactif ref, la variable d’environnement du fournisseur doit être définie ; le passage de drapeaux de clé en ligne sans cette variable d’environnement échoue rapidement. Dans les exécutions interactives, le choix du mode de référence secrète vous permet de pointer soit vers une variable d’environnement, soit vers une référence de fournisseur configurée (file ou exec), avec une validation préalable rapide avant l’enregistrement.
2. Workspace — Emplacement des fichiers de l’agent (par défaut ~/.openclaw/workspace). Initialise les fichiers d’amorçage.
3. Gateway — Port, adresse de liaison, mode d’authentification, exposition Tailscale. En mode jeton interactif, choisissez le stockage en texte clair par défaut ou optez pour SecretRef. Chemin SecretRef pour jeton non interactif : --gateway-token-ref-env <ENV_VAR>.
4. Channels — WhatsApp, Telegram, Discord, Google Chat, Mattermost, Signal, BlueBubbles ou iMessage.
5. Daemon — Installe un LaunchAgent (macOS) ou une unité utilisateur systemd (Linux/WSL2). Si l’authentification par jeton nécessite un jeton et que gateway.auth.token est géré par SecretRef, l’installation du démon le valide mais ne persiste pas le jeton résolu dans les métadonnées d’environnement du service de supervision. Si l’authentification par jeton nécessite un jeton et que le SecretRef du jeton configuré n’est pas résolu, l’installation du démon est bloquée avec des conseils exploitables. Si gateway.auth.token et gateway.auth.password sont tous deux configurés et que gateway.auth.mode est non défini, l’installation du démon est bloquée jusqu’à ce que le mode soit défini explicitement.
6. Health check — Démarre le Gateway et vérifie qu’il fonctionne.
7. Skills — Installe les compétences recommandées et les dépendances facultatives.

Note

Le fait de relancer l’onboarding ne supprime rien, sauf si vous choisissez explicitement Reset (ou si vous passez --reset). La CLI --reset concerne par défaut la configuration, les identifiants et les sessions ; utilisez --reset-scope full pour inclure l’espace de travail. Si la configuration n’est pas valide ou contient des clés héritées, l’onboarding vous demande d’exécuter d’abord openclaw doctor.

Le Remote mode ne configure que le client local pour se connecter à un Gateway situé ailleurs. Il n’installe ou ne modifie rien sur l’hôte distant.

Ajouter un autre agent

Utilisez openclaw agents add <name> pour créer un agent distinct avec son propre espace de travail, sessions et profils d’authentification. L’exécuter 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 descriptions détaillées étape par étape et les sorties de configuration, consultez Référence de la configuration CLI. Pour des exemples non interactifs, consultez Automatisation CLI. Pour la référence technique approfondie, incluant les détails RPC, consultez Référence de l’intégration.

Documentation connexe

• Référence de la commande CLI : openclaw onboard
• Aperçu de l’onboarding : Onboarding Overview
• onboarding de l’application macOS : Onboarding
• Agent first-run ritual: Agent Bootstrapping