ACP

Jalankan bridge Agent Client Protocol (ACP) yang berkomunikasi dengan OpenClaw Gateway. Perintah ini berbicara ACP melalui stdio untuk IDE dan meneruskan prompt ke Gateway melalui WebSocket. Perintah ini menjaga agar sesi ACP tetap dipetakan ke kunci sesi Gateway. openclaw acp adalah bridge ACP yang didukung Gateway, bukan runtime editor ACP-native penuh. Fokusnya adalah perutean sesi, pengiriman prompt, dan pembaruan streaming dasar. Jika Anda ingin klien MCP eksternal berbicara langsung dengan percakapan channel OpenClaw alih-alih menghosting sesi harness ACP, gunakan openclaw mcp serve.

Yang bukan ini

Halaman ini sering disalahartikan sebagai sesi harness ACP. openclaw acp berarti:

OpenClaw bertindak sebagai server ACP
IDE atau klien ACP terhubung ke OpenClaw
OpenClaw meneruskan pekerjaan tersebut ke sesi Gateway

Ini berbeda dari Agen ACP, tempat OpenClaw menjalankan harness eksternal seperti Codex atau Claude Code melalui acpx. Aturan singkat:

editor/klien ingin berbicara ACP ke OpenClaw: gunakan openclaw acp
OpenClaw harus meluncurkan Codex/Claude/Gemini sebagai harness ACP: gunakan /acp spawn dan Agen ACP

Matriks Kompatibilitas

Area ACP	Status	Catatan
`initialize`, `newSession`, `prompt`, `cancel`	Diimplementasikan	Alur bridge inti melalui stdio ke chat/send Gateway + abort.
`listSessions`, perintah slash	Diimplementasikan	Daftar sesi bekerja terhadap status sesi Gateway dengan paginasi kursor terbatas dan pemfilteran `cwd` ketika baris sesi Gateway membawa metadata workspace; perintah diumumkan melalui `available_commands_update`.
Metadata lineage sesi	Diimplementasikan	Daftar sesi dan snapshot info sesi menyertakan lineage induk dan anak OpenClaw di `_meta` sehingga klien ACP dapat merender grafik subagent tanpa side channel Gateway privat.
`resumeSession`, `closeSession`	Diimplementasikan	Resume mengikat ulang sesi ACP ke sesi Gateway yang sudah ada tanpa memutar ulang riwayat. Close membatalkan pekerjaan bridge aktif, menyelesaikan prompt tertunda sebagai dibatalkan, dan melepas status sesi bridge.
`loadSession`	Parsial	Mengikat ulang sesi ACP ke kunci sesi Gateway dan memutar ulang riwayat ledger event ACP untuk sesi yang dibuat bridge. Sesi lama/tanpa ledger fallback ke teks pengguna/asisten yang tersimpan.
Konten prompt (`text`, `resource` tertanam, gambar)	Parsial	Teks/resource diratakan menjadi input chat; gambar menjadi lampiran Gateway.
Mode sesi	Parsial	`session/set_mode` didukung dan bridge mengekspos kontrol sesi awal yang didukung Gateway untuk tingkat pemikiran, verbositas tool, penalaran, detail penggunaan, dan tindakan yang dinaikkan. Permukaan mode/config ACP-native yang lebih luas masih di luar cakupan.
Info sesi dan pembaruan penggunaan	Parsial	Bridge memancarkan notifikasi `session_info_update` dan `usage_update` best-effort dari snapshot sesi Gateway yang di-cache. Penggunaan bersifat perkiraan dan hanya dikirim ketika total token Gateway ditandai segar.
Streaming tool	Parsial	Event `tool_call` / `tool_call_update` menyertakan I/O mentah, konten teks, dan lokasi file best-effort ketika argumen/hasil tool Gateway mengeksposnya. Terminal tertanam dan output diff-native yang lebih kaya masih belum diekspos.
Persetujuan exec	Parsial	Prompt persetujuan exec Gateway selama giliran prompt ACP aktif diteruskan ke klien ACP dengan `session/request_permission`.
Server MCP per sesi (`mcpServers`)	Tidak didukung	Mode bridge menolak permintaan server MCP per sesi. Konfigurasikan MCP pada gateway atau agen OpenClaw sebagai gantinya.
Metode filesystem klien (`fs/read_text_file`, `fs/write_text_file`)	Tidak didukung	Bridge tidak memanggil metode filesystem klien ACP.
Metode terminal klien (`terminal/*`)	Tidak didukung	Bridge tidak membuat terminal klien ACP atau men-stream id terminal melalui panggilan tool.
Rencana sesi / streaming pemikiran	Tidak didukung	Bridge saat ini memancarkan teks output dan status tool, bukan pembaruan rencana atau pemikiran ACP.

