exec 工具运行 shell 命令,并将长时间运行的任务保存在内存中。process 工具用于管理这些后台会话。
exec 工具
参数:
行为:
- 前台运行会直接返回保留的输出,并在更早的输出超过聚合上限时予以说明。
- 在后台运行时(显式运行或因
yieldMs超时),工具会返回status: "running"、sessionId以及简短的输出尾部。 - 后台运行和
yieldMs运行会继承tools.exec.timeoutSeconds,除非此次调用传入了明确的timeoutSeconds。 - 输出会一直保存在内存中,直到会话被轮询或清除,但受每个会话的聚合上限限制。
- 已完成的会话会在配置的 TTL 后过期。注册表最多还会保留 50 个已完成会话,以及总计 2,000,000 个保留的输出字符,并优先驱逐最早的记录。即使最新完成的会话记录单独超过全局限制,仍会保留其达到上限的每个会话聚合输出。
- 如果不允许使用
process工具,exec会同步运行,并忽略yieldMs/background。 - 生成的 exec 命令会接收
OPENCLAW_SHELL=exec,以便执行上下文感知的 shell/配置文件规则。 - 对于现在启动的长时间运行任务:启动一次,并在命令产生输出或失败时依赖自动完成唤醒(启用时)。
- 如果自动完成唤醒不可用,或者需要确认一个成功退出且没有输出的命令,请使用
process进行轮询。 - 不要使用
sleep循环或重复轮询来模拟提醒或延迟后续操作——应使用 cron 处理未来的任务。
环境变量覆盖
配置(优先于环境变量覆盖)
子进程桥接
在 exec/process 工具之外启动长时间运行的子进程(CLI 重启、网关辅助进程)时,请附加子进程桥接辅助程序,以便终止信号能够转发,并在退出/出错时分离监听器。这样可以避免在 systemd 上产生孤儿进程,并保持跨平台的关闭行为一致。process 工具
操作:
说明:
- 仅会列出/持久化后台会话——仅存于内存中,不会写入磁盘。进程重启后会话将丢失。
- 重置或删除会话只会清除已完成的后台进程;其他会话、显式共享作用域以及正在运行的进程不受影响。
- 正在运行的后台会话会阻止协作式主机挂起和安全的 Gateway 重启,直到进程所有者确认其确实已退出。
process remove可以在请求终止后立即隐藏正在运行的会话;在确认进程退出之前,挂起和重启仍会被阻止。- 只有运行
process poll/log且工具结果被记录后,会话日志才会保存到聊天记录中。 process按代理划分作用域;它只能看到由该代理启动的会话。- 当自动完成唤醒不可用时,使用
poll/log获取状态、日志或完成确认。 - 恢复交互式 CLI 之前使用
log,以便同时查看当前记录、stdin 状态和输入等待提示。 - 需要输入或干预时,使用
write/send-keys/submit/paste/kill。 process list会包含一个派生的name(命令动词 + 目标),便于快速扫描。- 仅当会话仍有可写入的 stdin,且空闲时间超过输入等待阈值(默认为 15000 毫秒,
OPENCLAW_PROCESS_INPUT_WAIT_IDLE_MS)时,process list、poll和log才会报告waitingForInput。 process log使用基于行的offset/limit。两者均省略时,它会返回最后 200 行并附带分页提示。设置offset而未设置limit时,它会从offset返回到末尾(不会限制为 200 行)。process poll和process log会区分因聚合保留上限而丢弃的输出,以及仅因待处理缓冲区或保留尾部而被省略的输出。被丢弃的输出无法恢复;分页日志只能查看保留的部分。poll的timeout最多等待指定的毫秒数后返回;超过 30000 的值会被限制为 30000。- 轮询用于按需获取状态,而不是用于循环等待调度。如果工作应在稍后执行,请使用 cron。