relay-ttydocs
Reference

Configuration Files

.env

Environment variables for server configuration. See Environment Variables for all options.

Location: project root or working directory

~/.config/relay-tty/tunnel.json

Tunnel configuration, auto-created on first --tunnel use.

Contains the stable subdomain assigned by relaytty.com. Reused on subsequent runs so your URL stays the same.

~/.config/relay-tty/relayrc

CLI and TUI settings. Any relay command creates this file with the defaults below the first time it runs without one; it never overwrites an existing file. One key = value per line; # starts a comment. Unknown keys are ignored with a warning on stderr.

# Prefix key for relay tui (default C-b). Also accepts ctrl-b or ^b.
prefix = C-b

# Default server URL for every command's --host
# host = https://laptop.example.com
KeyDefaultDescription
prefixC-bControl chord that starts a TUI command while attached. Press it twice to send it literally.
hostlocal serverServer URL used when --host is not given. Set this to drive sessions on another machine through the tunnel.

~/.relay-tty/

Runtime data directory:

PathDescription
sessions/<id>.jsonSession metadata (command, created time, status)
sockets/<id>.sockUnix socket for pty-host communication

Session metadata is created by the pty-host process and persists across server restarts. Socket files are cleaned up when the pty-host process exits.

Service files

Created by relay server install:

PlatformPath
macOS~/Library/LaunchAgents/com.relay-tty.plist
Linux~/.config/systemd/user/relay-tty.service

On this page