Keterbatasan yang diketahui

loadSession dapat memutar ulang riwayat ledger event ACP lengkap hanya untuk sesi yang dibuat bridge. Sesi lama/tanpa ledger tetap menggunakan fallback transkrip dan tidak merekonstruksi panggilan tool historis atau pemberitahuan sistem.
Jika beberapa klien ACP berbagi kunci sesi Gateway yang sama, perutean event dan cancel bersifat best-effort, bukan terisolasi ketat per klien. Lebih baik gunakan sesi acp:<uuid> terisolasi default ketika Anda membutuhkan giliran editor-lokal yang bersih.
Status berhenti Gateway diterjemahkan menjadi alasan berhenti ACP, tetapi pemetaan itu kurang ekspresif dibandingkan runtime ACP-native penuh.
Kontrol sesi awal saat ini mengekspos subset knob Gateway yang terfokus: tingkat pemikiran, verbositas tool, penalaran, detail penggunaan, dan tindakan yang dinaikkan. Pemilihan model dan kontrol exec-host belum diekspos sebagai opsi config ACP.
session_info_update dan usage_update diturunkan dari snapshot sesi Gateway, bukan akuntansi runtime ACP-native langsung. Penggunaan bersifat perkiraan, tidak membawa data biaya, dan hanya dipancarkan ketika Gateway menandai data total token sebagai segar.
Data follow-along tool bersifat best-effort. Bridge dapat menampilkan path file yang muncul di argumen/hasil tool yang dikenal, tetapi belum memancarkan terminal ACP atau diff file terstruktur.
Relay persetujuan exec dibatasi pada giliran prompt ACP aktif; persetujuan dari sesi Gateway lain diabaikan.

Penggunaan

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

Klien ACP (debug)

Gunakan klien ACP bawaan untuk memeriksa kewajaran bridge tanpa IDE. Klien ini men-spawn bridge ACP dan memungkinkan Anda mengetik prompt secara interaktif.

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

Model izin (mode debug klien):

Persetujuan otomatis berbasis allowlist dan hanya berlaku untuk ID tool inti tepercaya.
Persetujuan otomatis read dibatasi ke direktori kerja saat ini (--cwd jika disetel).
ACP hanya menyetujui otomatis kelas readonly yang sempit: panggilan read terbatas di bawah cwd aktif plus tool pencarian readonly (search, web_search, memory_search). Tool tidak dikenal/non-inti, pembacaan di luar cakupan, tool berkemampuan exec, tool control-plane, tool yang memutasi, dan alur interaktif selalu memerlukan persetujuan prompt eksplisit.
toolCall.kind yang disediakan server diperlakukan sebagai metadata tidak tepercaya (bukan sumber otorisasi).
Kebijakan bridge ACP ini terpisah dari izin harness ACPX. Jika Anda menjalankan OpenClaw melalui backend acpx, plugins.entries.acpx.config.permissionMode=approve-all adalah sakelar “yolo” break-glass untuk sesi harness tersebut.

Smoke testing protokol

Untuk debugging tingkat protokol, mulai Gateway dengan status terisolasi dan kendalikan openclaw acp melalui stdio dengan klien JSON-RPC ACP. Cakup initialize, session/new, session/list dengan cwd absolut, session/resume, session/close, close duplikat, dan resume yang hilang. Bukti harus menyertakan kemampuan lifecycle yang diiklankan, baris sesi yang didukung Gateway, notifikasi pembaruan, dan log sessions.list Gateway:

{
  "initialize": {
    "protocolVersion": 1,
    "agentCapabilities": {
      "sessionCapabilities": {
        "list": {},
        "resume": {},
        "close": {}
      }
    }
  },
  "listSessions": {
    "sessions": [
      {
        "sessionId": "agent:main:acp-smoke",
        "cwd": "/path/to/workspace",
        "_meta": {
          "sessionKey": "agent:main:acp-smoke",
          "kind": "direct"
        }
      }
    ],
    "nextCursor": null
  },
  "notifications": ["session_info_update", "available_commands_update", "usage_update"],
  "gatewayLogTail": ["[gateway] ready", "[ws] ⇄ res ✓ sessions.list 305ms"]
}

