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

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.

Chạy cầu nối Giao thức Máy khách Tác tử (ACP) giao tiếp với OpenClaw Gateway. Lệnh này giao tiếp bằng ACP qua stdio cho IDE và chuyển tiếp prompt đến Gateway qua WebSocket. Nó giữ các phiên ACP được ánh xạ với khóa phiên Gateway. openclaw acp là một cầu nối ACP dựa trên Gateway, không phải runtime trình biên tập ACP-native đầy đủ. Nó tập trung vào định tuyến phiên, phân phối prompt và các cập nhật streaming cơ bản. Nếu bạn muốn một máy khách MCP bên ngoài giao tiếp trực tiếp với các cuộc hội thoại kênh OpenClaw thay vì lưu trữ một phiên harness ACP, hãy dùng openclaw mcp serve thay thế.

​
Đây không phải là gì

Trang này thường bị nhầm với các phiên harness ACP. openclaw acp nghĩa là:
  • OpenClaw hoạt động như một máy chủ ACP
  • một IDE hoặc máy khách ACP kết nối đến OpenClaw
  • OpenClaw chuyển tiếp công việc đó vào một phiên Gateway
Điều này khác với Tác tử ACP, nơi OpenClaw chạy một harness bên ngoài như Codex hoặc Claude Code thông qua acpx. Quy tắc nhanh:
  • trình biên tập/máy khách muốn giao tiếp ACP với OpenClaw: dùng openclaw acp
  • OpenClaw cần khởi chạy Codex/Claude/Gemini như một harness ACP: dùng /acp spawn và Tác tử ACP

​
Ma trận tương thích

