Skip to main content
在工作区中运行 shell 命令。exec 是一个会修改环境的 shell 接口:命令可以在所选主机或沙箱文件系统允许的任何位置创建、编辑或删除文件。禁用 OpenClaw 文件系统工具(如 writeeditapply_patch)并不会让 exec 变成只读。 通过 process 支持前台 + 后台执行。如果不允许 processexec 会同步运行并忽略 yieldMs/background。 后台会话按 agent 范围隔离;process 只能看到来自同一 agent 的会话。

参数

command
string
required
要运行的 Shell 命令。
workdir
string
default:"cwd"
命令的工作目录。
env
object
在继承环境之上合并的键/值环境覆盖项。
yieldMs
number
default:"10000"
在此延迟(ms)后自动将命令切换到后台。
background
boolean
default:"false"
立即将命令置于后台,而不是等待 yieldMs
timeout
number
default:"tools.exec.timeoutSec"
为本次调用覆盖已配置的 exec 超时时间。只有当命令应在没有 exec 进程超时的情况下运行时,才设置 timeout: 0
pty
boolean
default:"false"
在可用时于伪终端中运行。用于仅支持 TTY 的 CLI、编码 agent 和终端 UI。
host
'auto' | 'sandbox' | 'gateway' | 'node'
default:"auto"
在哪里执行。auto 在沙箱运行时处于活动状态时解析为 sandbox,否则解析为 gateway
security
'deny' | 'allowlist' | 'full'
普通工具调用会忽略。gateway / node 安全性由 tools.exec.security~/.openclaw/exec-approvals.json 控制;提升模式只能在操作员明确授予提升访问权限时强制使用 security=full
ask
'off' | 'on-miss' | 'always'
基础 ask 模式来自 tools.exec.ask 和主机审批。 对于 channel-origin 模型调用,当有效主机 ask 为 off 时,每次调用的 ask 会被忽略;否则它最多只能收紧到更严格的模式。通过显式 ask 值构造 exec 工具的受信任内部/API 调用保持不变。
node
string
host=node 时的节点 id/名称。
elevated
boolean
default:"false"
请求提升模式——从沙箱跳转到已配置的主机路径。只有当 elevated 解析为 full 时,才强制使用 security=full
注意:
  • host 默认为 auto:当本次会话的沙箱运行时处于活动状态时使用 sandbox,否则使用 gateway。
  • host 只接受 autosandboxgatewaynode。它不是主机名选择器;类似主机名的值会在命令运行前被拒绝。
  • auto 是默认路由策略,不是通配符。从 auto 可以按调用使用 host=node;只有在没有沙箱运行时活动时,按调用使用 host=gateway 才被允许。
  • tools.exec.mode 是标准化的策略开关。可选值为 denyallowlistaskautofullauto 会直接运行确定性的 allowlist/safe-bin 匹配,并将其余所有 exec 审批情况路由到 OpenClaw 的原生自动审阅器,然后再请求人工审批。ask / ask=always 仍然会每次都请求人工审批。
  • 在没有额外配置时,host=auto 仍然“开箱即用”:没有 sandbox 就解析为 gateway;有活动 sandbox 就保持在 sandbox 中。
  • elevated 会将沙箱切换到已配置的主机路径:默认是 gateway,如果 tools.exec.host=node(或会话默认是 host=node)则为 node。只有在当前会话/提供方启用了提升访问时才可用。
  • gateway/node 审批由 ~/.openclaw/exec-approvals.json 控制。
  • node 需要配对的节点(配套应用或无头节点主机)。
  • 如果有多个节点可用,请设置 exec.nodetools.exec.node 选择其一。
  • exec host=node 是节点唯一的 shell 执行路径;旧的 nodes.run 包装器已移除。
  • timeout 适用于前台、后台、yieldMs、gateway、sandbox 和 node 的 system.run 执行。如果省略,OpenClaw 使用 tools.exec.timeoutSec;显式 timeout: 0 会为该次调用禁用 exec 进程超时。
  • 在非 Windows 主机上,exec 会在设置了 SHELL 时使用它;如果 SHELLfish,则优先从 PATH 中选择 bash(或 sh),以避免 fish 不兼容脚本,然后在两者都不存在时回退到 SHELL
  • 在 Windows 主机上,exec 优先发现 PowerShell 7(pwsh)(Program Files、ProgramW6432,然后 PATH),然后回退到 Windows PowerShell 5.1。
  • 在非 Windows 的 gateway 主机上,bash 和 zsh exec 命令使用启动快照。OpenClaw 会将可 source 的别名/函数和一小组安全环境变量从 shell 启动文件捕获到 $OPENCLAW_STATE_DIR/cache/shell-snapshots/,然后在每个 exec 命令之前 source 该快照;看起来像机密的变量会被排除;sandbox 和 node exec 不使用此快照。将 OPENCLAW_EXEC_SHELL_SNAPSHOT=0 设置到 Gateway 进程环境中可禁用此快照路径。
  • 主机执行(gateway/node)会拒绝 env.PATH 和 loader 覆盖(LD_*/DYLD_*),以防止二进制劫持或注入代码。
  • OpenClaw 会在派生的命令环境中设置 OPENCLAW_SHELL=exec(包括 PTY 和 sandbox 执行),以便 shell/profile 规则可以检测 exec 工具上下文。
  • openclaw channels login 会被 exec 阻止,因为它是一个交互式 channel-auth 流程;请在 gateway 主机上的终端中运行它,或者在存在时使用聊天中的 channel 原生登录工具。
  • 重要:sandbox 默认是关闭的。如果 sandbox 关闭,隐式 host=auto 会解析为 gateway。显式 host=sandbox 仍然会失败关闭,而不是静默在 gateway 主机上运行。请启用 sandbox 或使用带审批的 host=gateway
  • 脚本预检检查(针对常见的 Python/Node shell 语法错误)只会检查有效 workdir 边界内的文件。如果脚本路径解析到 workdir 之外,则会跳过该文件的预检。
  • 对于从现在开始的长时间运行工作,请只启动一次,并依赖自动完成唤醒(如果已启用且命令有输出或失败)。对日志、状态、输入或干预使用 process;不要用 sleep 循环、超时循环或重复轮询来模拟调度。
  • 对于应该稍后发生或按计划执行的工作,请使用 cron,而不是 exec 的 sleep/delay 模式。

