* exec: mark runtime shell context in exec env * tests(exec): cover OPENCLAW_SHELL in gateway exec * tests(exec): cover OPENCLAW_SHELL in pty mode * acpx: mark runtime shell context for spawned process * tests(acpx): log OPENCLAW_SHELL in runtime fixture * tests(acpx): assert OPENCLAW_SHELL in runtime prompt * docs(env): document OPENCLAW_SHELL runtime markers * docs(exec): describe OPENCLAW_SHELL exec marker * docs(acp): document OPENCLAW_SHELL acp marker * docs(gateway): note OPENCLAW_SHELL for background exec * tui: tag local shell runs with OPENCLAW_SHELL * tests(tui): assert OPENCLAW_SHELL in local shell runner * acp client: tag spawned bridge env with OPENCLAW_SHELL * tests(acp): cover acp client OPENCLAW_SHELL env helper * docs(env): include acp-client and tui-local shell markers * docs(acp): document acp-client OPENCLAW_SHELL marker * docs(tui): document tui-local OPENCLAW_SHELL marker * exec: keep shell runtime env string-only for docker args * changelog: note OPENCLAW_SHELL runtime markers
5.2 KiB
summary, read_when, title
| summary | read_when | title | |||
|---|---|---|---|---|---|
| Where OpenClaw loads environment variables and the precedence order |
|
Environment Variables |
Environment variables
OpenClaw pulls environment variables from multiple sources. The rule is never override existing values.
Precedence (highest → lowest)
- Process environment (what the Gateway process already has from the parent shell/daemon).
.envin the current working directory (dotenv default; does not override).- Global
.envat~/.openclaw/.env(aka$OPENCLAW_STATE_DIR/.env; does not override). - Config
envblock in~/.openclaw/openclaw.json(applied only if missing). - Optional login-shell import (
env.shellEnv.enabledorOPENCLAW_LOAD_SHELL_ENV=1), applied only for missing expected keys.
If the config file is missing entirely, step 4 is skipped; shell import still runs if enabled.
Config env block
Two equivalent ways to set inline env vars (both are non-overriding):
{
env: {
OPENROUTER_API_KEY: "sk-or-...",
vars: {
GROQ_API_KEY: "gsk-...",
},
},
}
Shell env import
env.shellEnv runs your login shell and imports only missing expected keys:
{
env: {
shellEnv: {
enabled: true,
timeoutMs: 15000,
},
},
}
Env var equivalents:
OPENCLAW_LOAD_SHELL_ENV=1OPENCLAW_SHELL_ENV_TIMEOUT_MS=15000
Runtime-injected env vars
OpenClaw also injects context markers into spawned child processes:
OPENCLAW_SHELL=exec: set for commands run through theexectool.OPENCLAW_SHELL=acp: set for ACP runtime backend process spawns (for exampleacpx).OPENCLAW_SHELL=acp-client: set foropenclaw acp clientwhen it spawns the ACP bridge process.OPENCLAW_SHELL=tui-local: set for local TUI!shell commands.
These are runtime markers (not required user config). They can be used in shell/profile logic to apply context-specific rules.
Env var substitution in config
You can reference env vars directly in config string values using ${VAR_NAME} syntax:
{
models: {
providers: {
"vercel-gateway": {
apiKey: "${VERCEL_GATEWAY_API_KEY}",
},
},
},
}
See Configuration: Env var substitution for full details.
Secret refs vs ${ENV} strings
OpenClaw supports two env-driven patterns:
${VAR}string substitution in config values.- SecretRef objects (
{ source: "env", provider: "default", id: "VAR" }) for fields that support secrets references.
Both resolve from process env at activation time. SecretRef details are documented in Secrets Management.
Path-related env vars
| Variable | Purpose |
|---|---|
OPENCLAW_HOME |
Override the home directory used for all internal path resolution (~/.openclaw/, agent dirs, sessions, credentials). Useful when running OpenClaw as a dedicated service user. |
OPENCLAW_STATE_DIR |
Override the state directory (default ~/.openclaw). |
OPENCLAW_CONFIG_PATH |
Override the config file path (default ~/.openclaw/openclaw.json). |
Logging
| Variable | Purpose |
|---|---|
OPENCLAW_LOG_LEVEL |
Override log level for both file and console (e.g. debug, trace). Takes precedence over logging.level and logging.consoleLevel in config. Invalid values are ignored with a warning. |
OPENCLAW_HOME
When set, OPENCLAW_HOME replaces the system home directory ($HOME / os.homedir()) for all internal path resolution. This enables full filesystem isolation for headless service accounts.
Precedence: OPENCLAW_HOME > $HOME > USERPROFILE > os.homedir()
Example (macOS LaunchDaemon):
<key>EnvironmentVariables</key>
<dict>
<key>OPENCLAW_HOME</key>
<string>/Users/kira</string>
</dict>
OPENCLAW_HOME can also be set to a tilde path (e.g. ~/svc), which gets expanded using $HOME before use.