环境与调试

环境变量

OpenClaw 从多个来源拉取环境变量。规则是绝不覆盖现有值。 工作区 .env 文件是信任级别较低的来源:OpenClaw 会在应用优先级之前,忽略工作区 .env 中的提供商凭证和受保护的运行时控制项。

优先级(从最高到最低)

  1. 进程环境(Gateway 网关进程已经从父级 shell/守护进程继承的内容)。
  2. 当前工作目录中的 .env(dotenv 默认行为;不覆盖;提供商凭证和受保护的运行时控制项会被忽略)。
  3. 全局 .env,位于 ~/.openclaw/.env(也称 $OPENCLAW_STATE_DIR/.env;建议用于提供商 API key;不覆盖)。
  4. 配置 env,位于 ~/.openclaw/openclaw.json(仅在缺失时应用)。
  5. 可选的登录 shell 导入env.shellEnv.enabledOPENCLAW_LOAD_SHELL_ENV=1),仅对缺失的预期键名应用。

在使用默认状态目录的全新 Ubuntu 安装上,OpenClaw 还会在全局 .env 之后,将 ~/.config/openclaw/gateway.env 视为兼容性回退。如果两个文件都存在且内容不一致,OpenClaw 会保留 ~/.openclaw/.env 并打印警告。

如果配置文件完全缺失,则跳过步骤 4;如果已启用 shell 导入,仍会运行。

提供商凭证和工作区 .env

不要只把提供商 API key 保存在工作区 .env 中。OpenClaw 会屏蔽工作区 .env 文件中的大量提供商凭证和端点重定向键,包括每个已知的提供商认证环境变量(例如 GEMINI_API_KEYGOOGLE_API_KEYXAI_API_KEYMISTRAL_API_KEYGROQ_API_KEYDEEPSEEK_API_KEYPERPLEXITY_API_KEYBRAVE_API_KEYTAVILY_API_KEYEXA_API_KEYFIRECRAWL_API_KEY),以及任何以 _API_HOST_BASE_URL_HOMESERVER 结尾的键,还有整个 OPENCLAW_*CLAWHUB_*ANTHROPIC_API_KEY_*OPENAI_API_KEY_* 命名空间。

请改用以下可信来源之一保存提供商凭证:

  • Gateway 网关进程环境,例如 shell、launchd/systemd 单元、容器密钥或 CI 密钥。
  • 全局运行时 dotenv 文件 ~/.openclaw/.env$OPENCLAW_STATE_DIR/.env
  • ~/.openclaw/openclaw.json 中的配置 env 块。
  • 当启用 env.shellEnv.enabledOPENCLAW_LOAD_SHELL_ENV=1 时的可选登录 shell 导入。

如果你之前只把提供商键保存在工作区 .env 中,请将它们移动到上述可信来源之一。工作区 .env 仍可提供普通项目变量,但不能是凭证、端点重定向、主机覆盖或 OPENCLAW_* 运行时控制项。

安全原理参见工作区 .env 文件

配置 env

设置内联环境变量有两种等效方式(两者都不会覆盖):

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

配置 env 块只接受字面字符串值。它不会展开 file:... 值;例如,XAI_API_KEY: "file:secrets/xai-api-key.txt" 会以该精确字符串传递给提供商。

对于由文件支持的提供商键,请在支持它的凭证字段上使用 SecretRef:

json5
{  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" },      },    },  },}

支持的字段参见 Secrets ManagementSecretRef 凭证表面

Shell 环境导入

env.shellEnv 会运行你的登录 shell,并且只导入缺失的预期键名:

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

等效环境变量:

  • OPENCLAW_LOAD_SHELL_ENV=1
  • OPENCLAW_SHELL_ENV_TIMEOUT_MS=15000(默认 15000

Exec shell 快照

在非 Windows Gateway 网关主机上,bash 和 zsh 的 exec 命令默认使用启动快照。 在 Gateway 网关进程环境中设置 OPENCLAW_EXEC_SHELL_SNAPSHOT=0 可禁用此路径。 值 falsenooff 也会禁用它。每次调用的 exec.env 值不能切换 快照,也不能重定向快照缓存。

运行时注入的环境变量

OpenClaw 还会向生成的子进程注入上下文标记:

  • OPENCLAW_SHELL=exec:为通过 exec 工具运行的命令设置。
  • OPENCLAW_SHELL=acp-client:当 openclaw acp client 生成 ACP 桥接进程时设置。
  • OPENCLAW_SHELL=tui-local:为本地 TUI ! shell 命令设置。
  • OPENCLAW_CLI=1:为 CLI 入口点生成的子进程设置。

这些是运行时标记(不是必需的用户配置)。它们可用于 shell/profile 逻辑 以应用上下文特定规则。

UI 环境变量

  • OPENCLAW_THEME=light:当你的终端使用浅色背景时,强制使用浅色 TUI 调色板。
  • OPENCLAW_THEME=dark:强制使用深色 TUI 调色板。
  • COLORFGBG:如果你的终端导出它,OpenClaw 会使用背景色提示来自动选择 TUI 调色板。

配置中的环境变量替换

你可以使用 ${VAR_NAME} 语法,在配置字符串值中直接引用环境变量:

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

完整详情参见配置:环境变量替换

Secret refs 与 ${ENV} 字符串

OpenClaw 支持两种由环境变量驱动的模式:

  • 配置值中的 ${VAR} 字符串替换。
  • 对支持密钥引用的字段使用 SecretRef 对象({ source: "env", provider: "default", id: "VAR" })。

两者都会在激活时从进程环境解析。SecretRef 详情记录在 Secrets Management 中。 配置 env 块本身不会解析 SecretRef 或 file:... 简写值。

路径相关环境变量

变量 用途
OPENCLAW_HOME 覆盖用于内部 OpenClaw 路径默认值的主目录(~/.openclaw/、Agent 目录、会话、凭证、安装器新手引导,以及默认开发检出)。当以专用服务用户运行 OpenClaw 时很有用。
OPENCLAW_STATE_DIR 覆盖状态目录(默认 ~/.openclaw)。
OPENCLAW_CONFIG_PATH 覆盖配置文件路径(默认 ~/.openclaw/openclaw.json)。
OPENCLAW_INCLUDE_ROOTS 目录路径列表,$include 指令可在其中解析配置目录之外的文件(默认:无 - $include 限制在配置目录内)。会展开波浪号。

日志

变量 用途
OPENCLAW_LOG_LEVEL 覆盖文件和控制台的日志级别(例如 debugtrace)。优先于配置中的 logging.levellogging.consoleLevel。无效值会被忽略并发出警告。
OPENCLAW_DEBUG_MODEL_TRANSPORT info 级别发出有针对性的模型请求/响应计时诊断,而无需启用全局调试日志。
OPENCLAW_DEBUG_MODEL_PAYLOAD 模型载荷诊断:summarytoolsfull-redactedfull-redacted 会被截断并脱敏,但可能包含 prompt/消息文本。
OPENCLAW_DEBUG_SSE 流式传输诊断:events 用于首次/完成计时,peek 用于包含前五个已脱敏的 SSE 事件。
OPENCLAW_DEBUG_CODE_MODE 代码模式模型表面诊断,包括提供商工具隐藏和仅 exec/wait 强制执行。

OPENCLAW_HOME

设置后,OPENCLAW_HOME 会在内部 OpenClaw 路径默认值中替换系统主目录($HOME / os.homedir())。这包括默认状态目录、配置路径、Agent 目录、凭证、安装器新手引导工作区,以及 openclaw update --channel dev 使用的默认开发检出。

优先级: OPENCLAW_HOME > $HOME > USERPROFILE > Android 上的 Termux PREFIX 主目录回退 > os.homedir()

示例(macOS LaunchDaemon):

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

OPENCLAW_HOME 也可以设置为波浪号路径(例如 ~/svc),使用前会通过同一 OS 主目录回退链展开。

显式路径变量(例如 OPENCLAW_STATE_DIROPENCLAW_CONFIG_PATHOPENCLAW_GIT_DIR)仍然优先。OS 账户任务(例如 shell 启动文件检测、包管理器设置和主机 ~ 展开)仍可能使用真实系统主目录。

nvm 用户:web_fetch TLS 失败

如果 Node.js 是通过 nvm 安装的(而不是系统包管理器),内置 fetch() 会使用 nvm 捆绑的 CA 存储,其中可能缺少现代根 CA(Let's Encrypt 的 ISRG Root X1/X2、 DigiCert Global Root G2 等)。这会导致 web_fetch 在大多数 HTTPS 站点上因 "fetch failed" 失败。

在 Linux 上,OpenClaw 会自动检测 nvm,并在实际启动环境中应用修复:

  • openclaw gateway install 会将 NODE_EXTRA_CA_CERTS 写入 systemd 服务环境
  • openclaw CLI 入口点会在 Node 启动前,带着已设置的 NODE_EXTRA_CA_CERTS 重新 exec 自身

手动修复(适用于旧版本或直接 node ... 启动):

在启动 OpenClaw 前导出变量:

bash
export NODE_EXTRA_CA_CERTS=/etc/ssl/certs/ca-certificates.crtopenclaw gateway run

不要依赖仅将此变量写入 ~/.openclaw/.env;Node 会在进程启动时读取 NODE_EXTRA_CA_CERTS

旧版环境变量

OpenClaw 只读取 OPENCLAW_* 环境变量。早期版本中的旧版 CLAWDBOT_*MOLTBOT_* 前缀会被静默忽略。

如果 Gateway 网关进程在启动时仍设置了其中任何变量,OpenClaw 会发出 单个 Node 弃用警告(OPENCLAW_LEGACY_ENV_VARS),列出 检测到的前缀和总数。通过将旧版前缀替换为 OPENCLAW_ 来重命名每个值(例如将 CLAWDBOT_GATEWAY_TOKEN 改为 OPENCLAW_GATEWAY_TOKEN);旧名称不会生效。

相关

Was this useful?
On this page

On this page