beads/website/versioned_docs/version-1.0.0/getting-started/installation.md
matt wilkie b2a4d1d04a
docs: generate CLI reference from live help (#3704)
* docs: generate CLI reference from live help

* docs(cli): move bd version stamp from per-command pages to index only

Drops the `(bd version X.Y.Z)` suffix from the auto-generated header on
every per-command CLI reference page (writeSingleCommandDoc) and the
docs/CLI_REFERENCE.md preamble (writeAllHelp). The version label now
lives only on the index page emitted by scripts/generate-cli-docs.sh:

- Dev tree (website/docs/cli-reference/index.md, docs/CLI_REFERENCE.md):
  labelled "Latest"
- Versioned snapshots (website/versioned_docs/version-X.Y.Z/...):
  labelled with the explicit semver tag parsed from the directory name

This eliminates the 100+-file no-signal diff a release version bump
otherwise produces, restoring the "regen as a separate small commit"
workflow PR #3704 enables. After this change a version bump alone
yields zero diff on the dev tree; only the new versioned snapshot
created at release-cut time carries the new tag. No datestamps are
introduced anywhere — scripts/generate-cli-docs.sh --check remains
deterministic across CI runs.

Refs: mybd-afb, PR #3704

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: CI Bot <ci@beads.test>
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-05 19:43:49 -07:00

2.4 KiB

id title sidebar_position
installation Installation 1

Installing bd

Homebrew (macOS/Linux)

brew install beads

Install Script (macOS/Linux/FreeBSD)

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

PowerShell (Windows)

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

npm

npm install -g @beads/bd

Platform-Specific Notes

macOS

Homebrew is recommended. If you specifically need go install, use one of the supported modes below.

# Server-mode only
CGO_ENABLED=0 go install github.com/steveyegge/beads/cmd/bd@latest

# Embedded-capable
CGO_ENABLED=1 GOFLAGS=-tags=gms_pure_go go install github.com/steveyegge/beads/cmd/bd@latest

Linux

Homebrew works on Linux. For Arch Linux: yay -S beads-git or paru -S beads-git (AUR).

Windows

Native Windows support - no MSYS or MinGW required. The PowerShell installer above is the recommended path. Go is only required for building from source.

Verifying Installation

bd version
bd help

If you see bd: command not found, ensure your install location is in PATH. For Homebrew and npm this is automatic. For go install, add $(go env GOPATH)/bin to your PATH.

Building from Source

Building from source requires Go, git, and a C compiler for embedded Dolt. ICU headers are not required; builds use gms_pure_go.

Platform Command
macOS brew install zstd
Debian/Ubuntu sudo apt-get install -y libzstd-dev
Fedora/RHEL sudo dnf install -y libzstd-devel
git clone https://github.com/gastownhall/beads
cd beads
make build

See CONTRIBUTING.md for full developer setup.

Next Steps

  1. Initialize a project: cd your-project && bd init
  2. Learn the basics: Quick Start
  3. Configure your agent: bd init creates or updates AGENTS.md by default; run bd setup --list for integrations like bd setup codex, bd setup factory, bd setup claude, and bd setup mux
  4. Upgrading later: Upgrading

Use bd onboard only as the manual snippet fallback for unsupported agents, custom instruction files, or existing projects where you cannot rerun bd init/bd setup.