Documentation Index

Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

​

Exec nền + Công cụ process

​

Công cụ exec

• command (bắt buộc)
• yieldMs (mặc định 10000): tự động chuyển sang nền sau độ trễ này
• background (bool): chuyển sang nền ngay lập tức
• timeout (giây, mặc định tools.exec.timeoutSec): hủy tiến trình sau thời hạn này; chỉ đặt timeout: 0 để tắt thời hạn tiến trình exec cho lần gọi đó
• elevated (bool): chạy bên ngoài sandbox nếu chế độ đặc quyền được bật/cho phép (gateway theo mặc định, hoặc node khi mục tiêu exec là node)
• Cần TTY thật? Đặt pty: true.
• workdir, env

• Các lần chạy foreground trả về đầu ra trực tiếp.
• Khi được chuyển sang nền (tường minh hoặc do timeout), công cụ trả về status: "running" + sessionId và một đoạn cuối ngắn.
• Các lần chạy nền và yieldMs kế thừa tools.exec.timeoutSec trừ khi lần gọi cung cấp timeout tường minh.
• Đầu ra được giữ trong bộ nhớ cho đến khi phiên được thăm dò hoặc xóa.
• Nếu công cụ process không được phép, exec chạy đồng bộ và bỏ qua yieldMs/background.
• Các lệnh exec được sinh ra nhận OPENCLAW_SHELL=exec cho các quy tắc shell/profile nhận biết ngữ cảnh.
• Với công việc chạy lâu bắt đầu ngay bây giờ, hãy khởi động một lần và dựa vào cơ chế đánh thức khi hoàn tất tự động khi nó được bật và lệnh phát ra đầu ra hoặc thất bại.
• Nếu cơ chế đánh thức khi hoàn tất tự động không khả dụng, hoặc bạn cần xác nhận thành công im lặng cho một lệnh đã thoát sạch mà không có đầu ra, hãy dùng process để xác nhận hoàn tất.
• Không mô phỏng lời nhắc hoặc theo dõi trễ bằng vòng lặp sleep hay thăm dò lặp lại; dùng cron cho công việc trong tương lai.

​

Cầu nối tiến trình con

• PI_BASH_YIELD_MS: yield mặc định (ms)
• PI_BASH_MAX_OUTPUT_CHARS: giới hạn đầu ra trong bộ nhớ (ký tự)
• OPENCLAW_BASH_PENDING_MAX_OUTPUT_CHARS: giới hạn stdout/stderr đang chờ cho mỗi stream (ký tự)
• PI_BASH_JOB_TTL_MS: TTL cho các phiên đã hoàn tất (ms, giới hạn trong 1m–3h)

• tools.exec.backgroundMs (mặc định 10000)
• tools.exec.timeoutSec (mặc định 1800)
• tools.exec.cleanupMs (mặc định 1800000)
• tools.exec.notifyOnExit (mặc định true): đưa một sự kiện hệ thống vào hàng đợi + yêu cầu Heartbeat khi một exec chạy nền thoát.
• tools.exec.notifyOnExitEmptySuccess (mặc định false): khi true, cũng đưa các sự kiện hoàn tất vào hàng đợi cho các lần chạy nền thành công nhưng không tạo đầu ra.

​

Công cụ process

• list: các phiên đang chạy + đã hoàn tất
• poll: rút đầu ra mới cho một phiên (cũng báo cáo trạng thái thoát)
• log: đọc đầu ra tổng hợp (hỗ trợ offset + limit)
• write: gửi stdin (data, tùy chọn eof)
• send-keys: gửi token phím hoặc byte tường minh tới phiên được hỗ trợ bởi PTY
• submit: gửi Enter / carriage return tới phiên được hỗ trợ bởi PTY
• paste: gửi văn bản nguyên văn, tùy chọn bọc trong chế độ bracketed paste
• kill: kết thúc một phiên nền
• clear: xóa một phiên đã hoàn tất khỏi bộ nhớ
• remove: hủy nếu đang chạy, nếu không thì xóa nếu đã hoàn tất

• Chỉ các phiên đã chuyển sang nền mới được liệt kê/lưu trong bộ nhớ.
• Phiên bị mất khi tiến trình khởi động lại (không lưu bền trên đĩa).
• Nhật ký phiên chỉ được lưu vào lịch sử trò chuyện nếu bạn chạy process poll/log và kết quả công cụ được ghi lại.
• process được giới hạn theo từng agent; nó chỉ thấy các phiên do agent đó khởi động.
• Dùng poll / log cho trạng thái, nhật ký, xác nhận thành công im lặng, hoặc xác nhận hoàn tất khi cơ chế đánh thức khi hoàn tất tự động không khả dụng.
• Dùng write / send-keys / submit / paste / kill khi bạn cần nhập liệu hoặc can thiệp.
• process list bao gồm name được suy ra (động từ lệnh + mục tiêu) để quét nhanh.
• process log dùng offset/limit theo dòng.
• Khi cả offset và limit đều bị bỏ qua, nó trả về 200 dòng cuối và bao gồm gợi ý phân trang.
• Khi có offset và bỏ qua limit, nó trả về từ offset đến cuối (không giới hạn ở 200).
• Thăm dò dùng cho trạng thái theo yêu cầu, không phải lập lịch vòng lặp chờ. Nếu công việc nên diễn ra sau, hãy dùng cron thay thế.

​

Ví dụ

{ "tool": "exec", "command": "sleep 5 && echo done", "yieldMs": 1000 }

{ "tool": "process", "action": "poll", "sessionId": "<id>" }

{ "tool": "exec", "command": "npm run build", "background": true }

{ "tool": "process", "action": "write", "sessionId": "<id>", "data": "y\n" }

{ "tool": "process", "action": "send-keys", "sessionId": "<id>", "keys": ["C-c"] }

{ "tool": "process", "action": "submit", "sessionId": "<id>" }

{ "tool": "process", "action": "paste", "sessionId": "<id>", "text": "line1\nline2\n" }

​

Liên quan

• Công cụ exec
• Phê duyệt exec