relay-companion weekly downloads statistics

Relay Companion

This is the public, auditable source for the relay-companion npm package and Relay desktop runtime.

Relay connects Claude Code, Cowork, and Codex to a shared inbox. The first-contact package has no install lifecycle and, in thin-installer releases, no dependencies. setup downloads the exact platform runtime from api.sendrelays.com, checks its signed manifest and SHA-512 digest, and only then activates it.

The revocable device credential is stored in an owner-only local file on macOS/Linux or Windows Credential Manager. ~/.relay/config.json contains non-secret account and device metadata only. Inbound Relay content is treated as untrusted correspondence and is never executed directly; any agent action remains subject to that host's approvals and sandbox.

Release commits are generated from the shipped Companion source, reviewed here, and published manually from the protected GitHub environment. The package version, runtime artifacts, dependency lock, SBOMs, source commit, and npm provenance are all bound to that release. The complete public source is davidkariuki123/relay-companion.

Start at sendrelays.com/get-started. Never install a version that Relay's Get Started page did not name exactly.

Setup installs and opens the signed-out Relay pill, registers the local Relay MCP launcher for Claude Code and Codex, and registers the always-on task daemon with macOS launchd, Windows Task Scheduler, or owner-scoped Linux systemd services. New setup never asks the agent for a pairing code.

Relay supports macOS, Windows, and 64-bit Linux on x64 and arm64. Linux targets current glibc distributions with a graphical X11 session, or a Wayland session with XWayland, and a systemd user manager. Setup uses owner-scoped systemd services and XDG application/autostart entries. Where unprivileged user namespaces are restricted, including Ubuntu 24.04's default AppArmor policy, setup asks once for administrator approval to install the exact, content-addressed Chromium sandbox helper in a root-owned location; Relay never disables Electron's sandbox. A later update that needs a new helper waits for relay update to be run in a desktop terminal. Claude Code and Codex CLI are supported Linux hosts; Claude Desktop is not available on Linux. Alpine/musl, 32-bit Linux, headless-only sessions, Linux without XWayland, and systems without a systemd user session are outside the supported matrix.

Linux setup installs a durable command at ~/.local/bin/relay; open a new login session if that directory was not already on PATH. Start diagnosis with relay doctor. Live logs are ~/.relay/daemon.log and ~/.relay/pill.log; use systemctl --user status work.relay.companion.service work.relay.companion.pill.service for service health and journalctl --user -u work.relay.companion.service -u work.relay.companion.pill.service for lifecycle history.