在工作區中執行 shell 命令。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 介面:只要所選主機或沙盒檔案系統允許,命令就能在任何位置建立、編輯或刪除檔案。停用 OpenClaw 檔案系統工具,例如 write、edit 或 apply_patch,不會讓 exec 變成唯讀。
透過 process 支援前景與背景執行。如果不允許 process,exec 會同步執行並忽略 yieldMs/background。
背景工作階段以每個 agent 為範圍;process 只會看到同一個 agent 的工作階段。
參數
要執行的 Shell 命令。
命令的工作目錄。
合併到繼承環境之上的鍵/值環境覆寫。
在此延遲時間後自動將命令移至背景(毫秒)。
立即將命令移至背景,而不是等待
yieldMs。覆寫此呼叫已設定的 exec 逾時。只有在命令應該不受 exec 程序逾時限制執行時,才設定
timeout: 0。可用時在偽終端機中執行。適用於僅支援 TTY 的 CLI、程式代理與終端機 UI。
執行位置。當沙盒執行環境處於作用中時,
auto 會解析為 sandbox,否則解析為 gateway。一般工具呼叫會忽略此項。
gateway / node 安全性由
tools.exec.security 和 ~/.openclaw/exec-approvals.json 控制;提升權限模式只有在操作者明確授予提升存取權時,才能強制 security=full。gateway / node 執行的核准提示行為。當
host=node 時的 Node 識別碼/名稱。要求提升權限模式 — 逃出沙盒並進入設定的主機路徑。只有在提升權限解析為
full 時,才會強制 security=full。host預設為auto:當沙盒執行環境在此工作階段中處於作用中時使用沙盒,否則使用 Gateway。host只接受auto、sandbox、gateway或node。它不是主機名稱選擇器;類似主機名稱的值會在命令執行前被拒絕。auto是預設路由策略,不是萬用字元。從auto允許逐次呼叫指定host=node;只有在沒有作用中的沙盒執行環境時,才允許逐次呼叫指定host=gateway。- 沒有額外設定時,
host=auto仍然「可直接運作」:沒有沙盒時會解析為gateway;有即時沙盒時則留在沙盒中。 elevated會逃出沙盒並進入設定的主機路徑:預設為gateway,或當tools.exec.host=node(或工作階段預設為host=node)時使用node。它只有在目前工作階段/提供者啟用提升存取權時才可用。gateway/node核准由~/.openclaw/exec-approvals.json控制。node需要已配對的 Node(配套應用程式或無頭 Node 主機)。- 如果有多個 Node 可用,請設定
exec.node或tools.exec.node來選取其中一個。 exec host=node是 Node 的唯一 shell 執行路徑;舊版nodes.run包裝器已移除。timeout適用於前景、背景、yieldMs、Gateway、沙盒與 Nodesystem.run執行。如果省略,OpenClaw 會使用tools.exec.timeoutSec;明確指定timeout: 0會停用該次呼叫的 exec 程序逾時。- 在非 Windows 主機上,exec 會在已設定時使用
SHELL;如果SHELL是fish,它會優先從PATH使用bash(或sh) 以避免 fish 不相容的指令碼,若兩者都不存在,才會退回使用SHELL。 - 在 Windows 主機上,exec 會優先探索 PowerShell 7 (
pwsh)(Program Files、ProgramW6432,然後 PATH), 接著退回使用 Windows PowerShell 5.1。 - 主機執行(
gateway/node)會拒絕env.PATH和載入器覆寫(LD_*/DYLD_*),以 防止二進位劫持或注入程式碼。 - OpenClaw 會在產生的命令環境(包含 PTY 和沙盒執行)中設定
OPENCLAW_SHELL=exec,讓 shell/profile 規則可偵測 exec 工具情境。 openclaw channels login會被exec封鎖,因為它是互動式 channel 驗證流程;請在 Gateway 主機的終端機中執行,或在存在 channel 原生登入工具時從聊天使用該工具。- 重要:沙盒預設為關閉。如果沙盒關閉,隱含的
host=auto會解析為gateway。明確指定host=sandbox仍會安全失敗,而不是靜默地 在 Gateway 主機上執行。請啟用沙盒,或搭配核准使用host=gateway。 - 指令碼預先檢查(針對常見的 Python/Node shell 語法錯誤)只會檢查有效
workdir邊界內的檔案。如果指令碼路徑解析到workdir外部,該檔案會略過預先檢查。 - 對於現在開始的長時間工作,請只啟動一次,並在啟用時依賴命令輸出或失敗所觸發的自動
完成喚醒。
使用
process取得記錄、狀態、輸入或進行介入;不要用睡眠迴圈、逾時迴圈或重複輪詢來模擬排程。 - 對於應在稍後或依排程發生的工作,請使用 cron,而不是
exec睡眠/延遲模式。
設定
tools.exec.notifyOnExit(預設:true):為 true 時,背景化的 exec 工作階段會在結束時排入系統事件並要求 Heartbeat。tools.exec.approvalRunningNoticeMs(預設:10000):當需要核准的 exec 執行時間超過此值時,發出單一「running」通知(0 會停用)。tools.exec.timeoutSec(預設:1800):每個命令的預設 exec 逾時秒數。逐次呼叫的timeout會覆寫它;逐次呼叫的timeout: 0會停用 exec 程序逾時。tools.exec.host(預設:auto;當沙盒執行環境處於作用中時解析為sandbox,否則解析為gateway)tools.exec.security(預設:沙盒為deny,未設定時 Gateway + Node 為full)tools.exec.ask(預設:off)- 無需核准的主機 exec 是 Gateway + Node 的預設值。如果你想要核准/允許清單行為,請同時收緊
tools.exec.*和主機~/.openclaw/exec-approvals.json;請參閱 Exec 核准。 - YOLO 來自主機政策預設值(
security=full、ask=off),不是來自host=auto。如果你想強制 Gateway 或 Node 路由,請設定tools.exec.host或使用/exec host=...。 - 在
security=full加上ask=off模式中,主機 exec 會直接遵循已設定的政策;沒有額外的啟發式命令混淆預先篩選,也沒有指令碼預先檢查拒絕層。 tools.exec.node(預設:未設定)tools.exec.strictInlineEval(預設:false):為 true 時,行內直譯器 eval 形式,例如python -c、node -e、ruby -e、perl -e、php -r、lua -e和osascript -e一律需要明確核准。allow-always仍可持久保存良性的直譯器/指令碼呼叫,但行內 eval 形式每次仍會提示。tools.exec.commandHighlighting(預設:false):為 true 時,核准提示可在命令文字中醒目顯示由剖析器衍生的命令範圍。全域或針對每個 agent 設定為true,即可在不變更 exec 核准政策的情況下啟用命令文字醒目提示。tools.exec.pathPrepend:要前置到 exec 執行PATH的目錄清單(僅 Gateway + 沙盒)。tools.exec.safeBins:僅限 stdin 的安全二進位,可在沒有明確允許清單項目的情況下執行。關於行為細節,請參閱安全二進位。tools.exec.safeBinTrustedDirs:額外明確信任的目錄,用於safeBins路徑檢查。PATH項目絕不會自動被信任。內建預設值是/bin和/usr/bin。tools.exec.safeBinProfiles:每個安全二進位的選用自訂 argv 政策(minPositional、maxPositional、allowedValueFlags、deniedFlags)。
PATH 處理
host=gateway:將你的登入 shellPATH合併到 exec 環境中。主機執行會拒絕env.PATH覆寫。守護程式本身仍會以最小PATH執行:- macOS:
/opt/homebrew/bin、/usr/local/bin、/usr/bin、/bin - Linux:
/usr/local/bin、/usr/bin、/bin
- macOS:
host=sandbox:在容器內執行sh -lc(登入 shell),因此/etc/profile可能會重設PATH。 OpenClaw 會在 profile 載入後透過內部環境變數前置env.PATH(無 shell 插值);tools.exec.pathPrepend也會套用於此。host=node:只會將你傳入且未被封鎖的環境覆寫傳送到 Node。主機執行會拒絕env.PATH覆寫,Node 主機也會忽略它們。如果你需要在 Node 上新增 PATH 項目, 請設定 Node 主機服務環境(systemd/launchd)或將工具安裝到標準位置。
工作階段覆寫(/exec)
使用 /exec 設定 host、security、ask 和 node 的每個工作階段預設值。
不帶參數傳送 /exec 可顯示目前值。
範例:
授權模型
/exec 只會對已授權寄件者生效(channel 允許清單/配對加上 commands.useAccessGroups)。
它只會更新工作階段狀態,不會寫入設定。若要硬性停用 exec,請透過工具
政策拒絕它(tools.deny: ["exec"] 或針對每個 agent)。除非你明確設定
security=full 和 ask=off,否則主機核准仍會套用。
Exec 核准(配套應用程式 / Node 主機)
沙盒化 agent 可要求在exec 於 Gateway 或 Node 主機執行前進行逐次請求核准。
請參閱 Exec 核准 以了解政策、允許清單和 UI 流程。
需要核准時,exec 工具會立即傳回
status: "approval-pending" 和核准識別碼。核准後(或拒絕 / 逾時後),
Gateway 會發出系統事件(Exec finished / Exec denied)。如果命令在 tools.exec.approvalRunningNoticeMs 後仍在執行,會發出單一 Exec running 通知。
在具有原生核准卡片/按鈕的 channel 上,agent 應優先依賴該
原生 UI,且只有在工具結果明確表示聊天核准不可用,或手動核准是唯一路徑時,才包含手動 /approve 命令。
允許清單 + 安全二進位
手動允許清單執行會比對已解析的二進位路徑 glob 和裸命令名稱 glob。裸名稱只會比對透過 PATH 呼叫的命令,因此當命令是rg 時,rg 可比對
/opt/homebrew/bin/rg,但不會比對 ./rg 或 /tmp/rg。
當 security=allowlist 時,只有在每個管線
片段都在允許清單中或是安全二進位時,shell 命令才會自動允許。串接(;、&&、||)和重新導向
在允許清單模式中會被拒絕,除非每個頂層片段都滿足
允許清單(包含安全二進位)。重新導向仍不受支援。
持久的 allow-always 信任不會繞過該規則:串接命令仍要求每個
頂層片段都符合。
autoAllowSkills 是 exec 核准中的另一條便利路徑。它不同於
手動路徑允許清單項目。若要嚴格的明確信任,請保持 autoAllowSkills 停用。
將這兩個控制項用於不同工作:
tools.exec.safeBins:小型、僅限 stdin 的串流篩選器。tools.exec.safeBinTrustedDirs:safe-bin 可執行檔路徑的明確額外信任目錄。tools.exec.safeBinProfiles:自訂 safe bins 的明確 argv 政策。- 允許清單:對可執行檔路徑的明確信任。
safeBins 視為通用允許清單,也不要加入直譯器/執行階段二進位檔(例如 python3、node、ruby、bash)。如果需要這些項目,請使用明確的允許清單項目,並保持啟用核准提示。
當直譯器/執行階段 safeBins 項目缺少明確設定檔時,openclaw security audit 會發出警告,而 openclaw doctor --fix 可以搭建缺少的自訂 safeBinProfiles 項目。
當你明確將 jq 這類廣泛行為的 bin 加回 safeBins 時,openclaw security audit 和 openclaw doctor 也會發出警告。
如果你明確允許列出直譯器,請啟用 tools.exec.strictInlineEval,讓內嵌程式碼 eval 形式仍然需要新的核准。
如需完整政策詳細資料與範例,請參閱執行核准和安全 bin 與允許清單。
範例
前景:apply_patch
apply_patch 是 exec 的子工具,用於結構化多檔案編輯。
它預設會對 OpenAI 和 OpenAI Codex 模型啟用。只有在你想停用它或限制為特定模型時,才使用設定:
- 僅適用於 OpenAI/OpenAI Codex 模型。
- 工具政策仍然適用;
allow: ["write"]會隱含允許apply_patch。 deny: ["write"]不會拒絕apply_patch;請明確拒絕apply_patch,或在也應封鎖修補寫入時使用deny: ["group:fs"]。- 設定位於
tools.exec.applyPatch底下。 tools.exec.applyPatch.enabled預設為true;將它設為false可對 OpenAI 模型停用此工具。tools.exec.applyPatch.workspaceOnly預設為true(限制在工作區內)。只有在你有意讓apply_patch寫入/刪除工作區目錄外部時,才將它設為false。