Chuyển đến nội dung chính

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.

OpenClaw chạy các lệnh shell thông qua công cụ 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ày
  • background (bool): chuyển sang nền ngay lập tức
  • timeout (giây, mặc định tools.exec.timeoutSec): kết thúc tiến trình sau thời gian chờ này; chỉ đặt timeout: 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 (gateway theo mặc định, hoặc node khi đích exec là node)
  • Cần TTY thật? Đặt pty: true.
  • workdir, env
Hành vi:
  • 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" + 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ệnh 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 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 sleep hay 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)
Cấu hình (ưu tiên):
  • 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ấ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 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ọn eof)
  • send-keys: gửi token phím hoặc byte tường minh đến phiên được hỗ trợ bởi PTY
  • submit: gửi Enter / carriage return đến 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ế độ dán có ngoặc
  • 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: kill nếu đang chạy, nếu không thì clear nếu đã hoàn tất
Ghi chú:
  • 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/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 hoàn tất tự động không có sẵn.
  • Dùng log trướ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 / kill khi bạn cần đầu vào hoặc can thiệp.
  • process list bao gồm name được suy ra (động từ lệnh + đích) để quét nhanh.
  • process list, poll, và log chỉ báo cáo waitingForInput khi phiên vẫn có stdin ghi được và đã nhàn rỗi lâu hơn ngưỡng chờ đầu vào.
  • process log dùng offset/limit theo dòng.
  • Khi bỏ qua cả offsetlimit, nó trả về 200 dòng cuối và bao gồm gợi ý phân trang.
  • Khi cung cấp offset và bỏ qua limit, 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ế.

Ví dụ

Chạy một tác vụ dài và thăm dò sau:
{ "tool": "exec", "command": "sleep 5 && echo done", "yieldMs": 1000 }
{ "tool": "process", "action": "poll", "sessionId": "<id>" }
Kiểm tra một phiên tương tác trước khi gửi đầu vào:
{ "tool": "process", "action": "log", "sessionId": "<id>" }
Bắt đầu ngay trong nền:
{ "tool": "exec", "command": "npm run build", "background": true }
Gửi stdin:
{ "tool": "process", "action": "write", "sessionId": "<id>", "data": "y\n" }
Gửi phím PTY:
{ "tool": "process", "action": "send-keys", "sessionId": "<id>", "keys": ["C-c"] }
Gửi dòng hiện tại:
{ "tool": "process", "action": "submit", "sessionId": "<id>" }
Dán văn bản nguyên văn:
{ "tool": "process", "action": "paste", "sessionId": "<id>", "text": "line1\nline2\n" }

Liên quan