Hindari menggunakan openclaw gateway call sessions.list sebagai satu-satunya bukti ACP. Path CLI tersebut dapat meminta peningkatan cakupan operator fresh-token; kebenaran bridge ACP dibuktikan oleh frame stdio ACP plus log sessions.list Gateway.

Cara menggunakan ini

Gunakan ACP ketika IDE (atau klien lain) berbicara Agent Client Protocol dan Anda ingin klien tersebut mengendalikan sesi OpenClaw Gateway.

Pastikan Gateway berjalan (lokal atau remote).
Konfigurasikan target Gateway (config atau flag).
Arahkan IDE Anda untuk menjalankan openclaw acp melalui stdio.

Contoh config (dipersistenkan):

openclaw config set gateway.remote.url wss://gateway-host:18789
openclaw config set gateway.remote.token <token>

Contoh menjalankan langsung (tanpa menulis config):

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

Memilih agen

ACP tidak memilih agen secara langsung. ACP merutekan berdasarkan kunci sesi Gateway. Gunakan kunci sesi bercakupan agen untuk menargetkan agen tertentu:

openclaw acp --session agent:main:main
openclaw acp --session agent:design:main
openclaw acp --session agent:qa:bug-123

Setiap sesi ACP dipetakan ke satu kunci sesi Gateway. Satu agen dapat memiliki banyak sesi; ACP secara default menggunakan sesi acp:<uuid> yang terisolasi kecuali Anda mengganti kunci atau labelnya. mcpServers per sesi tidak didukung dalam mode bridge. Jika klien ACP mengirimkannya selama newSession atau loadSession, bridge mengembalikan kesalahan yang jelas alih-alih mengabaikannya secara diam-diam. Jika Anda ingin sesi berbasis ACPX melihat alat Plugin OpenClaw atau alat bawaan tertentu seperti cron, aktifkan bridge MCP ACPX di sisi Gateway alih-alih mencoba meneruskan mcpServers per sesi. Lihat Agen ACP dan Bridge MCP alat OpenClaw.

Gunakan dari `acpx` (Codex, Claude, klien ACP lainnya)

Jika Anda ingin agen pemrograman seperti Codex atau Claude Code berbicara dengan bot OpenClaw Anda melalui ACP, gunakan acpx dengan target openclaw bawaannya. Alur umum:

Jalankan Gateway dan pastikan bridge ACP dapat menjangkaunya.
Arahkan acpx openclaw ke openclaw acp.
Targetkan kunci sesi OpenClaw yang ingin digunakan agen pemrograman.

Contoh:

# Permintaan sekali jalan ke sesi ACP OpenClaw default Anda
acpx openclaw exec "Summarize the active OpenClaw session state."

# Sesi bernama persisten untuk giliran lanjutan
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."

Jika Anda ingin acpx openclaw menargetkan Gateway dan kunci sesi tertentu setiap saat, ganti perintah agen openclaw di ~/.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"
    }
  }
}

Untuk checkout OpenClaw lokal repo, gunakan entrypoint CLI langsung alih-alih dev runner agar stream ACP tetap bersih. Contoh:

env OPENCLAW_HIDE_BANNER=1 OPENCLAW_SUPPRESS_NOTES=1 node openclaw.mjs acp ...

Ini adalah cara termudah agar Codex, Claude Code, atau klien lain yang memahami ACP dapat mengambil informasi kontekstual dari agen OpenClaw tanpa mengambil teks dari terminal.

Penyiapan editor Zed

Tambahkan agen ACP kustom di ~/.config/zed/settings.json (atau gunakan UI Pengaturan Zed):

{
  "agent_servers": {
    "OpenClaw ACP": {
      "type": "custom",
      "command": "openclaw",
      "args": ["acp"],
      "env": {}
    }
  }
}

Untuk menargetkan Gateway atau agen tertentu:

{
  "agent_servers": {
    "OpenClaw ACP": {
      "type": "custom",
      "command": "openclaw",
      "args": [
        "acp",
        "--url",
        "wss://gateway-host:18789",
        "--token",
        "<token>",
        "--session",
        "agent:design:main"
      ],
      "env": {}
    }
  }
}

Di Zed, buka panel Agent dan pilih “OpenClaw ACP” untuk memulai thread.

Pemetaan sesi

Secara default, sesi ACP mendapatkan kunci sesi Gateway terisolasi dengan prefiks acp:. Untuk menggunakan ulang sesi yang diketahui, teruskan kunci atau label sesi:

