跳转到内容

Exec Tool

在工作区中运行 shell 命令。通过 process 支持前台和后台执行。 如果 process 被禁止,exec 将同步运行并忽略 yieldMs/background。 后台会话按代理作用域划分;process 只能看到来自同一代理的会话。

  • command(必需)
  • workdir(默认为 cwd)
  • env(键/值覆盖)
  • yieldMs(默认 10000):延迟后自动后台运行
  • background(布尔值):立即后台运行
  • timeout(秒,默认 1800):到期时终止
  • pty(布尔值):在可用时在伪终端中运行(仅限 TTY 的 CLI、编码代理、终端 UI)
  • host (auto | sandbox | gateway | node): 在何处执行
  • security (deny | allowlist | full):针对 gateway/node 的强制执行模式
  • ask (off | on-miss | always):针对 gateway/node 的审批提示
  • node(字符串):用于 host=node 的节点 ID/名称
  • elevated(布尔值):请求提升模式(网关主机);仅当提升解析为 full 时才强制 security=full

备注:

  • host 默认为 auto: 当会话激活沙箱运行时时为沙箱,否则为网关。
  • elevated 强制使用 host=gateway;仅当为当前会话/提供商启用了提升访问权限时,才可用此选项。
  • gateway/node 批准由 ~/.openclaw/exec-approvals.json 控制。
  • node 需要一个配对节点(配套应用或无头节点主机)。
  • 如果有多个节点可用,请设置 exec.nodetools.exec.node 来选择一个。
  • exec host=node 是节点唯一的 shell 执行路径;旧的 nodes.run 包装器已被移除。
  • 在非 Windows 主机上,如果设置了 SHELL,exec 会使用它;如果 SHELLfish,它倾向于使用 PATH 中的 bash (或 sh) 以避免不兼容 fish 的脚本,如果两者都不存在,则回退到 SHELL
  • 在 Windows 主机上,exec 倾向于发现 PowerShell 7 (pwsh) (Program Files, ProgramW6432, 然后是 PATH),然后回退到 Windows PowerShell 5.1。
  • 主机执行 (gateway/node) 会拒绝 env.PATH 和加载器覆盖 (LD_*/DYLD_*) 以防止二进制劫持或代码注入。
  • OpenClaw 在生成的命令环境中(包括 PTY 和沙箱执行)设置 OPENCLAW_SHELL=exec,以便 shell/配置文件规则可以检测 exec 工具上下文。
  • 重要提示:沙箱隔离默认关闭。如果关闭了沙箱隔离,隐式的 host=auto 将解析为 gateway。显式的 host=sandbox 仍然会失败关闭,而不是在网关主机上静默运行。请启用沙箱隔离或使用带批准的 host=gateway
  • 脚本预检查(针对常见的 Python/Node shell 语法错误)仅检查有效 workdir 边界内的文件。如果脚本路径解析到 workdir 之外,则跳过该文件的预检查。
  • tools.exec.notifyOnExit(默认:true):为 true 时,后台执行的会话将排队一个系统事件,并在退出时请求心跳。
  • tools.exec.approvalRunningNoticeMs(默认:10000):当需要批准的 exec 运行时间超过此值时,发出一条“running”通知(0 表示禁用)。
  • tools.exec.host(默认:auto;当沙箱运行时激活时解析为 sandbox,否则为 gateway
  • tools.exec.security(默认:沙箱为 deny,未设置时网关 + 节点为 allowlist
  • tools.exec.ask(默认:on-miss
  • tools.exec.node(默认:未设置)
  • tools.exec.strictInlineEval(默认:false):为 true 时,内联解释器 eval 形式(如 python -cnode -eruby -eperl -ephp -rlua -eosascript -e)始终需要显式批准。allow-always 仍然可以保留良性解释器/脚本的调用,但内联 eval 形式每次仍会提示。
  • tools.exec.pathPrepend:要在 exec 运行时预置到 PATH 的目录列表(仅限网关 + 沙箱)。
  • tools.exec.safeBins:仅 stdin 的安全二进制文件,可以在没有显式允许列表条目的情况下运行。有关行为详细信息,请参阅 Safe bins
  • tools.exec.safeBinTrustedDirs:用于 safeBins 路径检查的其他受信任显式目录。PATH 条目永远不会自动受信任。内置默认值为 /bin/usr/bin
  • tools.exec.safeBinProfiles:每个安全 bin 的可选自定义 argv 策略(minPositionalmaxPositionalallowedValueFlagsdeniedFlags)。

示例:

{
tools: {
exec: {
pathPrepend: ["~/bin", "/opt/oss/bin"],
},
},
}
  • 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
  • host=sandbox:在容器内运行 sh -lc(登录 shell),因此 /etc/profile 可能会重置 PATH。 OpenClaw 在通过内部环境变量(无 shell 插值)加载 profile 后前置 env.PATHtools.exec.pathPrepend 也适用于此处。
  • host=node:只有您传递的非被阻止的环境覆盖才会发送到节点。主机执行拒绝 env.PATH 覆盖,且节点主机将其忽略。如果您在节点上需要额外的 PATH 条目, 请配置节点主机服务环境(systemd/launchd)或将工具安装在标准位置。

Per-agent node binding(使用配置中的 agent 列表索引):

Terminal window
openclaw config get agents.list
openclaw config set agents.list[0].tools.exec.node "node-id-or-name"

Control UI:Nodes 标签页包含一个小的“Exec node binding”面板,用于相同的设置。

使用 /exechostsecurityasknode 设置每个会话的默认值。 发送不带参数的 /exec 以显示当前值。

示例:

/exec host=auto security=allowlist ask=on-miss node=mac-1

/exec 仅对经过授权的发送者(渠道 allowlists/pairing 加上 commands.useAccessGroups)生效。 它仅更新会话状态而不写入配置。要彻底禁用 exec,请通过工具 策略(tools.deny: ["exec"] 或每代理)拒绝它。除非您显式设置了 security=fullask=off,否则主机批准仍然适用。

Exec 批准(配套应用 / 节点主机)

Section titled “Exec 批准(配套应用 / 节点主机)”

沙箱隔离的代理可以要求在 exec 于网关或节点主机上运行之前进行逐请求批准。 有关策略、允许列表和 UI 流程,请参阅 Exec 批准

当需要批准时,exec 工具会立即返回 status: "approval-pending" 和一个批准 ID。一旦批准(或被拒绝/超时), Gateway(网关) 会发出系统事件(Exec finished / Exec denied)。如果命令在 tools.exec.approvalRunningNoticeMs 后仍在运行,则会发出一条 Exec running 通知。

手动允许列表强制执行仅匹配已解析的二进制路径(不匹配基本名称)。当 security=allowlist 时,只有当每个管道段都 在允许列表中或是安全二进制文件时,Shell 命令才会被自动允许。在允许列表模式下,链接(;&&||)和重定向会被拒绝, 除非每个顶级段都满足允许列表(包括安全二进制文件)。 重定向仍然不受支持。

autoAllowSkills 是 exec 批准中一个单独的便捷路径。它与 手动路径允许列表条目不同。为了严格明确信任,请保持 autoAllowSkills 禁用状态。

使用这两个控件来处理不同的工作:

  • tools.exec.safeBins:小型、仅 stdin 的流过滤器。
  • tools.exec.safeBinTrustedDirs:安全二进制可执行文件路径的显式额外受信任目录。
  • tools.exec.safeBinProfiles:自定义安全二进制文件的显式 argv 策略。
  • allowlist:可执行路径的显式信任。

不要将 safeBins 视为通用允许列表,也不要添加解释器/运行时二进制文件(例如 python3noderubybash)。如果您需要这些,请使用显式的允许列表条目,并保持批准提示启用。 当解释器/运行时 safeBins 条目缺少显式配置文件时,openclaw security audit 会发出警告,而 openclaw doctor --fix 可以搭建缺失的自定义 safeBinProfiles 条目。 当您显式地将行为广泛的二进制文件(如 jq)重新添加到 safeBins 中时,openclaw security auditopenclaw doctor 也会发出警告。 如果您显式地将解释器加入允许列表,请启用 tools.exec.strictInlineEval,以便内联代码求值表单仍需新的批准。

有关完整的策略详细信息和示例,请参阅 Exec 批准安全二进制文件与允许列表

前台:

{ "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_patchexec 的一个子工具,用于结构化的多文件编辑。 默认情况下,它针对 OpenAI 和 OpenAI Codex 模型启用。仅在您想要禁用它或将其限制为特定模型时才使用配置:

{
tools: {
exec: {
applyPatch: { workspaceOnly: true, allowModels: ["gpt-5.2"] },
},
},
}

说明:

  • 仅适用于 OpenAI/OpenAI Codex 模型。
  • 工具策略仍然适用;allow: ["write"] 隐式允许 apply_patch
  • 配置位于 tools.exec.applyPatch 下。
  • tools.exec.applyPatch.enabled 默认为 true;将其设置为 false 可针对 OpenAI 模型禁用该工具。
  • tools.exec.applyPatch.workspaceOnly 默认为 true(包含在工作区中)。仅当您有意希望 apply_patch 在工作区目录之外写入/删除时,才将其设置为 false