Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.breadbox.sh/llms.txt

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

The CLI ships in the same binary as the server. Most users install the full build alongside the server itself, then use breadbox auth login to drive other Breadboxes from the same machine. Agent and ops hosts that should never run a server install the lite build (breadbox-cli) instead.

​
Pick a build

Default build. One binary that runs breadbox serve (full HTTP server), breadbox mcp (stdio MCP host), and every CLI command. This is what the Quickstart installs.Use this when you want one machine that hosts Breadbox and can also drive a remote Breadbox via breadbox auth login.

​
From a pre-built release

1

Download

Grab the binary for your platform from the GitHub releases page. Release artifacts include breadbox (full) and breadbox-cli (lite) for linux-amd64, linux-arm64, darwin-amd64, darwin-arm64.
2

Verify

Each release ships a SHA256SUMS file. Verify the binary before installing:
sha256sum -c SHA256SUMS --ignore-missing
3

Install

Move the binary onto your PATH and mark it executable:
chmod +x breadbox-cli
sudo mv breadbox-cli /usr/local/bin/
breadbox-cli version

​
From source

You need Go 1.24 or later. 
git clone https://github.com/canalesb93/breadbox.git
cd breadbox
go build -o breadbox ./cmd/breadbox
./breadbox version
The version metadata is set via -ldflags "-X main.version=<tag>"; without that flag the binary reports dev.

​
Shell completion

The CLI ships completion scripts for bash, zsh, and fish. 
breadbox completion bash | sudo tee /etc/bash_completion.d/breadbox > /dev/null
After installing, restart your shell. Tab-complete nouns, verbs, and flag names the same way you would with gh or kubectl.

​
Verify the install

breadbox version
# breadbox 0.1.0 (commit abc1234, built 2026-05-27)

breadbox --help
# Usage: breadbox <command> [flags]
# ...
Lite builds report the same command tree minus serve, mcp, init, migrate, reveal-key, and backup. If a server-only command shows up under breadbox-cli --help, you’ve grabbed the full binary by accident.

​
Next steps

Authenticate

Add a host and mint a key with device-code login or paste mode.

Headless deployment

Drive a remote Breadbox from an agent host.