CLI Commands¶

All commands follow the pattern relay [options] <command>. URLs are printed to stdout, status messages to stderr (POSIX convention).

Session commands¶

relay <command>¶

Create a session and attach locally.

relay bash                    # interactive shell
relay htop                    # run any command
relay -- python3 -m http.server  # use -- for commands with flags

relay attach <id>¶

Reattach to an existing session in raw TTY mode.

• Press Ctrl+] to detach
• Session continues running after detach

relay list¶

List all active sessions with their IDs, commands, and status.

relay stop <id>¶

Kill a session and its underlying process.

relay share <id>¶

Generate a read-only share link.

Output: share URL to stdout, metadata to stderr.

Server commands¶

relay server start¶

Start the web server in the foreground.

relay server install¶

Install as a system service (launchd on macOS, systemd on Linux).

relay server uninstall¶

Remove and stop the system service.