Commands

Updated for version 1.2.5

bricks is a command-line interface (CLI) library designed for DevOps and Platform teams to manage Infrastructure as Code (IaC) at scale. This application is owned and created by Bluebricks Ltd., with all rights reserved.

Usage

bricks [flags]

bricks [command]

Available Commands

You can get instant help anytime by typing --help as a flag for any command or sub-command. i.e. bricks --help and bricks bprint --help.

Blueprint

Use bprint command to create, modify, and publish blueprints. Learn more at Blueprints (bprint)

Blueprint management

Usage:
  bricks bprint [flags]
  bricks bprint [command]

Aliases:
  bprint, blueprint, bp

Available Commands:
  add          Adding remote blueprint to local blueprint
  add-repo     Adding github repository url to local blueprint
  bump         Bump blueprint version
  create       Create new IaC module for an exiting blueprint
  describe     Printout the bricks.json of the provided blueprint
  enable       Enable blueprint
  fetch        Download binaries of a blueprint
  get          List the configuration of the provided blueprint
  init         Create new empty blueprint
  prepare      Prepare Infrastructure-as-Code files
  publish      Publishing a new blueprint
  remove       Removing blueprint
  search       Conduct a blueprint search
  state-config Retrieve remote Terraform/OpenTofu state backend config
  status       Provide installation info on a blueprint
  update       Update blueprint
  view         View blueprint versions

Global Flags:
      --config string     config file (default is $HOME/.bricks/config.yaml)
  -h, --help              Print Help message for Bricks CLI
      --non-interactive   Suppresses interactive UI elements for non-interactive environments
  -v, --version           Print bricks CLI version

Use "bricks bprint [command] --help" for more information about a command.

Clouds

Use clouds command to list the associated cloud vendors with your Bluebricks account.

Clouds management

Usage:
  bricks clouds [flags]
  bricks clouds [command]

Available Commands:
  delete      Delete cloud account
  ls          List available cloud accounts

Global Flags:
      --config string   config file (default is $HOME/.bricks/config.yaml)
  -h, --help            Print Help message for Bricks CLI
  -v, --version         Print bricks CLI version

Use "bricks clouds [command] --help" for more information about a command.

Environments

Use env command to manage Bluebricks environments.

Manage environments

Usage:
  bricks env [flags]
  bricks env [command]

Aliases:
  env, environment

Available Commands:
  create      Create a new environment
  delete      Delete an environment
  disable     Disable an environment
  enable      Enable an environment
  ls          List available environments

Global Flags:
      --config string   config file (default is $HOME/.bricks/config.yaml)
  -h, --help            Print Help message for Bricks CLI
  -v, --version         Print bricks CLI version

Use "bricks env [command] --help" for more information about a command.

Install

Use install command to plan and apply Blueprints.

Deploy a blueprint to a selected environment

Usage:
  bricks install [blueprint] [flags]

Examples:

  bricks install @bluebricks/postgres --env=production --props-file=path/to/props.json

Flags:
      --deployment string   Deployment slug
  -e, --env string          Environment slug as the deployment target
  -p, --props string        Blueprint custom properties
  -f, --props-file string   Path to JSON file containing custom properties
      --set-slug string     Set deployment slug
  -y, --yes                 Automatically consent to the planning, direct deploy

Global Flags:
      --config string   config file (default is $HOME/.bricks/config.yaml)
  -h, --help            Print Help message for Bricks CLI
  -v, --version         Print bricks CLI version

Uninstall

Destroy a blueprint from a selected environment

Destroy a specified blueprint from the selected environment, removing all associated resources

Usage:
  bricks uninstall [blueprint] [flags]

Examples:

  bricks uninstall @bluebricks/postgres --env=playground

Flags:
      --deployment string   Deployment slug
  -e, --env string          Environment slug as the deployment target

Global Flags:
      --config string   config file (default is $HOME/.bricks/config.yaml)
  -h, --help            Print Help message for Bricks CLI
  -v, --version         Print bricks CLI version

Logging Management

Use logger command to manage logging behavior. Learn more about bricks logging here.

Manage logger settings

Usage:
  bricks logger [flags]
  bricks logger [command]

Available Commands:
  cleanup     Disable logger activity
  disable     Disable logger activity
  enable      Enable logger activity
  status      Indicating the logger's activeness

Global Flags:
      --config string   config file (default is $HOME/.bricks/config.yaml)
  -h, --help            Print Help message for Bricks CLI
  -v, --version         Print bricks CLI version

Use "bricks logger [command] --help" for more information about a command.

Telemetry

Use telemtry command to manage CLI analytics and usage tracking Learn more about Bluebricks CLI telemetry here.

Manage telemetry settings

Usage:
  bricks telemetry [flags]
  bricks telemetry [command]

Available Commands:
  disable     Disable telemetry activity
  enable      Enable telemetry activity
  status      Provide an indication if telemetry activity is active

Global Flags:
      --config string   config file (default is $HOME/.bricks/config.yaml)
  -h, --help            Print Help message for Bricks CLI
  -v, --version         Print bricks CLI version

Use "bricks telemetry [command] --help" for more information about a command.

Versioning

Use version command to get the runtime version

bricks CLI by Bluebricks version: 1.2.5

Setup

User setup command to connect cloud vendor to an environment

Register customer cloud on Bluebricks.
		
You need to provide provider as an argument - for now available: aws.

Usage:
  bricks setup [provider] [flags]

Flags:
  -e, --env string       Environment
  -i, --inspect          Inspect template without setup
  -p, --profile string   AWS profile
  -s, --slug string      Cloud slug to be set
      --vendor string    Vendor name
  -y, --yes              Auto-proceed installation

Global Flags:
      --config string   config file (default is $HOME/.bricks/config.yaml)
  -h, --help            Print Help message for Bricks CLI
  -v, --version         Print bricks CLI version

Identity Management

Use login, logout, and whoami to manage your CLI identity.

Login

Connect bricks to a Bluebricks account

Usage:
  bricks login [flags]

Global Flags:
      --config string   config file (default is $HOME/.bricks/config.yaml)
  -h, --help            Print Help message for Bricks CLI
  -v, --version         Print bricks CLI version

Logout

Disconnect bricks from the connected Bluebricks account

Usage:
  bricks logout [flags]

Global Flags:
      --config string   config file (default is $HOME/.bricks/config.yaml)
  -h, --help            Print Help message for Bricks CLI
  -v, --version         Print bricks CLI version

Whoami

Display signed-in user

Usage:
  bricks whoami [flags]

Global Flags:
      --config string   config file (default is $HOME/.bricks/config.yaml)
  -h, --help            Print Help message for Bricks CLI
  -v, --version         Print bricks CLI version