Référence de configuration de la CLI

Cette page est la référence complète pour openclaw onboard. Pour le guide court, consultez Onboarding (CLI).

# Ce que fait l’assistant

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

• Configuration du modèle et de l’authentification (OAuth d’abonnement OpenAI Code, CLI Anthropic Claude ou clé API, ainsi que les options MiniMax, GLM, Ollama, Moonshot, StepFun et AI Gateway)
• Emplacement de l’espace de travail et fichiers d’amorçage
• Paramètres du Gateway (port, liaison, authentification, Tailscale)
• Canaux et fournisseurs (Telegram, WhatsApp, Discord, Google Chat, Mattermost, Signal, BlueBubbles et autres plugins de canal groupés)
• Installation du daemon (LaunchAgent, unité utilisateur systemd ou tâche planifiée Windows native avec repli vers le dossier Startup)
• Contrôle d’intégrité
• Configuration des Skills

Le mode distant configure cette machine pour se connecter à un Gateway situé ailleurs. Il n’installe ni ne modifie rien sur l’hôte distant.

# Détails du flux local

# Détails du mode distant

Le mode distant configure cette machine pour se connecter à un Gateway situé ailleurs.

Ce que vous définissez :

• URL du Gateway distant (ws://...)
• Jeton si l’authentification du Gateway distant est requise (recommandé)

# Options d’authentification et de modèle

Comportement du modèle :

• Choisissez le modèle par défaut parmi les options détectées ou saisissez manuellement le fournisseur et le modèle.
• L’onboarding de fournisseur personnalisé déduit la prise en charge des images pour les ID de modèle courants et ne pose la question que lorsque le nom du modèle est inconnu.
• Lorsque l’onboarding démarre depuis un choix d’authentification de fournisseur, le sélecteur de modèle privilégie automatiquement ce fournisseur. Pour Volcengine et BytePlus, la même préférence correspond aussi à leurs variantes de plan de codage (volcengine-plan/*, byteplus-plan/*).
• Si ce filtre de fournisseur préféré était vide, le sélecteur se replie vers le catalogue complet au lieu de n’afficher aucun modèle.
• L’assistant exécute une vérification du modèle et avertit si le modèle configuré est inconnu ou s’il manque l’authentification.

Chemins des identifiants et des profils :

• Profils d’authentification (clés API + OAuth) : ~/.openclaw/agents/<agentId>/agent/auth-profiles.json
• Import OAuth hérité : ~/.openclaw/credentials/oauth.json

Mode de stockage des identifiants :

• Le comportement d’onboarding par défaut conserve les clés API comme valeurs en texte clair dans les profils d’authentification.
• --secret-input-mode ref active le mode référence au lieu du stockage des clés en texte clair. Dans la configuration interactive, vous pouvez choisir l’un ou l’autre :
  • référence de variable d’environnement (par exemple keyRef: { source: "env", provider: "default", id: "OPENAI_API_KEY" })
  • référence de fournisseur configuré (file ou exec) avec alias de fournisseur + id
• Le mode référence interactif exécute une validation préalable rapide avant l’enregistrement.
  • Réfs env : valide le nom de variable + valeur non vide dans l’environnement d’onboarding actuel.
  • Réfs de fournisseur : valide la configuration du fournisseur et résout l’id demandé.
  • Si la validation préalable échoue, l’onboarding affiche l’erreur et vous permet de réessayer.
• En mode non interactif, --secret-input-mode ref est uniquement adossé à l’environnement.
  • Définissez la variable d’environnement du fournisseur dans l’environnement du processus d’onboarding.
  • Les indicateurs de clé en ligne (par exemple --openai-api-key) exigent que cette variable d’environnement soit définie ; sinon l’onboarding échoue rapidement.
  • Pour les fournisseurs personnalisés, le mode non interactif ref stocke models.providers.<id>.apiKey comme { source: "env", provider: "default", id: "CUSTOM_API_KEY" }.
  • Dans ce cas de fournisseur personnalisé, --custom-api-key exige que CUSTOM_API_KEY soit défini ; sinon l’onboarding échoue rapidement.
• Les identifiants d’authentification du Gateway prennent en charge les choix texte clair et SecretRef dans la configuration interactive :
  • Mode jeton : Générer/stocker un jeton en texte clair (par défaut) ou Utiliser SecretRef.
  • Mode mot de passe : texte clair ou SecretRef.
• Chemin SecretRef de jeton non interactif : --gateway-token-ref-env <ENV_VAR>.
• Les configurations existantes en texte clair continuent de fonctionner sans changement.

# Sorties et éléments internes

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

• agents.defaults.workspace
• agents.defaults.skipBootstrap lorsque --skip-bootstrap est transmis
• agents.defaults.model / models.providers (si Minimax est choisi)
• tools.profile (l’intégration locale utilise par défaut "coding" lorsque cette valeur n’est pas définie ; les valeurs explicites existantes sont conservées)
• gateway.* (mode, bind, auth, tailscale)
• session.dmScope (l’intégration locale utilise par défaut per-channel-peer lorsque cette valeur n’est pas définie ; les valeurs explicites existantes sont conservées)
• channels.telegram.botToken, channels.discord.token, channels.matrix.*, channels.signal.*, channels.imessage.*
• Listes d’autorisation de canaux (Slack, Discord, Matrix, Microsoft Teams) lorsque vous les activez pendant les invites (les noms sont résolus en ID lorsque possible)
• skills.install.nodeManager
  • L’option setup --node-manager accepte npm, pnpm ou bun.
  • La configuration manuelle peut toujours définir skills.install.nodeManager: "yarn" ultérieurement.
• 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/.

RPC de l’assistant Gateway :

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

Les clients (application macOS et Control UI) peuvent afficher les étapes sans réimplémenter la logique d’intégration.

Comportement de configuration de Signal :

• Télécharge la ressource de version appropriée
• La stocke sous ~/.openclaw/tools/signal-cli/<version>/
• Écrit channels.signal.cliPath dans la configuration
• Les builds JVM nécessitent Java 21
• Les builds natifs sont utilisés lorsqu’ils sont disponibles
• Windows utilise WSL2 et suit le flux Linux de signal-cli dans WSL

# Docs associées

• Hub d’intégration : Intégration (CLI)
• Automatisation et scripts : Automatisation CLI
• Référence des commandes : openclaw onboard