CLI Reference

Complete reference for every bricks CLI command

The bricks command-line interface lets DevOps and Platform teams manage Infrastructure-as-Code at scale -- from creating and publishing blueprints to deploying them across collections.

For installation and setup, see the CLI Overview.

Run bricks <command> --help from your terminal to see usage details and available flags for any command.

Core Workflow

The commands you will use most often when working with blueprints and deployments.

Command	Description
bricks blueprint	Create, publish, version, and manage blueprints and packages
bricks install	Deploy a blueprint to a collection
bricks uninstall	Destroy a blueprint from a collection
bricks run	Plan and apply resources locally or remotely
bricks deploy	View and manage deployments
bricks updateci	Automate artifact and blueprint updates based on Git changes

Infrastructure Management

Command	Description
bricks collection	Create, list, enable, disable, and delete collections
bricks clouds	Manage cloud provider accounts (AWS, GCP, Azure, Self-Hosted)
bricks setup	Register a customer cloud on Bluebricks

Authentication

Authenticate interactively or with long-lived API tokens for CI/CD. For a step-by-step guide, see Authentication.

Command	Description
bricks login	Connect the CLI to a Bluebricks account
bricks logout	Disconnect from the current Bluebricks account
bricks whoami	Display the signed-in user

For non-interactive environments (CI/CD pipelines, scripts), pass the --api-key flag or configure a long-lived token.

Utility

Command	Description
bricks logger	Enable, disable, and manage CLI logging
bricks telemetry	Enable, disable, and check telemetry settings
bricks completion	Generate shell autocompletion scripts (Bash, Zsh, Fish, PowerShell)
bricks version	Print the CLI version

Global Flags

Every command accepts the following flags:

      --api-key string    API key for authentication (overrides JWT)
      --config string     Config file (default: $HOME/.bricks/config.yaml)
  -h, --help              Print help message
      --non-interactive   Suppress interactive UI elements
  -v, --version           Print CLI version