Quickstart

Relayer is a release control plane: one registry for what you shipped, which channel it went to, who should receive it, and which devices actually run it. Everything is plain HTTP - your app can be built with Electron, Tauri, Wails, Swift, Go, Rust, Python, or be an OS agent on customer servers.

Relayer serves decisions, not bytes: your binaries stay on GitHub releases, S3, R2 - wherever they already live.

1. Create an app

Sign in and create an app from the Overview page. It gets stable and beta channels automatically, plus an immutable app ref (used in URLs - rename the app freely, URLs never break).

2. Mint an API key

From API keys in the sidebar. The key (rl_…) is shown once and stored hashed - treat it like a password. Use it from CI, never from inside your shipped app.

3. Publish your first release

curl -X POST https://relayer-three.vercel.app/api/v1/releases \
  -H "Authorization: Bearer rl_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "app": "YOUR_APP_REF",
    "channel": "stable",
    "version": "1.0.0",
    "notes": "## First release\n\n- Hello world",
    "artifacts": [
      { "platform": "darwin", "arch": "aarch64", "url": "https://github.com/you/app/releases/download/v1.0.0/app-darwin-arm64.dmg" }
    ]
  }'

Prefer zero CI changes? Connect the GitHub webhook instead - gh release create v1.0.0 and it shows up here.

4. Point a device at Relayer

The entire client contract is one GET request:

curl -H "X-Relayer-Device: $(uuidgen)" \
  https://relayer-three.vercel.app/u/YOUR_APP_REF/stable/darwin/aarch64/0.9.0

200 returns an update manifest; 204 means up to date (or not in the rollout cohort yet). That same check is the heartbeat that powers your fleet dashboard. Tauri and Electron users: see Adapters - Tauri needs zero code. Devices that can't call home (routers, firmware, managed agents)? Your orchestrator can report state and plan waves on their behalf - see Push-mode fleets.

5. Watch the fleet appear

Open your app's page: devices, versions, platforms and check-in activity populate in real time as devices check in. Now you can stage a rollout - serve 2.0.0 to 10% of the fleet, watch adoption, ramp or roll back.