Getting started

Install

Reley ships as an Electron desktop app and a Node CLI. Both link against the same core engine, so anything you can do in the GUI you can script.

Prerequisites

macOS 12 or newer. Apple Silicon and Intel both supported.
Node >= 22.13 (engines field). Use nvm if your system has an older Node.
pnpm 11. Corepack will install the right version from the lockfile.
Native modules (svm-sandbox, better-sqlite3) load under Electron's Node ABI.

Desktop app

Download the latest installer from the releases page. macOS is the only supported platform today. Windows and Linux builds land next.

release/

Reley-1.x.x-arm64.dmg    macOS  (Apple Silicon)
Reley-1.x.x-x64.dmg      macOS  (Intel)

note

Windows and Linux builds are coming. The engine is platform-agnostic; what blocks is signed installers and native-module CI. Track progress on the changelog.

From source

terminal

git clone https://github.com/hoangtuanictvn/reley
cd reley/relay-app
pnpm install
pnpm build

# Electron dev with HMR
pnpm --filter @relay/desktop dev

# Package DMG / NSIS / AppImage
pnpm --filter @relay/desktop package

CLI

The CLI runs the same dispatcher as the desktop app, in-process. State lives under $RELAY_PROJECT_ROOT, defaulting to ~/.relay-cli-project.

terminal

pnpm cli project create "DEX Integration" \
  --rpc https://api.mainnet-beta.solana.com

pnpm cli program add MemoSq4gqABAXKb96qnH8TysNcWxMyWCqXgDLGmfcHr \
  --project <pid>

pnpm cli session create main --project <pid>

note

Replay needs an archive RPC for slot - 1 reads. Default public mainnet won't serve historical accounts beyond the retention window. Use Helius, Triton, or your own archive node.