--session <key>: gunakan kunci sesi Gateway tertentu.
--session-label <label>: resolusikan sesi yang ada berdasarkan label.
--reset-session: buat id sesi baru untuk kunci tersebut (kunci sama, transkrip baru).

Jika klien ACP Anda mendukung metadata, Anda dapat menggantinya per sesi:

{
  "_meta": {
    "sessionKey": "agent:main:main",
    "sessionLabel": "support inbox",
    "resetSession": true
  }
}

Pelajari lebih lanjut tentang kunci sesi di /concepts/session.

Opsi

--url <url>: URL WebSocket Gateway (default ke gateway.remote.url saat dikonfigurasi).
--token <token>: token autentikasi Gateway.
--token-file <path>: baca token autentikasi Gateway dari file.
--password <password>: kata sandi autentikasi Gateway.
--password-file <path>: baca kata sandi autentikasi Gateway dari file.
--session <key>: kunci sesi default.
--session-label <label>: label sesi default untuk diresolusikan.
--require-existing: gagal jika kunci/label sesi tidak ada.
--reset-session: reset kunci sesi sebelum penggunaan pertama.
--no-prefix-cwd: jangan tambahkan direktori kerja sebagai prefiks prompt.
--provenance <off|meta|meta+receipt>: sertakan metadata atau tanda terima asal ACP.
--verbose, -v: logging verbose ke stderr.

Catatan keamanan:

--token dan --password dapat terlihat dalam daftar proses lokal pada beberapa sistem.
Sebaiknya gunakan --token-file/--password-file atau variabel lingkungan (OPENCLAW_GATEWAY_TOKEN, OPENCLAW_GATEWAY_PASSWORD).
Resolusi autentikasi Gateway mengikuti kontrak bersama yang digunakan oleh klien Gateway lainnya:
- mode lokal: env (OPENCLAW_GATEWAY_*) -> gateway.auth.* -> fallback gateway.remote.* hanya ketika gateway.auth.* belum diatur (SecretRefs lokal yang terkonfigurasi tetapi tidak teresolusi gagal tertutup)
- mode jarak jauh: gateway.remote.* dengan fallback env/config sesuai aturan prioritas jarak jauh
- --url aman sebagai override dan tidak menggunakan ulang kredensial config/env implisit; teruskan --token/--password eksplisit (atau varian file)
Proses anak backend runtime ACP menerima OPENCLAW_SHELL=acp, yang dapat digunakan untuk aturan shell/profil khusus konteks.
openclaw acp client menetapkan OPENCLAW_SHELL=acp-client pada proses bridge yang dijalankan.

Opsi `acp client`

--cwd <dir>: direktori kerja untuk sesi ACP.
--server <command>: perintah server ACP (default: openclaw).
--server-args <args...>: argumen tambahan yang diteruskan ke server ACP.
--server-verbose: aktifkan logging verbose pada server ACP.
--verbose, -v: logging klien verbose.

CLI commands

RPC and API

Codex harness

Plugin reference

Plugin SDK reference

Plugin maintainer reference

Templates

Technical reference

Concept internals

Project

Release and CI

Yang bukan ini

Matriks Kompatibilitas

Keterbatasan yang diketahui

Penggunaan

Klien ACP (debug)

Smoke testing protokol

Cara menggunakan ini

Memilih agen

Gunakan dari `acpx` (Codex, Claude, klien ACP lainnya)

Penyiapan editor Zed

Pemetaan sesi

Opsi

Opsi `acp client`

Terkait

CLI commands

RPC and API

Codex harness

Plugin reference

Plugin SDK reference

Plugin maintainer reference

Templates

Technical reference

Concept internals

Project

Release and CI

Documentation Index

​Yang bukan ini

​Matriks Kompatibilitas

​Keterbatasan yang diketahui

​Penggunaan

​Klien ACP (debug)

​Smoke testing protokol

​Cara menggunakan ini

​Memilih agen

​Gunakan dari acpx (Codex, Claude, klien ACP lainnya)

​Penyiapan editor Zed

​Pemetaan sesi

​Opsi

​Opsi acp client

​Terkait

Yang bukan ini

Matriks Kompatibilitas

Keterbatasan yang diketahui

Penggunaan

Klien ACP (debug)

Smoke testing protokol

Cara menggunakan ini

Memilih agen

Gunakan dari `acpx` (Codex, Claude, klien ACP lainnya)

Penyiapan editor Zed

Pemetaan sesi

Opsi

Opsi `acp client`

Terkait