跳转到内容

后台进程 (Background Process)

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

关键参数:

  • command (必填)
  • yieldMs (默认 10000): 此延迟后自动后台运行
  • background (bool): 立即后台运行
  • timeout (秒, 默认 1800): 在此超时后终止进程
  • elevated (bool): 如果启用了/允许提升模式,则在主机上运行
  • 需要真正的 TTY?设置 pty: true
  • workdir, env

行为:

  • 前台运行直接返回输出。
  • 当后台运行时(显式或超时),该工具返回 status: "running" + sessionId 和简短的尾部输出。
  • 输出保留在内存中,直到会话被轮询或清除。
  • 如果不允许 process 工具,exec 将同步运行并忽略 yieldMs/background

当在 exec/process 工具之外生成长时间运行的子进程时(例如,CLI 重生或 gateway 助手),请附加子进程桥接助手,以便转发终止信号并在退出/错误时分离监听器。这避免了 systemd 上的孤立进程,并保持跨平台的关闭行为一致。

环境覆盖:

  • PI_BASH_YIELD_MS: 默认 yield (ms)
  • PI_BASH_MAX_OUTPUT_CHARS: 内存中输出上限 (chars)
  • OPENCLAW_BASH_PENDING_MAX_OUTPUT_CHARS: 每个流的待处理 stdout/stderr 上限 (chars)
  • PI_BASH_JOB_TTL_MS: 完成会话的 TTL (ms, 限制在 1m–3h)

配置(首选):

  • tools.exec.backgroundMs (默认 10000)
  • tools.exec.timeoutSec (默认 1800)
  • tools.exec.cleanupMs (默认 1800000)
  • tools.exec.notifyOnExit (默认 true): 当后台 exec 退出时,排队系统事件 + 请求心跳。

动作:

  • 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"}