OpenClaw chạy các lệnh shell thông qua công cụ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 và giữ các tác vụ chạy lâu trong bộ nhớ. Công cụ process quản lý các phiên nền đó.
Công cụ exec
Các tham số chính:command(bắt buộc)yieldMs(mặc định 10000): tự động chuyển sang nền sau độ trễ nàybackground(bool): chuyển sang nền ngay lập tứctimeout(giây, mặc địnhtools.exec.timeoutSec): kết thúc tiến trình sau thời gian chờ này; chỉ đặttimeout: 0để vô hiệu hóa thời gian chờ của tiến trình exec cho lệnh gọi đóelevated(bool): chạy bên ngoài sandbox nếu chế độ nâng quyền được bật/cho phép (gatewaytheo mặc định, hoặcnodekhi đích exec lànode)- Cần TTY thật? Đặt
pty: true. workdir,env
- Các lần chạy tiền cảnh trả về đầu ra trực tiếp.
- Khi được chuyển sang nền (tường minh hoặc do hết thời gian chờ), công cụ trả về
status: "running"+sessionIdvà một đoạn cuối ngắn. - Các lần chạy nền và
yieldMskế thừatools.exec.timeoutSectrừ khi lệnh gọi cung cấptimeouttườ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ụ
processkhông được phép,execchạy đồng bộ và bỏ quayieldMs/background. - Các lệnh exec được sinh ra nhận
OPENCLAW_SHELL=execcho 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 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 không có cơ chế đánh thức hoàn tất tự độ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 nhắc việc hoặc theo dõi trễ bằng các vòng lặp
sleephay thăm dò lặp lại; dùng cron cho công việc trong tương lai.
Bắc cầu tiến trình con
Khi sinh các tiến trình con chạy lâu bên ngoài các công cụ exec/process (ví dụ: CLI sinh lại hoặc trình trợ giúp gateway), hãy gắn trình trợ giúp cầu nối tiến trình con để tín hiệu kết thúc được chuyển tiếp và listener được tách ra khi thoát/lỗi. Việc này tránh các tiến trình mồ côi trên systemd và giữ hành vi tắt nhất quán trên các nền tảng. Ghi đè môi trường:PI_BASH_YIELD_MS: thời gian 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 luồng (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)OPENCLAW_PROCESS_INPUT_WAIT_IDLE_MS: ngưỡng đầu ra nhàn rỗi trước khi các phiên nền có thể ghi được đánh dấu là có khả năng đang chờ đầu vào (mặc định 15000 ms)
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
Hành động:list: các phiên đang chạy + đã hoàn tấtpoll: 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 và hiển thị gợi ý khôi phục đầu vào (hỗ trợoffset+limit)write: gửi stdin (data, tùy chọneof)send-keys: gửi token phím hoặc byte tường minh đến phiên được hỗ trợ bởi PTYsubmit: gửi Enter / carriage return đến phiên được hỗ trợ bởi PTYpaste: gửi văn bản nguyên văn, tùy chọn bọc trong chế độ dán có ngoặckill: kết thúc một phiên nềnclear: xóa một phiên đã hoàn tất khỏi bộ nhớremove: kill nếu đang chạy, nếu không thì clear nếu đã hoàn tất
- Chỉ các phiên được chuyển sang nền mới được liệt kê/lưu giữ trong bộ nhớ.
- Các 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ử chat nếu bạn chạy
process poll/logvà 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/logcho 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 hoàn tất tự động không có sẵn. - Dùng
logtrước khi khôi phục CLI tương tác để transcript hiện tại, trạng thái stdin và gợi ý chờ đầu vào hiển thị cùng nhau. - Dùng
write/send-keys/submit/paste/killkhi bạn cần đầu vào hoặc can thiệp. process listbao gồmnameđược suy ra (động từ lệnh + đích) để quét nhanh.process list,poll, vàlogchỉ báo cáowaitingForInputkhi phiên vẫn có stdin ghi được và đã nhàn rỗi lâu hơn ngưỡng chờ đầu vào.process logdùngoffset/limittheo dòng.- Khi bỏ qua cả
offsetvàlimit, nó trả về 200 dòng cuối và bao gồm gợi ý phân trang. - Khi cung cấp
offsetvà bỏ qualimit, nó trả về từoffsetđến cuối (không giới hạn ở 200). - Việc thăm dò dành 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 xảy ra sau, hãy dùng cron thay thế.