Khu vực ACPTrạng tháiGhi chú
initialize, newSession, prompt, cancelĐã triển khaiLuồng cầu nối cốt lõi qua stdio đến Gateway chat/send + abort.
listSessions, lệnh gạch chéoĐã triển khaiDanh sách phiên hoạt động dựa trên trạng thái phiên Gateway; các lệnh được quảng bá qua available_commands_update.
loadSessionMột phầnLiên kết lại phiên ACP với khóa phiên Gateway và phát lại lịch sử văn bản người dùng/trợ lý đã lưu. Lịch sử công cụ/hệ thống chưa được tái dựng.
Nội dung prompt (text, resource nhúng, hình ảnh)Một phầnVăn bản/tài nguyên được làm phẳng vào đầu vào chat; hình ảnh trở thành tệp đính kèm Gateway.
Chế độ phiênMột phầnsession/set_mode được hỗ trợ và cầu nối hiển thị các điều khiển phiên ban đầu dựa trên Gateway cho mức suy nghĩ, độ chi tiết công cụ, reasoning, chi tiết usage và hành động nâng quyền. Các bề mặt chế độ/cấu hình ACP-native rộng hơn vẫn nằm ngoài phạm vi.
Thông tin phiên và cập nhật usageMột phầnCầu nối phát thông báo session_info_update và usage_update theo nỗ lực tốt nhất từ ảnh chụp nhanh phiên Gateway đã lưu đệm. Usage mang tính xấp xỉ và chỉ được gửi khi tổng token của Gateway được đánh dấu là mới.
Streaming công cụMột phầnSự kiện tool_call / tool_call_update bao gồm I/O thô, nội dung văn bản và vị trí tệp theo nỗ lực tốt nhất khi đối số/kết quả công cụ Gateway hiển thị chúng. Terminal nhúng và đầu ra diff-native phong phú hơn vẫn chưa được hiển thị.
Máy chủ MCP theo phiên (mcpServers)Không hỗ trợChế độ cầu nối từ chối yêu cầu máy chủ MCP theo phiên. Thay vào đó, hãy cấu hình MCP trên OpenClaw gateway hoặc tác tử.
Phương thức hệ thống tệp của máy khách (fs/read_text_file, fs/write_text_file)Không hỗ trợCầu nối không gọi các phương thức hệ thống tệp của máy khách ACP.
Phương thức terminal của máy khách (terminal/*)Không hỗ trợCầu nối không tạo terminal máy khách ACP hoặc stream id terminal thông qua lời gọi công cụ.
Kế hoạch phiên / streaming suy nghĩKhông hỗ trợCầu nối hiện phát văn bản đầu ra và trạng thái công cụ, không phải kế hoạch ACP hoặc cập nhật suy nghĩ.

​
Giới hạn đã biết

  • loadSession phát lại lịch sử văn bản người dùng và trợ lý đã lưu, nhưng không tái dựng các lời gọi công cụ lịch sử, thông báo hệ thống hoặc các loại sự kiện ACP-native phong phú hơn.
  • Nếu nhiều máy khách ACP chia sẻ cùng một khóa phiên Gateway, định tuyến sự kiện và hủy sẽ theo nỗ lực tốt nhất thay vì được cô lập nghiêm ngặt theo từng máy khách. Hãy ưu tiên các phiên acp:<uuid> cô lập mặc định khi bạn cần các lượt cục bộ theo trình biên tập sạch.
  • Trạng thái dừng Gateway được chuyển đổi thành lý do dừng ACP, nhưng ánh xạ đó kém biểu đạt hơn một runtime ACP-native đầy đủ.
  • Các điều khiển phiên ban đầu hiện hiển thị một tập con tập trung của các núm điều chỉnh Gateway: mức suy nghĩ, độ chi tiết công cụ, reasoning, chi tiết usage và hành động nâng quyền. Lựa chọn model và điều khiển máy chủ exec chưa được hiển thị dưới dạng tùy chọn cấu hình ACP.
  • session_info_update và usage_update được suy ra từ ảnh chụp nhanh phiên Gateway, không phải kế toán runtime ACP-native trực tiếp. Usage mang tính xấp xỉ, không mang dữ liệu chi phí và chỉ được phát khi Gateway đánh dấu dữ liệu tổng token là mới.
  • Dữ liệu theo dõi công cụ là theo nỗ lực tốt nhất. Cầu nối có thể hiển thị đường dẫn tệp xuất hiện trong đối số/kết quả công cụ đã biết, nhưng chưa phát terminal ACP hoặc diff tệp có cấu trúc.

​
Cách dùng

openclaw acp

# Remote Gateway
openclaw acp --url wss://gateway-host:18789 --token <token>

# Remote Gateway (token from file)
openclaw acp --url wss://gateway-host:18789 --token-file ~/.openclaw/gateway.token

# Attach to an existing session key
openclaw acp --session agent:main:main

# Attach by label (must already exist)
openclaw acp --session-label "support inbox"

# Reset the session key before the first prompt
openclaw acp --session agent:main:main --reset-session

​
Máy khách ACP (gỡ lỗi)

Dùng máy khách ACP tích hợp để kiểm tra nhanh cầu nối mà không cần IDE. Nó sinh cầu nối ACP và cho phép bạn nhập prompt tương tác. 
openclaw acp client

# Point the spawned bridge at a remote Gateway
openclaw acp client --server-args --url wss://gateway-host:18789 --token-file ~/.openclaw/gateway.token

# Override the server command (default: openclaw)
openclaw acp client --server "node" --server-args openclaw.mjs acp --url ws://127.0.0.1:19001
Mô hình quyền (chế độ gỡ lỗi máy khách):
  • Tự động phê duyệt dựa trên allowlist và chỉ áp dụng cho ID công cụ lõi đáng tin cậy.
  • Tự động phê duyệt read được giới hạn trong thư mục làm việc hiện tại (--cwd khi được đặt).
  • ACP chỉ tự động phê duyệt các lớp chỉ đọc hẹp: lời gọi read có phạm vi dưới cwd đang hoạt động cùng với công cụ tìm kiếm chỉ đọc (search, web_search, memory_search). Công cụ không rõ/không phải lõi, lượt đọc ngoài phạm vi, công cụ có khả năng exec, công cụ mặt phẳng điều khiển, công cụ thay đổi trạng thái và luồng tương tác luôn yêu cầu phê duyệt prompt rõ ràng.
  • toolCall.kind do máy chủ cung cấp được xem là siêu dữ liệu không đáng tin cậy (không phải nguồn ủy quyền).
  • Chính sách cầu nối ACP này tách biệt với quyền harness ACPX. Nếu bạn chạy OpenClaw thông qua backend acpx, plugins.entries.acpx.config.permissionMode=approve-all là công tắc “yolo” phá kính cho phiên harness đó.

​
Cách sử dụng phần này

Dùng ACP khi một IDE (hoặc máy khách khác) giao tiếp bằng Agent Client Protocol và bạn muốn nó điều khiển một phiên OpenClaw Gateway.
  1. Đảm bảo Gateway đang chạy (cục bộ hoặc từ xa).
  2. Cấu hình mục tiêu Gateway (cấu hình hoặc cờ).
  3. Trỏ IDE của bạn để chạy openclaw acp qua stdio.
Cấu hình ví dụ (được lưu): 
openclaw config set gateway.remote.url wss://gateway-host:18789
openclaw config set gateway.remote.token <token>
Ví dụ chạy trực tiếp (không ghi cấu hình): 
openclaw acp --url wss://gateway-host:18789 --token <token>
# preferred for local process safety
openclaw acp --url wss://gateway-host:18789 --token-file ~/.openclaw/gateway.token

​
Chọn tác tử

ACP không chọn tác tử trực tiếp. Nó định tuyến theo khóa phiên Gateway. Dùng khóa phiên theo phạm vi tác tử để nhắm đến một tác tử cụ thể: 
openclaw acp --session agent:main:main
openclaw acp --session agent:design:main
openclaw acp --session agent:qa:bug-123
Mỗi phiên ACP ánh xạ đến một khóa phiên Gateway duy nhất. Một tác tử có thể có nhiều phiên; ACP mặc định dùng phiên acp:<uuid> cô lập trừ khi bạn ghi đè khóa hoặc nhãn. mcpServers theo phiên không được hỗ trợ trong chế độ cầu nối. Nếu một máy khách ACP gửi chúng trong newSession hoặc loadSession, cầu nối trả về lỗi rõ ràng thay vì âm thầm bỏ qua. Nếu bạn muốn các phiên dựa trên ACPX thấy công cụ Plugin OpenClaw hoặc các công cụ tích hợp được chọn như cron, hãy bật các cầu nối MCP ACPX phía gateway thay vì cố truyền mcpServers theo phiên. Xem Tác tử ACP và cầu nối MCP công cụ OpenClaw.

​
Dùng từ acpx (Codex, Claude, các máy khách ACP khác)

Nếu bạn muốn một tác tử lập trình như Codex hoặc Claude Code giao tiếp với bot OpenClaw của bạn qua ACP, hãy dùng acpx với mục tiêu openclaw tích hợp sẵn. Luồng điển hình:
  1. Chạy Gateway và đảm bảo cầu nối ACP có thể tiếp cận nó.
  2. Trỏ acpx openclaw đến openclaw acp.
  3. Nhắm đến khóa phiên OpenClaw mà bạn muốn tác tử lập trình sử dụng.
Ví dụ: 
# One-shot request into your default OpenClaw ACP session
acpx openclaw exec "Summarize the active OpenClaw session state."

# Persistent named session for follow-up turns
acpx openclaw sessions ensure --name codex-bridge
acpx openclaw -s codex-bridge --cwd /path/to/repo \
  "Ask my OpenClaw work agent for recent context relevant to this repo."
Nếu bạn muốn acpx openclaw nhắm đến một Gateway và khóa phiên cụ thể mỗi lần, hãy ghi đè lệnh tác tử openclaw trong ~/.acpx/config.json: 
{
  "agents": {
    "openclaw": {
      "command": "env OPENCLAW_HIDE_BANNER=1 OPENCLAW_SUPPRESS_NOTES=1 openclaw acp --url ws://127.0.0.1:18789 --token-file ~/.openclaw/gateway.token --session agent:main:main"
    }
  }
}
Đối với một checkout OpenClaw cục bộ theo repo, hãy dùng entrypoint CLI trực tiếp thay vì dev runner để stream ACP luôn sạch. Ví dụ: 
env OPENCLAW_HIDE_BANNER=1 OPENCLAW_SUPPRESS_NOTES=1 node openclaw.mjs acp ...
Đây là cách dễ nhất để Codex, Claude Code hoặc máy khách khác hiểu ACP lấy thông tin ngữ cảnh từ một tác tử OpenClaw mà không cần scrape terminal.

​
Thiết lập trình biên tập Zed

Thêm một tác tử ACP tùy chỉnh trong ~/.config/zed/settings.json (hoặc dùng Giao diện cài đặt của Zed): 
{
  "agent_servers": {
    "OpenClaw ACP": {
      "type": "custom",
      "command": "openclaw",
      "args": ["acp"],
      "env": {}
    }
  }
}
Để nhắm tới một Gateway hoặc agent cụ thể: 
{
  "agent_servers": {
    "OpenClaw ACP": {
      "type": "custom",
      "command": "openclaw",
      "args": [
        "acp",
        "--url",
        "wss://gateway-host:18789",
        "--token",
        "<token>",
        "--session",
        "agent:design:main"
      ],
      "env": {}
    }
  }
}
Trong Zed, mở bảng Agent và chọn “OpenClaw ACP” để bắt đầu một luồng.

​
Ánh xạ phiên

Theo mặc định, các phiên ACP nhận một khóa phiên Gateway biệt lập với tiền tố acp:. Để dùng lại một phiên đã biết, hãy truyền khóa phiên hoặc nhãn:
  • --session <key>: dùng một khóa phiên Gateway cụ thể.
  • --session-label <label>: phân giải một phiên hiện có theo nhãn.
  • --reset-session: tạo một id phiên mới cho khóa đó (cùng khóa, transcript mới).
Nếu client ACP của bạn hỗ trợ siêu dữ liệu, bạn có thể ghi đè theo từng phiên: 
{
  "_meta": {
    "sessionKey": "agent:main:main",
    "sessionLabel": "support inbox",
    "resetSession": true
  }
}
Tìm hiểu thêm về khóa phiên tại /concepts/session.

​
Tùy chọn

  • --url <url>: URL WebSocket của Gateway (mặc định là gateway.remote.url khi được cấu hình).
  • --token <token>: token xác thực Gateway.
  • --token-file <path>: đọc token xác thực Gateway từ tệp.
  • --password <password>: mật khẩu xác thực Gateway.
  • --password-file <path>: đọc mật khẩu xác thực Gateway từ tệp.
  • --session <key>: khóa phiên mặc định.
  • --session-label <label>: nhãn phiên mặc định cần phân giải.
  • --require-existing: thất bại nếu khóa/nhãn phiên không tồn tại.
  • --reset-session: đặt lại khóa phiên trước lần sử dụng đầu tiên.
  • --no-prefix-cwd: không thêm tiền tố thư mục làm việc vào prompt.
  • --provenance <off|meta|meta+receipt>: bao gồm siêu dữ liệu hoặc biên nhận nguồn gốc ACP.
  • --verbose, -v: ghi log chi tiết vào stderr.
Ghi chú bảo mật:
  • --token và --password có thể hiển thị trong danh sách tiến trình cục bộ trên một số hệ thống.
  • Ưu tiên --token-file/--password-file hoặc biến môi trường (OPENCLAW_GATEWAY_TOKEN, OPENCLAW_GATEWAY_PASSWORD).
  • Cách phân giải xác thực Gateway tuân theo hợp đồng dùng chung được các client Gateway khác sử dụng:
    • chế độ cục bộ: env (OPENCLAW_GATEWAY_*) -> gateway.auth.* -> dự phòng gateway.remote.* chỉ khi chưa đặt gateway.auth.* (SecretRefs cục bộ đã cấu hình nhưng chưa phân giải sẽ bị từ chối an toàn)
    • chế độ từ xa: gateway.remote.* với dự phòng env/config theo quy tắc ưu tiên từ xa
    • --url là ghi đè an toàn và không dùng lại thông tin xác thực config/env ngầm định; hãy truyền rõ ràng --token/--password (hoặc các biến thể tệp)
  • Các tiến trình con backend runtime ACP nhận OPENCLAW_SHELL=acp, có thể dùng cho các quy tắc shell/profile theo ngữ cảnh.
  • openclaw acp client đặt OPENCLAW_SHELL=acp-client trên tiến trình cầu nối được sinh ra.

​
Tùy chọn acp client

  • --cwd <dir>: thư mục làm việc cho phiên ACP.
  • --server <command>: lệnh máy chủ ACP (mặc định: openclaw).
  • --server-args <args...>: đối số bổ sung được truyền cho máy chủ ACP.
  • --server-verbose: bật ghi log chi tiết trên máy chủ ACP.
  • --verbose, -v: ghi log client chi tiết.

​
Liên quan