CLI Quickstart

Use the Relay CLI to manage projects, publish functions, and monitor executions from your terminal.

Installation

The CLI is distributed as a standalone binary. Download the latest release from the console or run:

curl -L https://deployrelay.com/cli/install.sh | bash

The installer adds the relay binary to your PATH.

Authenticate

relay auth login

This command opens a device-code flow in your browser. After you approve, the CLI caches an access token (stored in ~/.relay/config.json).

Common Commands

Command	Description
relay projects list	View accessible projects.
relay projects select	Switch the active project/tenant.
relay functions deploy <path>	Package and publish a function bundle.
relay functions logs <rufid>	Stream recent execution logs.
relay executions trigger <rufid>	Invoke a function with JSON input.
relay account show	Display plan, quotas, and usage.

Run relay --help or relay <command> --help for full command options.

Configuration

• Default config lives in ~/.relay/config.json.
• Environment variables override config values (RELAY_API_URL, RELAY_API_KEY, etc.).
• Profiles let you switch between staging/production projects quickly.

Troubleshooting

• relay doctor checks API connectivity, auth status, and local environment.
• Use relay auth logout to revoke cached tokens if you rotate credentials.
• Add --verbose to any command for detailed logs when debugging.

For a deeper dive into the CLI roadmap and design, refer to the internal docs/cli/ plans. Public CLI documentation will continue to expand as new commands graduate from beta.