Installation

Requirements

• Go 1.25 or later (for building from source)
• Git (for git-based registries)

Install Methods

Binary

Download a pre-built binary from the latest release, extract it, and move it to a directory in your PATH:

# Example for Linux (amd64)
tar -xzf bz-linux-amd64.tar.gz
sudo mv bz /usr/local/bin/

Binaries are available for Linux, macOS, and Windows on both amd64 and arm64.

Go Install

Install directly with Go (requires Go 1.25+):

go install github.com/albertocavalcante/bz@latest

Make sure $GOPATH/bin is in your PATH.

From Source

Clone and build from source:

git clone https://github.com/albertocavalcante/bz.git
cd bz
go build -o bz .

Move the binary to a location in your PATH:

sudo mv bz /usr/local/bin/

Verify Installation

Check that bz is installed correctly:

bz --version

You should see the version number printed.

Shell Completion

bz supports shell completion for bash, zsh, fish, and PowerShell.

Bash

# Add to ~/.bashrc
source <(bz completion bash)

Zsh

# Add to ~/.zshrc
source <(bz completion zsh)

Fish

bz completion fish | source

Next Steps

• Quick Start - Get started with bz
• Configuration - Configure bz with Starlark