Skip to content

Apps

Apps represent individual applications within a project. Each app can have multiple releases and custom hostnames.

An app is a deployable application that:

  • Belongs to a project
  • Can have multiple releases (versions)
  • Can have custom hostnames
  • Maintains a current active release

Create a new app within your current project:

Terminal window
# Set project context first
brdz ctx:use
# Create the app
brdz apps:create my-app

The app name must be:

  • Unique within the project
  • URL-safe (lowercase letters, numbers, hyphens)
  • Descriptive of the application
Terminal window
# Create a web frontend app
brdz apps:create web-frontend
# Create an API app
brdz apps:create api
# Create a documentation site
brdz apps:create docs

View all apps in your current project:

Terminal window
# List apps in current project
brdz apps:list

Output example:

ID Name Current Release Created At
1 web-frontend 42 2025-01-15 10:30:00
2 api 15 2025-01-16 14:20:00
3 docs 8 2025-01-17 09:15:00

Get detailed information about a specific app:

Terminal window
brdz apps:get my-app

Output includes:

  • App ID
  • Name
  • Current release ID
  • Creation timestamp
  • Project association
Terminal window
brdz apps:create my-app
Terminal window
brdz ctx:use
Terminal window
brdz releases:create ./dist.zip
Terminal window
brdz hostnames:create example.com
Terminal window
# Switch to a different app
brdz ctx:use
# Verify current app
brdz ctx:get
Terminal window
# Deploy to first app
brdz ctx:use
brdz releases:create ./frontend.zip
# Deploy to second app
brdz ctx:use
brdz releases:create ./backend.zip
Terminal window
# Create separate apps for each service
brdz apps:create api-gateway
brdz apps:create user-service
brdz apps:create payment-service
brdz apps:create notification-service
Terminal window
# Separate frontend and backend apps
brdz apps:create web-frontend
brdz apps:create api-backend

Within different projects, create matching apps:

Terminal window
# In production project
brdz ctx:use # Select 'production'
brdz apps:create web-app
# In staging project
brdz ctx:use # Select 'staging'
brdz apps:create web-app
  1. Use descriptive names - Choose clear app names that indicate purpose
  2. One app per service - Keep apps focused on single responsibilities
  3. Set context before operations - Always verify ctx:get before deployments
  4. Consistent naming - Use the same naming conventions across projects
  5. Document purpose - Keep notes about what each app does
  • App names must be unique within a project
  • Apps can only belong to one project
  • App names cannot be changed after creation
  • Deleting an app requires deleting all releases first

Create a new app in the current project.

Requirements:

  • Project context must be set

Arguments:

  • name - App identifier (required)

Example:

Terminal window
brdz apps:create my-app

List all apps in the current project.

Requirements:

  • Project context must be set

Example:

Terminal window
brdz apps:list

Get detailed information about an app.

Requirements:

  • Project context must be set

Arguments:

  • name - App identifier (required)

Example:

Terminal window
brdz apps:get my-app