Configuration Management

Understand the bricks CLI configuration files stored in ~/.bricks, including config.yaml and environment.yaml.

bricks uses multiple configuration files, which are stored at $HOME/.bricks. Each file has a different purpose and used in different stages at runtime:

config.yaml

This file is used to store persistent configuration changes that were made by the CLI, following the user's instructions. For example, when a user decides to turn on telemetry or logs, the configuration will be saved in the config.yaml file.

CLI loads ~/.bricks/config.yaml file right at the beginning and will overwrite default configuration.

// environment.yaml example
log: true
log_format: json
log_level: info
non_interactive: true
port: "8090"
skip_version_check: false
telemetry: false

credentials.yaml

This file holds sensitive information about the user session such as its identifier (user id), and its API token. In the sequence of loading, credentials.yaml file is being loaded at last.

// credentials.yaml example
token: Bearer eyJhb...E2_A
userid: [e-mail]