Generic remote WebSocket transport for ACP agents and clients.
Project description
acpremote
acpremote is the generic remote transport package for ACP.
It exposes any existing acp.interfaces.Agent over WebSocket and can also turn a remote ACP server
back into a local ACP agent proxy. It can also mirror any stdio ACP command by spawning it as a
child process.
This package is transport-only. Use it when the runtime already speaks ACP and you want to move
that ACP surface across a WebSocket boundary. If the runtime is still a Pydantic AI or LangChain
target that needs adapter dispatch, use acpkit instead.
Docs:
Install:
uv add acpremote
pip install acpremote
CLI
The acpremote executable exposes the same transport jobs as the Python API.
Use this mapping:
| You have... | Run... | Meaning |
|---|---|---|
| an exposed remote WebSocket endpoint | acpremote mirror ws://host:8080/acp/ws |
connect to the remote endpoint and expose it locally as stdio ACP |
| a local stdio ACP command | acpremote expose -- <command> |
spawn the command and expose it over WebSocket |
a native Python acp.interfaces.Agent |
acpremote serve module:agent |
load the ACP agent and expose it over WebSocket |
If a client such as Toad asks for an ACP command for an already exposed WebSocket, give it the mirror command:
acpremote mirror ws://remote.example.com:8080/acp/ws
Expose a native ACP Python target:
acpremote serve my_app:agent --host 0.0.0.0 --port 8080
serve expects my_app:agent to resolve to an existing acp.interfaces.Agent. For Pydantic AI,
LangChain, or LangGraph targets, use the root CLI so adapter dispatch stays explicit:
acpkit serve examples.langchain.workspace_graph:graph --host 0.0.0.0 --port 8080
Expose a stdio ACP command:
acpremote expose --host 0.0.0.0 --port 8080 -- npx @zed-industries/codex-acp
Pass command-specific flags after --:
acpremote expose --cwd /srv/agent --env MODEL=gpt-5 -- python agent.py --stdio
Mirror a remote WebSocket endpoint back to local stdio ACP:
acpremote mirror ws://remote.example.com:8080/acp/ws
That is the direct acpremote equivalent of:
acpkit run --addr ws://remote.example.com:8080/acp/ws
Bearer tokens can be passed directly or read from an environment variable:
acpremote expose --token-env ACPREMOTE_TOKEN -- npx @zed-industries/codex-acp
acpremote mirror ws://remote.example.com:8080/acp/ws --bearer-token "$ACPREMOTE_TOKEN"
Server
Expose any ACP agent on the remote host:
from acpremote import serve_acp
server = await serve_acp(agent=my_acp_agent, host='127.0.0.1', port=8080)
await server.serve_forever()
Expose a stdio ACP command instead of an in-memory agent:
from acpremote import serve_command
server = await serve_command(
['npx', '@zed-industries/codex-acp'],
host='127.0.0.1',
port=8080,
)
await server.serve_forever()
env={...} overrides selected variables while inheriting the parent process environment. That
keeps command lookup through PATH intact while still letting the caller inject tokens or runtime
flags.
If you need command cleanup tuning, pass CommandOptions to serve_stdio_command(...):
from acpremote import CommandOptions, serve_stdio_command
server = await serve_stdio_command(
CommandOptions(
command=('npx', '@zed-industries/codex-acp'),
terminate_timeout=2.0,
),
host='127.0.0.1',
port=8080,
)
await server.serve_forever()
When a command-backed WebSocket flow ends, acpremote terminates the child process and falls back
to kill after terminate_timeout. The timeout must be a positive finite number.
Typical remote-host flow:
acpkit serve examples.langchain.workspace_graph:graph --host 0.0.0.0 --port 8080
acpremote expose --host 0.0.0.0 --port 8081 -- npx @zed-industries/codex-acp
Typical local mirror flow:
acpkit run --addr ws://remote.example.com:8080/acp/ws
acpremote mirror ws://remote.example.com:8081/acp/ws
Default routes:
- metadata:
http://127.0.0.1:8080/acp - health:
http://127.0.0.1:8080/healthz - websocket:
ws://127.0.0.1:8080/acp/ws
Client Proxy
Turn a remote ACP endpoint back into a local ACP agent:
from acp import run_agent
from acpremote import connect_acp
agent = connect_acp('ws://127.0.0.1:8080/acp/ws')
await run_agent(agent)
That pattern is what powers a local stdio ACP facade in front of a remote ACP server.
If you want a launcher to open that local facade, wrap the same mirror command with Toad:
toad acp "acpremote mirror ws://remote.example.com:8080/acp/ws"
When the remote server advertises a remote_cwd in its metadata, connect_acp(...) treats that
directory as authoritative for session lifecycle calls. This keeps a mirrored local ACP server from
accidentally sending the local machine's spawn directory back to the remote host.
By default connect_acp(...) also treats host-backed capabilities as remote-owned. Local client
filesystem and terminal capabilities aren't forwarded unless TransportOptions(host_ownership="client_passthrough")
is set explicitly.
Transport Timing
TransportOptions can attach proxy-observed latency information to the ACP stream:
from acpremote import TransportOptions, connect_acp
agent = connect_acp(
'ws://127.0.0.1:8080/acp/ws',
options=TransportOptions(
emit_latency_meta=True,
emit_latency_projection=True,
),
)
TransportOptions also controls host ownership policy:
host_ownership="remote"is the defaulthost_ownership="client_passthrough"re-enables forwarding local filesystem and terminal client capabilities
Available signals:
- streamed updates can carry
field_meta["acpremote"]["transport_latency"] - a visible
Transport LatencyACP card can be emitted after each prompt turn
The metrics are proxy-observed timings, not synchronized end-to-end host clock measurements.
Transport Notes
Current transport behavior:
- one WebSocket text message carries one ACP JSON message
- binary frames are rejected
- bearer-token auth is supported
- stdio ACP commands can be mirrored with
serve_command(...) - custom command cleanup timeouts are available through
CommandOptions - transport limits are configurable through
TransportOptions
This package is transport-focused. It doesn't assume ACP Kit adapters or ACP Kit-owned runtime semantics.
Security guidance:
- bind to loopback unless a reverse proxy owns TLS and authentication
- allowlist command-backed servers instead of accepting arbitrary command strings
- keep environment overrides minimal and avoid forwarding unnecessary secrets
- see https://vcoderun.github.io/acpkit/security/
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file acpremote-0.9.8.tar.gz.
File metadata
- Download URL: acpremote-0.9.8.tar.gz
- Upload date:
- Size: 17.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f38a8d746c1199ce193e44ecd841a51596ee8d80d216e4764b77d4a0fceb3717
|
|
| MD5 |
5f88c52c42777b9e8b82631f793b1d55
|
|
| BLAKE2b-256 |
52a8f9103c5323b89b311a82d7ee9d78e741b84910a2859677ed6531fd73f135
|
File details
Details for the file acpremote-0.9.8-py3-none-any.whl.
File metadata
- Download URL: acpremote-0.9.8-py3-none-any.whl
- Upload date:
- Size: 21.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fab3cd3cf02e6a16bc00944dd534eaf1497e2148153b01281140a415ea761491
|
|
| MD5 |
000a29c4b3babc26d3ade5df731f3a73
|
|
| BLAKE2b-256 |
4ba48b8dd35a25d8f326434737c0be965e6e80eafedf5f87b0da42f0fae0536a
|