配置

  • tools.exec.notifyOnExit(默认:true):当为 true 时,后台 exec 会话会在退出时排队一个系统事件并请求心跳。
  • tools.exec.approvalRunningNoticeMs(默认:10000):当受审批门禁的 exec 运行时间超过此值时,发出一次“running”通知(设为 0 可禁用)。
  • tools.exec.timeoutSec(默认:1800):默认的每条命令 exec 超时时间(秒)。按调用的 timeout 会覆盖它;按调用的 timeout: 0 会禁用 exec 进程超时。
  • tools.exec.host(默认:auto;当 sandbox 运行时处于活动状态时解析为 sandbox,否则为 gateway
  • tools.exec.security(默认:sandbox 为 deny,gateway + node 在未设置时为 full
  • tools.exec.ask(默认:off
  • 无审批的主机 exec 是 gateway + node 的默认行为。如果你想要审批/允许列表行为,请同时收紧 tools.exec.* 和主机上的 ~/.openclaw/exec-approvals.json;参见 Exec approvals
  • YOLO 来自主机策略默认值(security=fullask=off),而不是来自 host=auto。如果你想强制 gateway 或 node 路由,请设置 tools.exec.host 或使用 /exec host=...
  • security=fullask=off 模式下,主机 exec 会直接遵循已配置策略;不会额外进行启发式命令混淆预过滤或脚本预检拒绝层。
  • tools.exec.node(默认:未设置)
  • tools.exec.strictInlineEval(默认:false):当为 true 时,内联解释器 eval 形式(如 python -cnode -eruby -eperl -ephp -rlua -eosascript -e)需要审阅者或显式批准。在 mode=auto 下,正常的 exec 审批路径可能会让原生自动审阅器放行一个明显低风险的一次性命令;直接的 node 主机 system.run 调用仍然需要显式批准,因为它们无法把命令交给人工审批路径。如果审阅者提出要求,请求会进入人工处理。allow-always 仍然可以持久化良性的解释器/脚本调用,但内联 eval 形式不会变成持久的允许规则。
  • tools.exec.commandHighlighting(默认:false):当为 true 时,审批提示可以在命令文本中高亮解析器派生的命令片段。将其全局或按 agent 设为 true,即可启用命令文本高亮,而不改变 exec 审批策略。
  • tools.exec.pathPrepend:要为 exec 运行预先添加到 PATH 的目录列表(仅限 gateway + sandbox)。
  • tools.exec.safeBins:仅 stdin 的安全二进制文件,可在没有显式 allowlist 条目的情况下运行。行为细节见 Safe bins
  • tools.exec.safeBinTrustedDirs:用于 safeBins 路径检查的额外显式受信任目录。PATH 条目绝不会被自动信任。内置默认值为 /bin/usr/bin
  • tools.exec.safeBinProfiles:每个 safe bin 的可选自定义 argv 策略(minPositionalmaxPositionalallowedValueFlagsdeniedFlags)。
示例:
{
  tools: {
    exec: {
      pathPrepend: ["~/bin", "/opt/oss/bin"],
    },
  },
}

PATH 处理

  • host=gateway:将你的登录 shell PATH 合并到 exec 环境中。env.PATH 覆盖项会 被主机执行拒绝。守护进程本身仍使用最小 PATH 运行:
    • macOS: /opt/homebrew/bin, /usr/local/bin, /usr/bin, /bin
    • Linux: /usr/local/bin, /usr/bin, /bin
      • 为防止用户 shell 配置(如 ~/.zshenv/etc/zshenv)在启动期间覆盖优先级路径,tools.exec.pathPrepend 条目会在执行前被安全地预先添加到 shell 命令中的最终 PATH
  • host=sandbox:在容器内运行 sh -lc(登录 shell),因此 /etc/profile 可能会重置 PATH。 OpenClaw 会通过内部环境变量在 profile 加载后追加 env.PATH(不进行 shell 插值); tools.exec.pathPrepend 在这里同样适用。
  • host=node:只会把你传入的、未被阻止的环境覆盖项发送到节点。env.PATH 覆盖项会 被主机执行拒绝,并且会被节点主机忽略。如果你需要在节点上添加额外的 PATH 条目, 请配置节点主机服务环境(systemd/launchd)或将工具安装到标准位置。
按 agent 绑定节点(在配置中使用 agent 列表索引):
openclaw config get agents.list
openclaw config set 'agents.list[0].tools.exec.node' "node-id-or-name"
控制 UI:Nodes 选项卡包含一个小型“Exec 节点绑定”面板,用于相同设置。

会话覆盖(/exec

使用 /exec 来设置 按会话hostsecurityasknode 默认值。 不带参数发送 /exec 可显示当前值。 示例:
/exec host=auto security=allowlist ask=on-miss node=mac-1

授权模型

/exec 仅对授权发送者生效(channel allowlists/pairing plus commands.useAccessGroups)。 它只会更新会话状态,不会写入配置。授权的外部 channel 发送者可以 设置这些会话默认值。内部 gateway/webchat 客户端需要 operator.admin 才能持久化这些值。 要彻底禁用 exec,请通过工具策略将其拒绝(tools.deny: ["exec"] 或按 agent 配置)。主机审批仍然适用,除非你显式设置 security=fullask=off

Exec 审批(伴侣应用 / node 主机)

沙箱化 agent 在 exec 运行到 gateway 或 node 主机之前,可能需要逐请求审批。 有关策略、允许列表和 UI 流程,请参见 Exec approvals 当需要审批时,exec 工具会立即返回 status: "approval-pending" 和一个审批 id。一旦被批准(或被拒绝 / 超时), Gateway 只会为已批准的运行发出命令进度和完成系统事件 (Exec running / Exec finished)。被拒绝或超时的审批是终态,不会 通过拒绝系统事件唤醒 agent 会话。 在带有原生审批卡片/按钮的频道中,agent 应优先依赖该 原生 UI,只有当工具结果明确说明聊天审批不可用或手动审批是 唯一途径时,才应包含手动 /approve 命令。

允许列表 + 安全 bin

手动允许列表强制执行会匹配已解析的二进制路径 glob 和裸命令名 glob。裸名称只匹配通过 PATH 调用的命令,因此当命令是 rg 时,rg 可以匹配 /opt/homebrew/bin/rg,但不能匹配 ./rg/tmp/rg。当 security=allowlist 时,shell 命令只有在每个管道 段都在允许列表中或属于安全 bin 时才会被自动允许。串联(;&&||)和重定向 在允许列表模式下会被拒绝,除非每个顶级段都满足允许列表(包括安全 bin)。重定向仍然不受支持。 持久的 allow-always 信任不会绕过该规则:串联命令仍然需要每个 顶级段都匹配。 autoAllowSkills 是 exec 审批中的一个独立便捷路径。它不同于 手动路径允许列表条目。对于严格的显式信任,请保持 autoAllowSkills 处于禁用状态。 将这两个控制项用于不同用途:
  • tools.exec.safeBins:小型、仅 stdin 的流过滤器。
  • tools.exec.safeBinTrustedDirs:为安全 bin 可执行路径显式添加额外受信任目录。
  • tools.exec.safeBinProfiles:为自定义安全 bin 显式指定 argv 策略。
  • 允许列表:对可执行路径的显式信任。
Do not treat safeBins as a generic allowlist, and do not add interpreter/runtime binaries (for example python3, node, ruby, bash). If you need those, use explicit allowlist entries and keep approval prompts enabled. openclaw security audit warns when interpreter/runtime safeBins entries are missing explicit profiles, and openclaw doctor --fix can scaffold missing custom safeBinProfiles entries. openclaw security audit and openclaw doctor also warn when you explicitly add broad-behavior bins such as jq back into safeBins. If you explicitly allowlist interpreters, enable tools.exec.strictInlineEval so inline code-eval forms still require reviewer or explicit approval. 有关完整的策略细节和示例,请参见 Exec approvalsSafe bins versus allowlist

示例

前台:
{ "tool": "exec", "command": "ls -la" }
后台 + 轮询:
{"tool":"exec","command":"npm run build","yieldMs":1000}
{"tool":"process","action":"poll","sessionId":"<id>"}
轮询用于按需查看状态,而不是等待循环。如果启用了自动完成唤醒, 命令在输出内容或失败时可以唤醒会话。 发送按键(tmux 风格):
{"tool":"process","action":"send-keys","sessionId":"<id>","keys":["Enter"]}
{"tool":"process","action":"send-keys","sessionId":"<id>","keys":["C-c"]}
{"tool":"process","action":"send-keys","sessionId":"<id>","keys":["Up","Up","Enter"]}
提交(仅发送 CR):
{ "tool": "process", "action": "submit", "sessionId": "<id>" }
粘贴(默认以括号包裹):
{ "tool": "process", "action": "paste", "sessionId": "<id>", "text": "line1\nline2\n" }

apply_patch

apply_patchexec 的一个子工具,用于结构化的多文件编辑。 它默认对 OpenAI 和 OpenAI Codex 模型启用。只有当你想要禁用它或将其限制为特定模型时才使用配置:
{
  tools: {
    exec: {
      applyPatch: { workspaceOnly: true, allowModels: ["gpt-5.5"] },
    },
  },
}
注意:
  • 仅适用于 OpenAI/OpenAI Codex 模型。
  • 工具策略仍然适用;allow: ["write"] 会隐式允许 apply_patch
  • deny: ["write"] 不会拒绝 apply_patch;如果补丁写入也应被阻止,请显式拒绝 apply_patch,或在需要阻止补丁写入时使用 deny: ["group:fs"]
  • 配置位于 tools.exec.applyPatch 下。
  • tools.exec.applyPatch.enabled 的默认值为 true;将其设置为 false 可为 OpenAI 模型禁用该工具。
  • tools.exec.applyPatch.workspaceOnly 的默认值为 true(仅限工作区内)。只有当你明确希望 apply_patch 在工作区目录之外写入/删除时,才将其设置为 false

相关内容