CLI commands
ACP
Jalankan bridge Agent Client Protocol (ACP) yang berkomunikasi dengan OmeniaClaw 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.
OmeniaClaw 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
OmeniaClaw alih-alih menghosting sesi harness ACP, gunakan
OmeniaClaw mcp serve.
Yang bukan ini
Halaman ini sering disalahartikan sebagai sesi harness ACP.
OmeniaClaw acp berarti:
- OmeniaClaw bertindak sebagai server ACP
- IDE atau klien ACP terhubung ke OmeniaClaw
- OmeniaClaw meneruskan pekerjaan tersebut ke sesi Gateway
Ini berbeda dari Agen ACP, tempat OmeniaClaw menjalankan
harness eksternal seperti Codex atau Claude Code melalui acpx.
Aturan singkat:
- editor/klien ingin berbicara ACP ke OmeniaClaw: gunakan
OmeniaClaw acp - OmeniaClaw harus meluncurkan Codex/Claude/Gemini sebagai harness ACP: gunakan
/acp spawndan 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 OmeniaClaw 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 OmeniaClaw 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
loadSessiondapat 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_updatedanusage_updatediturunkan 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
OmeniaClaw acp # Remote GatewayOmeniaClaw acp --url wss://gateway-host:18789 --token <token> # Remote Gateway (token from file)OmeniaClaw acp --url wss://gateway-host:18789 --token-file ~/.OmeniaClaw/gateway.token # Attach to an existing session keyOmeniaClaw acp --session agent:main:main # Attach by label (must already exist)OmeniaClaw acp --session-label "support inbox" # Reset the session key before the first promptOmeniaClaw acp --session agent:main:main --reset-sessionKlien 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.
OmeniaClaw acp client # Point the spawned bridge at a remote GatewayOmeniaClaw acp client --server-args --url wss://gateway-host:18789 --token-file ~/.OmeniaClaw/gateway.token # Override the server command (default: OmeniaClaw)OmeniaClaw acp client --server "node" --server-args OmeniaClaw.mjs acp --url ws://127.0.0.1:19001Model izin (mode debug klien):
- Persetujuan otomatis berbasis allowlist dan hanya berlaku untuk ID tool inti tepercaya.
- Persetujuan otomatis
readdibatasi ke direktori kerja saat ini (--cwdjika disetel). - ACP hanya menyetujui otomatis kelas readonly yang sempit: panggilan
readterbatas 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.kindyang disediakan server diperlakukan sebagai metadata tidak tepercaya (bukan sumber otorisasi).- Kebijakan bridge ACP ini terpisah dari izin harness ACPX. Jika Anda menjalankan OmeniaClaw melalui backend
acpx,plugins.entries.acpx.config.permissionMode=approve-alladalah sakelar "yolo" break-glass untuk sesi harness tersebut.
Smoke testing protokol
Untuk debugging tingkat protokol, mulai Gateway dengan status terisolasi dan kendalikan
OmeniaClaw 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 OmeniaClaw 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 OmeniaClaw Gateway.
- Pastikan Gateway berjalan (lokal atau remote).
- Konfigurasikan target Gateway (config atau flag).
- Arahkan IDE Anda untuk menjalankan
OmeniaClaw acpmelalui stdio.
Contoh config (dipersistenkan):
OmeniaClaw config set gateway.remote.url wss://gateway-host:18789OmeniaClaw config set gateway.remote.token <token>Contoh menjalankan langsung (tanpa menulis config):
OmeniaClaw acp --url wss://gateway-host:18789 --token <token># preferred for local process safetyOmeniaClaw acp --url wss://gateway-host:18789 --token-file ~/.OmeniaClaw/gateway.tokenMemilih agen
ACP tidak memilih agen secara langsung. ACP merutekan berdasarkan kunci sesi Gateway.
Gunakan kunci sesi bercakupan agen untuk menargetkan agen tertentu:
OmeniaClaw acp --session agent:main:mainOmeniaClaw acp --session agent:design:mainOmeniaClaw acp --session agent:qa:bug-123Setiap 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 OmeniaClaw 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 OmeniaClaw.
Gunakan dari acpx (Codex, Claude, klien ACP lainnya)
Jika Anda ingin agen pemrograman seperti Codex atau Claude Code berbicara dengan
bot OmeniaClaw Anda melalui ACP, gunakan acpx dengan target OmeniaClaw bawaannya.
Alur umum:
- Jalankan Gateway dan pastikan bridge ACP dapat menjangkaunya.
- Arahkan
acpx OmeniaClawkeOmeniaClaw acp. - Targetkan kunci sesi OmeniaClaw yang ingin digunakan agen pemrograman.
Contoh:
# Permintaan sekali jalan ke sesi ACP OmeniaClaw default Andaacpx OmeniaClaw exec "Summarize the active OmeniaClaw session state." # Sesi bernama persisten untuk giliran lanjutanacpx OmeniaClaw sessions ensure --name codex-bridgeacpx OmeniaClaw -s codex-bridge --cwd /path/to/repo \ "Ask my OmeniaClaw work agent for recent context relevant to this repo."Jika Anda ingin acpx OmeniaClaw menargetkan Gateway dan kunci sesi tertentu setiap
saat, ganti perintah agen OmeniaClaw di ~/.acpx/config.json:
{ "agents": { "OmeniaClaw": { "command": "env OmeniaClaw_HIDE_BANNER=1 OmeniaClaw_SUPPRESS_NOTES=1 OmeniaClaw acp --url ws://127.0.0.1:18789 --token-file ~/.OmeniaClaw/gateway.token --session agent:main:main" } }}Untuk checkout OmeniaClaw lokal repo, gunakan entrypoint CLI langsung alih-alih dev runner agar stream ACP tetap bersih. Contoh:
env OmeniaClaw_HIDE_BANNER=1 OmeniaClaw_SUPPRESS_NOTES=1 node OmeniaClaw.mjs acp ...Ini adalah cara termudah agar Codex, Claude Code, atau klien lain yang memahami ACP dapat mengambil informasi kontekstual dari agen OmeniaClaw tanpa mengambil teks dari terminal.
Penyiapan editor Zed
Tambahkan agen ACP kustom di ~/.config/zed/settings.json (atau gunakan UI Pengaturan Zed):
{ "agent_servers": { "OmeniaClaw ACP": { "type": "custom", "command": "OmeniaClaw", "args": ["acp"], "env": {} } }}Untuk menargetkan Gateway atau agen tertentu:
{ "agent_servers": { "OmeniaClaw ACP": { "type": "custom", "command": "OmeniaClaw", "args": [ "acp", "--url", "wss://gateway-host:18789", "--token", "<token>", "--session", "agent:design:main" ], "env": {} } }}Di Zed, buka panel Agent dan pilih "OmeniaClaw 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:
--tokendan--passworddapat terlihat dalam daftar proses lokal pada beberapa sistem.- Sebaiknya gunakan
--token-file/--password-fileatau variabel lingkungan (OmeniaClaw_GATEWAY_TOKEN,OmeniaClaw_GATEWAY_PASSWORD). - Resolusi autentikasi Gateway mengikuti kontrak bersama yang digunakan oleh klien Gateway lainnya:
- mode lokal: env (
OmeniaClaw_GATEWAY_*) ->gateway.auth.*-> fallbackgateway.remote.*hanya ketikagateway.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 --urlaman sebagai override dan tidak menggunakan ulang kredensial config/env implisit; teruskan--token/--passwordeksplisit (atau varian file)
- mode lokal: env (
- Proses anak backend runtime ACP menerima
OmeniaClaw_SHELL=acp, yang dapat digunakan untuk aturan shell/profil khusus konteks. OmeniaClaw acp clientmenetapkanOmeniaClaw_SHELL=acp-clientpada proses bridge yang dijalankan.
Opsi acp client
--cwd <dir>: direktori kerja untuk sesi ACP.--server <command>: perintah server ACP (default:OmeniaClaw).--server-args <args...>: argumen tambahan yang diteruskan ke server ACP.--server-verbose: aktifkan logging verbose pada server ACP.--verbose, -v: logging klien verbose.