exec 工具运行 shell 命令,并将长时间运行的任务保存在内存中。process 工具用于管理这些后台会话。
exec 工具
关键参数:command(required)yieldMs(default 10000): 在此延迟后自动转入后台background(bool): 立即后台运行timeout(seconds, defaulttools.exec.timeoutSec): 在此超时后终止进程;仅当你想为该次调用禁用 exec 进程超时时,才将timeout: 0设为 0elevated(bool): 如果已启用/允许提权模式,则在沙箱外运行(默认是gateway,当 exec 目标是node时为node)- 需要真实 TTY?设置
pty: true。 workdir,env
- 前台运行会直接返回输出。
- 当转入后台时(显式或超时),工具会返回
status: "running"+sessionId以及一小段尾部输出。 - 后台运行和
yieldMs运行都会继承tools.exec.timeoutSec,除非调用中提供了显式的timeout。 - 输出会保存在内存中,直到会话被轮询或清除。
- 如果
process工具被禁止,exec会同步运行并忽略yieldMs/background。 - 启动的 exec 命令会收到
OPENCLAW_SHELL=exec,以便使用上下文感知的 shell/profile 规则。 - 对于从现在开始运行的长任务,只需启动一次,并依赖自动完成唤醒;当该功能启用且命令产生输出或失败时会触发。
- 如果自动完成唤醒不可用,或者你需要对一个干净退出但无输出的命令进行静默成功确认,请使用
process来确认完成。 - 不要用
sleep循环或重复轮询来模拟提醒或延迟跟进;未来任务请使用 cron。
子进程桥接
当在 exec/process 工具之外启动长时间运行的子进程时(例如 CLI 重启派生或 gateway 辅助进程),请附加子进程桥接辅助程序,以便在退出/出错时转发终止信号并分离监听器。这样可以避免 systemd 上的孤儿进程,并使各平台的关闭行为保持一致。 环境覆盖:OPENCLAW_BASH_YIELD_MS: default yield (ms)OPENCLAW_BASH_MAX_OUTPUT_CHARS: in-memory output cap (chars)OPENCLAW_BASH_PENDING_MAX_OUTPUT_CHARS: pending stdout/stderr cap per stream (chars)OPENCLAW_BASH_JOB_TTL_MS: TTL for finished sessions (ms, bounded to 1m–3h)OPENCLAW_PROCESS_INPUT_WAIT_IDLE_MS: idle-output threshold before writable background sessions are marked as likely waiting for input (default 15000 ms)
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)send-keys: 向基于 PTY 的会话发送显式按键标记或字节submit: 向基于 PTY 的会话发送 Enter / 回车paste: 发送字面文本,可选用方括号粘贴模式包裹kill: 终止后台会话clear: 从内存中移除已完成的会话remove: 若正在运行则终止,否则若已完成则清除
- 只有后台会话会被列出并保存在内存中。
- 会话会在进程重启后丢失(无磁盘持久化)。
- 仅当你运行
process poll/log且工具结果被记录到聊天历史中时,会话日志才会保存到聊天历史。 process以 agent 为作用域;它只能看到该 agent 启动的会话。- 在自动完成唤醒不可用时,使用
poll/log查看状态、日志、静默成功确认,或进行完成确认。 - 在恢复交互式 CLI 之前使用
log,这样当前转录、stdin 状态和输入等待提示会一起显示。 - 在需要输入或干预时,使用
write/send-keys/submit/paste/kill。 process list会包含一个派生的name(命令动词 + 目标),便于快速浏览。- 只有当会话仍有可写 stdin 且已空闲超过输入等待阈值时,
process list、poll和log才会报告waitingForInput。 process log使用按行计算的offset/limit。- 当
offset和limit都省略时,它会返回最后 200 行,并包含分页提示。 - 当提供
offset而省略limit时,它会返回从offset到末尾的内容(不会截断为 200 行)。 - 轮询用于按需查看状态,不用于等待循环调度。如果工作应当稍后发生,请改用 cron。