后台 Exec + Process 工具

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

exec 工具

关键参数：

  • command（必需）
  • yieldMs（默认 10000）：在此延迟后自动后台化
  • background（布尔值）：立即后台化
  • timeout（秒，默认 1800）：超时后杀死进程
  • elevated（布尔值）：如果启用/允许提升模式，则在主机上运行
  • 需要真正的 TTY？设置 pty: true。
  • workdir、env

行为：

  • 前台运行直接返回输出。
  • 当后台化（明确或超时）时，工具返回 status: "running" + sessionId 和一个短尾部。
  • 输出保留在内存中，直到会话被轮询或清除。
  • 如果 process 工具被禁止，exec 同步运行并忽略 yieldMs/background。

子进程桥接

当在 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：已完成会话的 TTL（毫秒，限制在 1m–3h）

配置（首选）：

  • tools.exec.backgroundMs（默认 10000）
  • tools.exec.timeoutSec（默认 1800）
  • tools.exec.cleanupMs（默认 1800000）
  • tools.exec.notifyOnExit（默认 true）：当后台化的 exec 退出时，将系统事件加入队列 + 请求心跳。

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（省略 offset 以获取最后 N 行）。

示例

运行长任务并稍后轮询：

{"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"}
← 返回文档首页