Aller au contenu

Variables d'environnement

OpenClaw récupère les variables d’environnement à partir de plusieurs sources. La règle est de ne jamais remplacer les valeurs existantes.

  1. Environnement de processus (ce que le processus Gateway possède déjà depuis le shell parent/daemon).
  2. .env dans le répertoire de travail actuel (dotenv par défaut ; ne pas écraser).
  3. .env global à ~/.openclaw/.env (alias $OPENCLAW_STATE_DIR/.env ; ne pas écraser).
  4. Bloc env de configuration dans ~/.openclaw/openclaw.json (appliqué uniquement si manquant).
  5. Import optionnel du shell de connexion (env.shellEnv.enabled ou OPENCLAW_LOAD_SHELL_ENV=1), appliqué uniquement pour les clés attendues manquantes.

Sur les installations fraîches d’Ubuntu qui utilisent le répertoire d’état par défaut, OpenClaw traite également ~/.config/openclaw/gateway.env comme un repli de compatibilité après le .env global. Si les deux fichiers existent et sont en désaccord, OpenClaw conserve ~/.openclaw/.env et imprime un avertissement.

Si le fichier de configuration est entièrement manquant, l’étape 4 est ignorée ; l’importation du shell s’exécute toujours si elle est activée.

Deux façons équivalentes de définir des env vars en ligne (aucune des deux n’est écrasante) :

{
env: {
OPENROUTER_API_KEY: "sk-or-...",
vars: {
GROQ_API_KEY: "gsk-...",
},
},
}

Le bloc env de configuration n’accepte que les valeurs de chaîne littérales. Il ne développe pas les valeurs file:... ; par exemple, XAI_API_KEY: "file:secrets/xai-api-key.txt" est passé aux fournisseurs sous forme de cette chaîne exacte.

Pour les clés de fournisseur sauvegardées par fichier, utilisez un SecretRef sur le champ d’identification qui le prend en charge :

{
secrets: {
providers: {
xai_key_file: {
source: "file",
path: "~/.openclaw/secrets/xai-api-key.txt",
mode: "singleValue",
},
},
},
models: {
providers: {
xai: {
apiKey: { source: "file", provider: "xai_key_file", id: "value" },
},
},
},
}

Voir Gestion des secrets et la surface d’identification SecretRef pour les champs pris en charge.

env.shellEnv exécute votre shell de connexion et importe uniquement les clés attendues manquantes :

{
env: {
shellEnv: {
enabled: true,
timeoutMs: 15000,
},
},
}

Équivalents de variables d’environnement :

  • OPENCLAW_LOAD_SHELL_ENV=1
  • OPENCLAW_SHELL_ENV_TIMEOUT_MS=15000

Variables d’environnement injectées lors de l’exécution

Section intitulée « Variables d’environnement injectées lors de l’exécution »

OpenClaw injecte également des marqueurs de contexte dans les processus enfants générés :

  • OPENCLAW_SHELL=exec : défini pour les commandes exécutées via l’outil exec.
  • OPENCLAW_SHELL=acp : défini pour les spawns de processus backend du runtime ACP (par exemple acpx).
  • OPENCLAW_SHELL=acp-client : défini pour openclaw acp client lorsqu’il génère le processus du pont ACP.
  • OPENCLAW_SHELL=tui-localTUI : défini pour les commandes shell ! de l’interface TUI locale.

Ce sont des marqueurs d’exécution (pas une configuration utilisateur requise). Ils peuvent être utilisés dans la logique de shell/profil pour appliquer des règles spécifiques au contexte.

  • OPENCLAW_THEME=lightTUI : force la palette claire de l’interface TUI lorsque votre terminal a un arrière-plan clair.
  • OPENCLAW_THEME=darkTUI : force la palette sombre de l’interface TUI.
  • COLORFGBGOpenClawTUI : si votre terminal l’exporte, OpenClaw utilise l’indication de couleur d’arrière-plan pour choisir automatiquement la palette de l’interface TUI.

Substitution de variables d’env dans la configuration

Section intitulée « Substitution de variables d’env dans la configuration »

Vous pouvez référencer des variables d’env directement dans les valeurs de chaîne de la configuration en utilisant la syntaxe ${VAR_NAME} :

{
models: {
providers: {
"vercel-gateway": {
apiKey: "${VERCEL_GATEWAY_API_KEY}",
},
},
},
}

Voir Configuration : Substitution de variables d’env pour plus de détails.

OpenClaw prend en charge deux modèles basés sur l’environnement :

  • Substitution de chaîne ${VAR} dans les valeurs de configuration.
  • Objets SecretRef ({ source: "env", provider: "default", id: "VAR" }) pour les champs qui prennent en charge les références aux secrets.

