后台执行 + 进程工具

OpenClaw 通过 exec 工具执行 shell 命令,并在内存中保持长时间运行的任务。process 工具负责管理这些后台会话。

exec 工具

关键参数:

  • command(必填)
  • yieldMs(默认 10000):超过此延迟后自动转入后台
  • background(布尔值):立即后台执行
  • timeout(秒,默认 1800):超时后终止进程
  • elevated(布尔值):如果允许提权模式,在宿主机上运行
  • 需要真正的 TTY?设置 pty: true
  • workdirenv

行为:

  • 前台运行直接返回输出。
  • 转入后台时(显式指定或超时触发),工具返回 status: "running" + sessionId 以及末尾几行输出。
  • 输出保存在内存中,直到会话被轮询或清除。
  • 如果 process 工具被禁用,exec 会同步运行并忽略 yieldMs/background
  • 派生的 exec 命令会收到环境变量 OPENCLAW_SHELL=exec,方便 shell/profile 规则做上下文判断。

子进程桥接

在 exec/process 工具之外启动长时间运行的子进程时(比如 CLI 重启或 Gateway 辅助进程),需要挂载子进程桥接助手,确保终止信号能正确转发、退出/异常时能解除监听。这样可以避免 systemd 下出现孤儿进程,也能保证跨平台的关闭行为一致。

环境变量覆盖:

  • PI_BASH_YIELD_MS:默认 yield 时间(毫秒)
  • PI_BASH_MAX_OUTPUT_CHARS:内存中的输出上限(字符数)
  • OPENCLAW_BASH_PENDING_MAX_OUTPUT_CHARS:每个流的待处理 stdout/stderr 上限(字符数)
  • PI_BASH_JOB_TTL_MS:已完成会话的存活时间(毫秒,限制在 1 分钟到 3 小时之间)

配置项(推荐方式):

  • tools.exec.backgroundMs(默认 10000)
  • tools.exec.timeoutSec(默认 1800)
  • tools.exec.cleanupMs(默认 1800000)
  • tools.exec.notifyOnExit(默认 true):后台 exec 退出时入队系统事件并请求心跳。
  • tools.exec.notifyOnExitEmptySuccess(默认 false):为 true 时,成功但无输出的后台运行也会入队完成事件。

process 工具

操作:

  • list:列出运行中和已完成的会话
  • poll:读取会话的新输出(同时报告退出状态)
  • log:读取聚合输出(支持 offset + limit
  • write:发送 stdin(data,可选 eof
  • kill:终止后台会话
  • clear:从内存中移除已完成的会话
  • remove:运行中则终止,已完成则清除

说明:

  • 只有后台化的会话才会被列出/保留在内存中。
  • 进程重启后会话丢失(不做磁盘持久化)。
  • 会话日志只有在执行 process poll/log 且工具结果被记录时,才会保存到聊天历史。
  • process 按 Agent 隔离,只能看到该 Agent 启动的会话。
  • process list 包含一个派生的 name(命令动词 + 目标),方便快速浏览。
  • process log 使用基于行的 offset/limit
  • 不传 offsetlimit 时,返回最后 200 行并附带分页提示。
  • 传了 offset 但没传 limit 时,从 offset 位置返回到末尾(不限制 200 行)。

示例

执行长任务,稍后轮询:

{ "tool": "exec", "command": "sleep 5 && echo done", "yieldMs": 1000 }
{ "tool": "process", "action": "poll", "sessionId": "<id>" }

立即后台执行:

{ "tool": "exec", "command": "npm run build", "background": true }

发送 stdin:

{ "tool": "process", "action": "write", "sessionId": "<id>", "data": "y\n" }