- Removed bare first-party go install .../cmd/bd@latest guidance from docs,
website docs, plugin/npm docs, examples, and doctor hints.
- Standardized on:
- CGO_ENABLED=0 go install ... for server-mode only
- CGO_ENABLED=1 GOFLAGS=-tags=gms_pure_go go install ... for embedded-
capable
- Added scripts/check-go-install-guidance.sh and wired it into CI.
- Updated default.nix to use gms_pure_go instead of ICU flags.
Validation passed locally:
- make test
- golangci-lint run --build-tags=gms_pure_go ./...
- ./scripts/check-go-install-guidance.sh
- ./scripts/check-build-tags.sh
- go test -tags gms_pure_go ./cmd/bd/doctor
- doc flag check
2.1 KiB
2.1 KiB
| id | title | sidebar_position |
|---|---|---|
| installation | Installation | 1 |
Installing bd
Quick Install (Recommended)
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
- Initialize a project:
cd your-project && bd init - Learn the basics: Quick Start
- Configure your editor: IDE Setup
- Upgrading later: Upgrading