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.

circle-info

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

Create, publish, version, and manage blueprints and packages

Deploy a blueprint to a collection

Destroy a blueprint from a collection

Plan and apply resources locally or remotely

View and manage deployments

Automate artifact and blueprint updates based on Git changes

Infrastructure Management

Command
Description

Create, list, enable, disable, and delete collections

Manage cloud provider accounts (AWS, GCP, Azure, Self-Hosted)

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

Connect the CLI to a Bluebricks account

Disconnect from the current Bluebricks account

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)

Print the CLI version

Global Flags

Every command accepts the following flags:

Last updated

Was this helpful?