Skip to content

Installation

Prerequisites

  • Python 3.10 or higher
  • pip, uv, or pipx for installation

Installation Methods

Using pip

pip install brix

uv is a fast Python package manager:

# Install as a tool (isolated environment)
uv tool install brix

# Or add to a project
uv add brix

Using pipx

For isolated installation:

pipx install brix

From Source

git clone https://github.com/Spycner/brix.git
cd brix
uv sync
uv run brix --help

Verify Installation

brix --version

You should see output like:

brix 1.2.0

Shell Completion

Brix supports shell completion for bash, zsh, and fish.

Install Completion

brix --install-completion

Show Completion Script

brix --show-completion

Upgrading

pip

pip install --upgrade brix

uv

uv tool upgrade brix

pipx

pipx upgrade brix

Next Steps