OpenClaw 通过Documentation Index
Fetch the complete documentation index at: https://docs2.openclaw.ai/llms.txt
Use this file to discover all available pages before exploring further.
exec 工具运行 shell 命令,并在内存中保留长时间运行的任务。process 工具管理这些后台会话。
exec 工具
关键参数:command(必填)yieldMs(默认 10000):超过此延迟后自动转入后台background(bool):立即转入后台timeout(秒,默认tools.exec.timeoutSec):在此超时后终止进程;仅在需要为该调用禁用 exec 进程超时时,设置timeout: 0elevated(bool):如果 elevated 模式已启用/允许,则在沙箱外运行(默认是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 上出现孤立进程,并保持跨平台关闭行为一致。 环境覆盖项: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)OPENCLAW_PROCESS_INPUT_WAIT_IDLE_MS:可写后台会话被标记为可能正在等待输入之前的空闲输出阈值(默认 15000 毫秒)
tools.exec.backgroundMs(默认 10000)tools.exec.timeoutSec(默认 1800)tools.exec.cleanupMs(默认 1800000)tools.exec.notifyOnExit(默认 true):当后台 exec 退出时,将系统事件加入队列 + 请求 Heartbeat。tools.exec.notifyOnExitEmptySuccess(默认 false):为 true 时,也会为未产生输出的成功后台运行加入完成事件队列。
process 工具
操作:list:正在运行 + 已完成的会话poll:排空会话的新输出(也会报告退出状态)log:读取聚合输出并显示输入恢复提示(支持offset+limit)write:发送 stdin(data,可选eof)send-keys:向 PTY 支持的会话发送显式按键 token 或字节submit:向 PTY 支持的会话发送 Enter / 回车paste:发送字面文本,可选包裹在 bracketed paste 模式中kill:终止后台会话clear:从内存中移除已完成会话remove:如果正在运行则终止,否则如果已完成则清除
- 只有后台会话会列出/持久保存在内存中。
- 进程重启后会话会丢失(没有磁盘持久化)。
- 会话日志只有在你运行
process poll/log且工具结果被记录时,才会保存到聊天历史。 process按智能体划分作用域;它只能看到由该智能体启动的会话。- 使用
poll/log查看状态、日志、静默成功确认,或在自动完成唤醒不可用时确认完成。 - 在恢复交互式 CLI 之前使用
log,这样当前转录、stdin 状态和输入等待提示会一起可见。 - 当你需要输入或干预时,使用
write/send-keys/submit/paste/kill。 process list包含派生的name(命令动词 + 目标),便于快速浏览。process list、poll和log仅在会话仍有可写 stdin 且空闲时间超过输入等待阈值时报告waitingForInput。process log使用基于行的offset/limit。- 当
offset和limit都省略时,它会返回最后 200 行并包含分页提示。 - 当提供
offset且省略limit时,它会从offset返回到结尾(不限制为 200 行)。 - 轮询用于按需查看状态,而不是等待循环调度。如果工作应在之后发生,请改用 cron。