Community translations by veiseule.ai — Help improve them on Crowdin
Skip to main content

背景 Exec + Process 工具

OpenClaw 透過 exec 工具執行 shell 指令,並將長時間執行的任務保存在記憶體中。process 工具用於管理這些背景工作階段。 The process tool manages those background sessions.

exec 工具

主要參數:

  • command(必填)
  • yieldMs(預設 10000):超過此延遲後自動轉為背景
  • background(bool):立即轉為背景
  • timeout(秒,預設 1800):超過此逾時後終止程序
  • elevated(bool):在啟用/允許提高權限模式時於主機上執行
  • 需要真正的 TTY?設定 pty: true。 Set pty: true.
  • workdirenv

行為:

  • 前景執行會直接回傳輸出結果。
  • 轉為背景(明確指定或因逾時)時,工具會回傳 status: "running" + sessionId 與一段簡短的尾端輸出。
  • 輸出會保存在記憶體中,直到輪詢或清除該工作階段為止。
  • process 工具被禁止,exec 會以同步方式執行並忽略 yieldMs/background

子行程橋接

當在 exec/process 工具之外啟動長時間執行的子行程(例如 CLI 重新啟動或 gateway 輔助程式)時,請附加子行程橋接輔助工具,以便在結束時轉送終止訊號並在退出或發生錯誤時解除監聽器。這可避免在 systemd 上產生孤兒行程,並確保各平台之間的關閉行為保持一致。

環境覆寫:

  • PI_BASH_YIELD_MS:預設讓出(ms)
  • PI_BASH_MAX_OUTPUT_CHARS:記憶體中輸出上限(字元)
  • OPENCLAW_BASH_PENDING_MAX_OUTPUT_CHARS:每個串流的待處理 stdout/stderr 上限(字元)
  • PI_BASH_JOB_TTL_MS:已完成工作階段的 TTL(ms,限制為 1 分鐘–3 小時)

設定(建議):

  • 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:若仍在執行則終止,否則在完成時清除

注意事項:

  • 只有背景化的工作階段會被列出/保存在記憶體中。
  • Sessions are lost on process restart (no disk persistence).
  • 只有在你執行 process poll/log 且工具結果被記錄時,工作階段日誌才會儲存到聊天記錄。
  • process is scoped per agent; it only sees sessions started by that agent.
  • process list 包含一個衍生的 name(指令動詞 + 目標),便於快速掃描。
  • process log 使用以行為基礎的 offset/limit(省略 offset 以取得最後 N 行)。

範例

Run a long task and poll later:

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