​

Référence de configuration de la CLI

​

Ce que fait l’assistant

• La configuration du modèle et de l’authentification (abonnement OpenAI Code avec OAuth, Anthropic Claude CLI ou clé API, ainsi que les options MiniMax, GLM, Ollama, Moonshot, StepFun et AI Gateway)
• L’emplacement du workspace et les fichiers d’amorçage
• Les paramètres de la gateway (port, bind, auth, tailscale)
• Les canaux et fournisseurs (Telegram, WhatsApp, Discord, Google Chat, Mattermost, Signal, BlueBubbles et autres plugins de canal groupés)
• L’installation du démon (LaunchAgent, unité utilisateur systemd ou tâche planifiée Windows native avec repli vers le dossier Démarrage)
• La vérification d’état
• La configuration des Skills

​

Détails du flux local

​

Détails du mode distant

• URL de la gateway distante (ws://...)
• Jeton si l’authentification de la gateway distante est requise (recommandé)

​

Options d’authentification et de modèle

• Choisissez le modèle par défaut parmi les options détectées, ou saisissez manuellement le fournisseur et le modèle.
• Lorsque l’onboarding commence à partir d’un choix d’authentification de fournisseur, le sélecteur de modèle préfère automatiquement ce fournisseur. Pour Volcengine et BytePlus, cette 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é serait vide, le sélecteur revient au 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 si auth est manquant.

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

• Le comportement par défaut de l’onboarding conserve les clés API comme valeurs en texte brut dans les profils d’authentification.
• --secret-input-mode ref active le mode référence au lieu du stockage de clé en texte brut. Dans la configuration interactive, vous pouvez choisir :
  • 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 du fournisseur + id
• Le mode référence interactif exécute une validation préalable rapide avant l’enregistrement.
  • Références d’environnement : valide le nom de variable + la valeur non vide dans l’environnement actuel de l’onboarding.
  • Références 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 pris en charge avec 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 immédiatement.
  • Pour les fournisseurs personnalisés, le mode ref non interactif stocke models.providers.<id>.apiKey sous la forme { 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 immédiatement.
• Les identifiants d’authentification de la gateway prennent en charge les choix texte brut et SecretRef en configuration interactive :
  • Mode jeton : Générer/stocker un jeton en texte brut (par défaut) ou Utiliser SecretRef.
  • Mode mot de passe : texte brut ou SecretRef.
• Chemin SecretRef du jeton en mode non interactif : --gateway-token-ref-env <ENV_VAR>.
• Les configurations existantes en texte brut continuent de fonctionner sans changement.

​

Sorties et éléments internes

• agents.defaults.workspace
• agents.defaults.model / models.providers (si Minimax est choisi)
• tools.profile (l’onboarding local le définit par défaut sur "coding" s’il n’est pas défini ; les valeurs explicites existantes sont conservées)
• gateway.* (mode, bind, auth, tailscale)
• session.dmScope (l’onboarding local le définit par défaut sur per-channel-peer s’il n’est pas défini ; 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 activez cette option pendant les invites (les noms sont résolus en ID lorsque c’est possible)
• skills.install.nodeManager
  • L’indicateur setup --node-manager accepte npm, pnpm ou bun.
  • La configuration manuelle peut toujours définir skills.install.nodeManager: "yarn" plus tard.
• wizard.lastRunAt
• wizard.lastRunVersion
• wizard.lastRunCommit
• wizard.lastRunCommand
• wizard.lastRunMode

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

• 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 signal-cli à l’intérieur de WSL

​

Documentation associée

• Hub d’onboarding : Onboarding (CLI)
• Automatisation et scripts : Automatisation de la CLI
• Référence de commande : openclaw onboard