CLI Overview

The brdz CLI provides a comprehensive set of commands for managing your applications, projects, and infrastructure.

Command Structure

All brdz commands follow a consistent structure:

brdz <resource>:<action> [arguments] [flags]

For example:

• brdz projects:create my-project
• brdz apps:list
• brdz releases:create ./dist.zip

Command Categories

Authentication & Accounts

• accounts:create - Create a new account
• auth:login - Authenticate and get an API key

Context Management

• ctx:use - Set project and app context interactively
• ctx:get - View current context

Projects

• projects:create - Create a new project
• projects:list - List all projects
• projects:get - Get project details

Apps

• apps:create - Create a new app
• apps:list - List apps in current project
• apps:get - Get app details

Releases

• releases:create - Create and deploy a new release
• releases:list - List releases for current app
• releases:rollback - Rollback to a previous release

Hostnames

• hostnames:create - Add a custom hostname to an app
• hostnames:list - List hostnames for current app

DNS Management

• dns:zones:create - Create a DNS zone
• dns:zones:list - List all DNS zones
• dns:zones:get - Get DNS zone details
• dns:zones:verify - Verify DNS zone nameserver configuration
• dns:zones:deactivate - Deactivate a DNS zone
• dns:zones:delete - Delete a DNS zone
• dns:records:create - Create a DNS record
• dns:records:list - List DNS records for a zone
• dns:records:get - Get DNS record details
• dns:records:delete - Delete a DNS record
• dns:records:clone - Clone DNS records from an existing domain

Global Flags

Most commands support these global flags:

• --help, -h - Show help for a command
• --version, -v - Show version information

Getting Help

Get help for any command:

# General help
brdz --help

# Help for a specific command
brdz projects:create --help

Configuration

brdz stores configuration in ~/.brdz/:

• credentials - API key and hostname
• context - Current project and app selection

You can override these settings using environment variables. See Environment Variables for details.