docs/agent-mux/tutorials/remote-bootstrap
Remote bootstrap reference
The agent-mux-remote adapter lets you drive a coding agent that runs on a
Continue reading
Nearby pages in the same section.
Remote bootstrap
The agent-mux-remote adapter lets you drive a coding agent that runs on a remote host — over SSH, in a container, or behind a gateway. "Bootstrap" is the process of getting the remote side ready: installing amux, wiring credentials, and establishing a session channel.
1. Install on the remote host
# On the remote machine
curl -fsSL https://nodejs.org/dist/v22.x/node-v22.x-linux-x64.tar.xz | tar -xJ
npm i -g @a5c-ai/agent-mux-cliOr use the built-in bootstrap command, which copies an install script over SSH and runs it:
amux remote bootstrap user@host --agent claudeThis installs the CLI, ensures the target harness (e.g. @anthropic-ai/claude-code) is present, and writes a minimal ~/.amux/config.json on the remote.
2. Configure credentials
The remote host needs the same env vars (or config files) that the local setup would need. Options:
etc. from the local shell into the SSH session for the lifetime of the run.
so the harness authenticates without env vars.
- **env-forward** (default):
amuxforwardsANTHROPIC_API_KEY/OPENAI_API_KEY/ - **config-file**: pre-seed
~/.claude/auth.json(or equivalent) on the remote - **per-call**: pass
env: { ANTHROPIC_API_KEY: '…' }torun().
3. Running against the remote
import { AgentMuxClient } from '@a5c-ai/agent-mux';
const client = new AgentMuxClient();
const handle = await client.run({
agent: 'agent-mux-remote',
remote: { host: 'user@host', agent: 'claude' },
prompt: 'Summarize the repository in two paragraphs.',
});
for await (const ev of handle.events()) {
if (ev.type === 'text_delta') process.stdout.write(ev.text);
}From the CLI:
amux run agent-mux-remote \
--remote-host user@host \
--remote-agent claude \
"Summarize the repository."4. Invocation modes
The remote adapter respects agent-mux's invocation modes:
mode: 'host'— spawn the remote CLI directly (SSH exec).mode: 'docker'— run the remote CLI inside a container on the remote host.mode: 'k8s'— submit the remote CLI as an ephemeral pod.
See docker-mode and k8s-mode for the container flavors — the same flags apply to agent-mux-remote.
5. Tearing down
amux remote teardown user@host removes ~/.amux/, the installed harness (if you used bootstrap), and any cached sessions. Use --keep-sessions to preserve the history directory.