Quick Start

This guide will walk you through deploying your first application with brdz.

Prerequisites

First, create a new account:

brdz accounts:create

You’ll be prompted to enter your account details.

Authenticate with your account to get an API key:

brdz auth:login

This will store your credentials in ~/.brdz/credentials for future use.

Projects help you organize related applications:

brdz projects:create my-project

Set your working context to avoid repeating project names:

brdz ctx:use

This interactive command will prompt you to select your project. Your selection is saved in ~/.brdz/context.

Create an application within your project:

brdz apps:create my-app

Update your context to include the new app:

brdz ctx:use

Package your application as a ZIP file and deploy it:

# Assuming your built app is in ./dist
zip -r release.zip dist/

# Create a release
brdz releases:create release.zip

Your application is now deployed! The release will be automatically activated.

Add a custom domain to your application:

brdz hostnames:create example.com

Configure your DNS to point to the provided hostname.

List your releases to confirm:

brdz releases:list

List your apps:

brdz apps:list

# Build your app
npm run build

# Package it
zip -r release.zip dist/

# Deploy
brdz releases:create release.zip

# List releases to find the version to rollback to
brdz releases:list

# Rollback to a specific release ID
brdz releases:rollback 42

# Change your context
brdz ctx:use

# View current context
brdz ctx:get