Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.bricks.tools/llms.txt

Use this file to discover all available pages before exploring further.

BRICKS CLI ships as a native standalone executable for macOS, Linux, and Windows. No Node.js runtime is required. If you prefer, you can also install it from npm or Bun.

Install

curl -fsSL https://cdn.bricks.tools/bricks-cli/release/install.sh | sh
The script detects your architecture (Apple Silicon or Intel), downloads the native binary to ~/.local/bin/bricks, and makes it executable.If ~/.local/bin is not on your PATH, add this to your shell profile:
export PATH="$HOME/.local/bin:$PATH"

Verify

bricks --version
If the command is not found, confirm that your install directory is on your PATH and restart your terminal.

Beta channel

Install the beta channel alongside the stable release. The beta binary is named bricks-beta, so both channels can coexist.
curl -fsSL https://cdn.bricks.tools/bricks-cli/beta/install.sh | sh -s -- --beta
Run it with:
bricks-beta --version

Update

Run bricks update-cli to update an existing install in-place. It auto-detects how the CLI was installed (npm, Bun, or standalone binary) and runs the matching update command. See bricks update-cli in the command reference.
bricks update-cli         # prompts before updating
bricks update-cli -y      # non-interactive

Uninstall

# Stable
curl -fsSL https://cdn.bricks.tools/bricks-cli/release/uninstall.sh | sh

# Beta
curl -fsSL https://cdn.bricks.tools/bricks-cli/beta/uninstall.sh | sh -s -- --beta

Next steps

Authentication

Log in with a passcode and manage workspace profiles.

Command reference

Full reference for every CLI command and option.