Quickstart
Install the relayme CLI, connect it to your workspace, and send a
message, report, or attachment to a mailing list.
How it fits together
Your account owns one workspace. It holds your
mailing lists, sending identities, and
CLI connections. A connection represents one machine or automation;
its token is what relayme stores locally.
1. Install the CLI
Prebuilt binaries are available for macOS and Linux. Experimental, untested Windows binaries are also available from the download page.
curl -fsSL https://relaymethis.com/install | sh2. Connect this machine
relayme login opens the dashboard, where you approve the displayed device,
choose its mailing lists and identities, and optionally create new identities. Once
approved, relayme stores the token in your operating system credential store
when available.
relayme loginRELAYME_TOKEN instead. The CLI checks that
environment variable first and falls back to the token saved by relayme login.
Sending identities
An identity is the sender profile used in the email's From header.
It has a human name, such as Operations, and a stable key, such as
ops. Renaming the display name does not change the key scripts use.
One CLI connection can hold several identities. A reporting job might send routine
summaries as reports and urgent failures as alerts without
needing a second installation or token.
# inspect the identities available to this connection
relayme whoami
# choose by stable key
relayme -m "Build failed." --identity alerts
# or choose by the 1-based number shown by whoami
relayme -r ./weekly.md -i 2--identity so the
CLI never guesses the sender.
3. Check which lists you can send to
relayme doctor # credential source and API connectivity
relayme whoami # connection, workspace, lists, identities
relayme lists # mailing lists this CLI may send to4. Send
A send needs at least one piece of content: a message, a report file, or an attachment.
# a one-line message to the CLI's default list
relayme -m "Deploy completed successfully."
# a Markdown report as the body
relayme -m "Here is the nightly report." -r ./report.md
# target a specific list by key
relayme --list server-alerts -m "Disk usage at 91%."
# pipe a report in, pick a sender identity by ordinal
cat report.md | relayme -r - -i 2CLI reference
Commands
| Command | Description |
|---|---|
relayme | Send. The default when no subcommand is given. |
relayme login | Authenticate this device through browser approval. |
relayme whoami | Show the token's current workspace, lists, and identities. |
relayme lists | Mailing lists this CLI may send to. |
relayme status <send_id> | Check a recent send. |
relayme doctor | Check local credentials and API connectivity without revealing the token. |
relayme ui | Open the optional interactive terminal home screen. |
relayme completion <shell> | Print completion for bash, zsh, or fish. |
Flags
| Flag | Description |
|---|---|
-m, --message <text> | Short literal message. Sits above a report if both are given. |
-r, --report <file|-> | One .md, .txt, or .rtf report as the body. - reads stdin. |
-a, --attachment <path> | One attachment, max 5 MB. |
-s, --subject <text> | Subject. Overrides report frontmatter. |
-i, --identity <id> | Sender identity: key, id, or ordinal number. |
-l, --list <key> | Mailing list key. Defaults to the CLI's own default list. |
--dry-run | Validate and preview without queueing. |
--json | Machine-readable JSON output. |
HTTP API
Recipients must opt in
Adding someone to a list asks their permission; it does not subscribe them. Until they confirm, they are pending and every send skips them. This is enforced in the send pipeline rather than sold as a plan feature.