Skip to main content

CLI · GitHub Actions · Browser UI

Relay Button

Reusable Aleph Cloud deployment tooling for RootFS publishing, VM relay deployment, runtime verification, and browser-driven sponsor flows.

Use it when a consumer project needs Aleph deployment behavior without copying the STORE, INSTANCE, CRN, guest setup, bootstrap, and cleanup logic into every repo.

Start with the CLIUse the GitHub ActionEmbed the UI

Current package version: v0.6.19

Command line

Run deployment flows locally

The relay-button CLI exposes the same Node runner paths used by CI: RootFS build and publish, Aleph VM deployment, CRN discovery, and retention.

Start with deploy for Aleph VM instances, rootfs-publish for qcow2 RootFS publication, and list-crns when you want to inspect candidate CRNs first.

Full Node CLI reference
pnpm relay-button help
pnpm relay-button deploy
pnpm relay-button rootfs-publish
pnpm exec relay-button list-crns | jq

Deployment lifecycle

What Relay Button automates

Relay Button connects the steps that usually make Aleph relay and service deployment fragile when every consumer repo owns them separately.

  1. Build a qcow2 RootFS image
  2. Publish and pin it on Aleph/IPFS
  3. Deploy an Aleph VM INSTANCE
  4. Wait for CRN runtime and mapped ports
  5. Configure and verify the guest service
  6. Publish bootstrap and deployment records

Build RootFS Images

Plan and build qcow2 images from project-specific contracts and reference rootfs assets.

Publish To Aleph/IPFS

Upload RootFS artifacts, publish signed Aleph STORE records, and emit reusable manifests.

Deploy Aleph VMs

Create INSTANCE messages, select CRNs, wait for runtime networking, and configure the guest.

Use GitHub Actions

Call the same deployment and RootFS runners from CI without copying Aleph workflow logic.

Embed Browser Flows

Use browser and UI packages for wallet-backed sponsor deployment and status surfaces.

Keep Deployments Tidy

Refresh relay bootstrap records, verify deployed services, and forget old self-owned records.