Skip to main content
BRICKS CLI uses authentication profiles to connect to your workspace. Each profile stores a token tied to a specific workspace.

Login

Get a one-time passcode from BRICKS Controller and use it to log in:
Generate the one-time passcode from Manage API Tokens in your workspace. The passcode expires after 5 minutes and can only be used once. You can also log in with a workspace token directly:
Generate or copy your workspace token from Manage API Tokens in BRICKS Controller.

Profiles

Profiles let you manage multiple workspace connections. Each login creates or updates a profile.

Per-command profile override

Use -ap or --auth-profile to run any command as a different profile without switching:
Resolution order: --auth-profile flag > BRICKS_PROFILE environment variable > stored active profile.

Logout