beads/website/docs/getting-started/upgrading.md
Steven Syrek c2f7306b06 fix(docs): correct Homebrew upgrade command in upgrading docs
The comparison table listed `brew upgrade bd` but the correct formula
name is `beads`. The standalone Homebrew section below already had the
correct command.

Fixes #1561

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-02-14 18:14:33 +01:00

2.9 KiB

id title sidebar_position
upgrading Upgrading 4

Upgrading bd

How to upgrade bd and keep your projects in sync.

Checking for Updates

# Current version
bd version

# What's new in recent versions
bd info --whats-new
bd info --whats-new --json  # Machine-readable

Upgrading

Use the command that matches your install method.

Install method Platforms Command
Quick install script macOS, Linux, FreeBSD curl -fsSL https://raw.githubusercontent.com/steveyegge/beads/main/scripts/install.sh | bash
PowerShell installer Windows irm https://raw.githubusercontent.com/steveyegge/beads/main/install.ps1 | iex
Homebrew macOS, Linux brew upgrade beads
go install macOS, Linux, FreeBSD, Windows go install github.com/steveyegge/beads/cmd/bd@latest
npm macOS, Linux, Windows npm update -g @beads/bd
bun macOS, Linux, Windows bun install -g --trust @beads/bd
From source (Unix shell) macOS, Linux, FreeBSD git pull && go build -o bd ./cmd/bd

Quick install script (macOS/Linux/FreeBSD)

curl -fsSL https://raw.githubusercontent.com/steveyegge/beads/main/scripts/install.sh | bash

PowerShell installer (Windows)

irm https://raw.githubusercontent.com/steveyegge/beads/main/install.ps1 | iex

Homebrew

brew upgrade beads

go install

go install github.com/steveyegge/beads/cmd/bd@latest

From Source

cd beads
git pull
go build -o bd ./cmd/bd
sudo mv bd /usr/local/bin/

After Upgrading

Important: After upgrading, update your hooks and restart daemons:

# 1. Check what changed
bd info --whats-new

# 2. Update git hooks to match new version
bd hooks install

# 3. Restart all daemons
bd daemons killall

# 4. Check for any outdated hooks
bd info  # Shows warnings if hooks are outdated

Why update hooks? Git hooks are versioned with bd. Outdated hooks may miss new auto-sync features or bug fixes.

Database Migrations

After major upgrades, check for database migrations:

# Inspect migration plan (AI agents)
bd migrate --inspect --json

# Preview migration changes
bd migrate --dry-run

# Apply migrations
bd migrate

# Migrate and clean up old files
bd migrate --cleanup --yes

Daemon Version Mismatches

If you see daemon version mismatch warnings:

# List all running daemons
bd daemons list --json

# Check for version mismatches
bd daemons health --json

# Restart all daemons with new version
bd daemons killall --json

Troubleshooting Upgrades

Old daemon still running

bd daemons killall

Hooks out of date

bd hooks install

Database schema changed

bd migrate --dry-run
bd migrate

Import errors after upgrade

Check the import configuration:

bd config get import.orphan_handling
bd import -i .beads/issues.jsonl --orphan-handling allow