Les deux sont résolus à partir de l’environnement du processus au moment de l’activation. Les détails de SecretRef sont documentés dans Gestion des secrets. Le bloc de configuration env lui-même ne résout pas les SecretRefs ou les valeurs abrégées file:....

VariableObjet
OPENCLAW_HOMERemplace le répertoire personnel utilisé pour toute la résolution de chemin interne (~/.openclaw/OpenClaw, répertoires d’agents, sessions, informations d’identification). Utile lors de l’exécution d’OpenClaw en tant qu’utilisateur de service dédié.
OPENCLAW_STATE_DIRRemplace le répertoire d’état (par défaut ~/.openclaw).
OPENCLAW_CONFIG_PATHRemplace le chemin du fichier de configuration (par défaut ~/.openclaw/openclaw.json).
OPENCLAW_INCLUDE_ROOTSListe de chemins de répertoires où les directives $include peuvent résoudre des fichiers en dehors du répertoire de configuration (par défaut : aucun — $include est confiné au répertoire de config). Le tilde est développé.
VariableObjectif
OPENCLAW_LOG_LEVELRemplacer le niveau de journalisation pour les fichiers et la console (p. ex. debug, trace). A priorité sur logging.level et logging.consoleLevel dans la configuration. Les valeurs non valides sont ignorées avec un avertissement.
OPENCLAW_DEBUG_MODEL_TRANSPORTÉmettre des diagnostics de synchronisation ciblés des requêtes/réponses du modèle au niveau info sans activer les journaux de débogage globaux.
OPENCLAW_DEBUG_MODEL_PAYLOADDiagnostics de charge utile du modèle : summary, tools ou full-redacted. full-redacted est limité et masqué mais peut inclure le texte de l’invite/message.
OPENCLAW_DEBUG_SSEDiagnostics de streaming : events pour la synchronisation premier/dernier, peek pour inclure les cinq premiers événements SSE masqués.
OPENCLAW_DEBUG_CODE_MODEDiagnostics de surface de modèle en mode code, incluant le masquage des outils provider et l’application stricte de exécution/attente uniquement.

Lorsqu’elle est définie, OPENCLAW_HOME remplace le répertoire personnel système ($HOME / os.homedir()) pour toutes les résolutions de chemin internes. Cela permet une isolation complète du système de fichiers pour les comptes de service sans interface.

Priorité : OPENCLAW_HOME > $HOME > USERPROFILE > os.homedir()

Exemple (LaunchDaemon macOS) :

<key>EnvironmentVariables</key>
<dict>
<key>OPENCLAW_HOME</key>
<string>/Users/user</string>
</dict>

OPENCLAW_HOME peut également être défini sur un chemin avec tilde (p. ex. ~/svc), qui est développé en utilisant $HOME avant utilisation.

Si Node.js a été installé via nvm (et non via le gestionnaire de paquets du système), le fetch() intégré utilise le magasin de CA fourni avec nvm, qui peut manquer de CA racines modernes (ISRG Root X1/X2 pour Let’s Encrypt, DigiCert Global Root G2, etc.). Cela entraîne l’échec de web_fetch avec "fetch failed" sur la plupart des sites HTTPS.

Sur Linux, OpenClaw détecte automatiquement nvm et applique la correction dans l’environnement de démarrage réel :

  • openclaw gateway install écrit NODE_EXTRA_CA_CERTS dans l’environnement du service systemd
  • le point d’entrée openclaw de la CLI se relance lui-même avec NODE_EXTRA_CA_CERTS défini avant le démarrage de Node

Correction manuelle (pour les anciennes versions ou les lancements node ... directs) :

Exportez la variable avant de démarrer OpenClaw :

Fenêtre de terminal
export NODE_EXTRA_CA_CERTS=/etc/ssl/certs/ca-certificates.crt
openclaw gateway run

Ne comptez pas sur l’écriture uniquement dans ~/.openclaw/.env pour cette variable ; Node lit NODE_EXTRA_CA_CERTS au démarrage du processus.

OpenClaw lit uniquement les variables d’environnement OPENCLAW_*. Les préfixes hérités CLAWDBOT_* et MOLTBOT_* des versions précédentes sont silencieusement ignorés.

Si certaines sont toujours définies sur le processus Gateway au démarrage, OpenClaw émet un avertissement de dépréciation Node unique (OPENCLAW_LEGACY_ENV_VARS) listant les préfixes détectés et le nombre total. Renommez chaque valeur en remplaçant le préfixe hérité par OPENCLAW_ (par exemple CLAWDBOT_GATEWAY_TOKENOPENCLAW_GATEWAY_TOKEN) ; les anciens noms n’ont aucun effet.