946269455d
- Add CLI relay (cli subcommand and cmux symlink) to cmuxd-remote - Implement socket discovery and TCP retry logic for relay connections - Document CLI relay behavior, bootstrap symlink, and reverse TCP forwarding in README - Update remote daemon spec with CLI relay details, status matrix, and PR reference - Note bootstrap creates ~/.cmux/bin/cmux symlink and writes ~/.cmux/socket_addr - Clarify integration steps and relay process behavior (ssh -N -R, ControlPath/ExitOnForwardFailure)
35 lines
1.5 KiB
Markdown
35 lines
1.5 KiB
Markdown
# cmuxd-remote (Go)
|
|
|
|
Go remote daemon for `cmux ssh` bootstrap, capability negotiation, and CLI relay.
|
|
|
|
## Commands
|
|
|
|
1. `cmuxd-remote version`
|
|
2. `cmuxd-remote serve --stdio`
|
|
3. `cmuxd-remote cli <command> [args...]` — relay cmux commands to the local app over the reverse TCP forward
|
|
|
|
When invoked as `cmux` (via symlink created during bootstrap), the binary auto-dispatches to the `cli` subcommand. This is busybox-style argv[0] detection.
|
|
|
|
## RPC methods (newline-delimited JSON over stdio)
|
|
|
|
1. `hello`
|
|
2. `ping`
|
|
|
|
## CLI relay
|
|
|
|
The `cli` subcommand (or `cmux` symlink) connects to the local cmux app's socket through an SSH reverse TCP forward and relays commands. It supports both v1 text protocol and v2 JSON-RPC commands.
|
|
|
|
Socket discovery order:
|
|
1. `--socket <path>` flag
|
|
2. `CMUX_SOCKET_PATH` environment variable
|
|
3. `~/.cmux/socket_addr` file (written by the app after the reverse relay establishes)
|
|
|
|
For TCP addresses, the CLI retries for up to 15 seconds on connection refused, re-reading `~/.cmux/socket_addr` on each attempt to pick up updated relay ports.
|
|
|
|
## Integration in cmux
|
|
|
|
1. `workspace.remote.configure` bootstraps this binary over SSH when missing.
|
|
2. Client sends `hello` before enabling remote port probing/forwarding.
|
|
3. Daemon status/capabilities are exposed in `workspace.remote.status -> remote.daemon`.
|
|
4. Bootstrap creates `~/.cmux/bin/cmux` symlink pointing to the daemon binary.
|
|
5. A background `ssh -N -R` process reverse-forwards a TCP port to the local cmux Unix socket. The relay address is written to `~/.cmux/socket_addr` on the remote.
|