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(布林值):立即轉入背景timeout(秒,預設為tools.exec.timeoutSec):在此逾時後終止程序;只有在要停用該次呼叫的 exec 程序逾時時,才設定timeout: 0elevated(布林值):如果 elevated 模式已啟用/允許,則在 sandbox 外執行(預設為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:預設讓出時間(毫秒)PI_BASH_MAX_OUTPUT_CHARS:記憶體內輸出上限(字元)OPENCLAW_BASH_PENDING_MAX_OUTPUT_CHARS:每個串流的待處理 stdout/stderr 上限(字元)PI_BASH_JOB_TTL_MS:已完成工作階段的 TTL(毫秒,限制在 1 分鐘至 3 小時)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:將明確的按鍵 token 或位元組傳送到 PTY 支援的工作階段submit:將 Enter / carriage return 傳送到 PTY 支援的工作階段paste:傳送文字常值,可選擇包在 bracketed paste mode 中kill:終止背景工作階段clear:從記憶體移除已完成的工作階段remove:若正在執行則終止;若已完成則清除
- 只有背景化的工作階段會列出/保存在記憶體中。
- 程序重新啟動時會遺失工作階段(沒有磁碟持久化)。
- 只有在你執行
process poll/log且工具結果被記錄時,工作階段日誌才會儲存到聊天歷史。 process的範圍限於每個 agent;它只會看到該 agent 啟動的工作階段。- 使用
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。