Skip to content

SSH Mode

SSH mode wraps the full Herald TUI in a Charm Wish SSH server. Each SSH session can either open its own local backend connection or connect to a running Herald daemon.

Terminal window
go build -o bin/herald-ssh-server ./cmd/herald-ssh-server
./bin/herald-ssh-server -config ~/.herald/conf.yaml -addr :2222

Connect from another terminal:

Terminal window
ssh -p 2222 localhost

Use a specific host key path:

Terminal window
./bin/herald-ssh-server -host-key .ssh/host_ed25519

Use the daemon backend instead of opening IMAP per SSH session:

Terminal window
./bin/herald serve -config ~/.herald/conf.yaml
./bin/herald-ssh-server -config ~/.herald/conf.yaml -daemon http://127.0.0.1:7272

The SSH TUI uses the same tabs, keybindings, and overlays as local Herald. The difference is process ownership: without -daemon, each SSH connection creates its own backend and IMAP connection; with -daemon, the session uses the shared remote backend.

SSH mode creates or uses an SSH host key path. Bind to a local address or protect network exposure appropriately. Mail credentials still come from the Herald config file on the machine running the SSH server.

If connection fails, verify the server is running and listening on the expected address. If the TUI opens but mail fails, check config path and provider connectivity on the server machine. If daemon mode fails, run ./bin/herald status.