Bricks CLI Overview

Install and configure the bricks CLI for macOS, Linux, or Windows to manage collections, blueprints, and environments from the command line

Bluebricks command line, named bricks, enables engineers to engage with Bluebricks API using the command line interface.

bricks is suitable for CI/CD workflows and provides various functionalities such as collection setup and management, blueprint creation, and installation.

Install bricks Command Line

macOS

Install homebrew, open the terminal, and paste the below command:

brew install bluebricks-co/bricks/bricks

Linux and CI/CD Tools

Windows 11+

Test your Installation

After installing, you can test your installation by running bricks --help.

Additionally, authenticate bricks CLI with your Bluebricks account, use bricks login , and then test your connectivity status by running bricks whoami.

Configuration

The CLI allows external configuration. Discover how to adjust the runtime settings and accommodate various runtimes in the Configuration Management article.

CLI Reference

For the full list of commands, flags, and usage examples, see the CLI Reference.

CLI Logging and Troubleshooting

The Bricks CLI logs its activity locally for debugging purposes and does not ship logs to a remote location. By default, the Bricks CLI logger is off and can be enabled using the bricks logger enable command.

Logs are written to the following path and are chunked into 2MB file sizes:

~/.bricks/bricks-cli.log

The severity level is set to "info" and cannot be changed.

Each command logs its activity to the file using the following scheme:

{
  "level": "info",
  "time": "2024-07-01T15:33:42+03:00",
  "message": ">>> starting bricks"
  ... // additional parameters, message specifics 
}