Commit graph

42 commits

Author SHA1 Message Date
matt wilkie
e2e4975044
Document supported go install modes (bd-o5a) (#3480)
- 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
2026-04-25 11:30:19 -07:00
Ben Madore
3b39ce577a
docs: update user-facing URLs from steveyegge/beads to gastownhall/beads
Co-authored-by: Ben Madore <823868+madorb@users.noreply.github.com>
2026-04-24 08:17:42 -07:00
matt wilkie
5715f54ce4
feat: make CGO_ENABLED=0 the blessed go install path (GH#3303)
Option D from GH#3303. Routes go install users through CGO_ENABLED=0 as the simplest path (server-mode only, no C toolchain needed). install.sh falls back to nocgo if cgo install fails. Detailed nocgo error message guides users to server mode or an embedded-capable install. Updates INSTALLING.md and ICU-POLICY.md accordingly.
2026-04-16 12:06:31 -07:00
matt wilkie
df25aa9229
Rename ICU-only test path to explicit opt-in workflow (bd-b18) (#3291) 2026-04-16 08:54:24 -07:00
matt wilkie
d919e1aabe docs: add ICU regex policy and update build dependency guidance (GH-3126)
Add docs/ICU-POLICY.md as the authoritative reference for how ICU is
handled across all platforms. Update CONTRIBUTING.md and INSTALLING.md
to stop listing ICU as a build requirement (it's test-only since all
builds use gms_pure_go).

Resolves confusion from overlapping PRs (#2991, #3066, #3112) where
agents and contributors were doing/undoing each other's ICU fixes
without a written policy.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-07 20:24:05 -07:00
matt wilkie
4fe05a3bec
Use getting started docs as bugs to fix (#3034)
* fix: narrow cross-version smoke CI triggers and warn on high skip rate

Remove push-to-main and PR triggers from cross-version smoke test
workflow — 30-45 min runtime is too costly for every push. Keep tag
pushes (releases/RCs) and manual dispatch.

Add a visible warning when >80% of tested versions are skipped, printed
to stderr and GitHub step summary. Prevents silent "all passed" when
nearly nothing actually ran.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* chore: add .buildflags for consistent ICU build configuration

Amp-Thread-ID: https://ampcode.com/threads/T-019d5c3f-42eb-7794-8d59-524bbf77bdf8
Co-authored-by: Amp <amp@ampcode.com>

* Add analysis of getting-started docs: necessity vs. fixable errors

Analyzes ~3,200 lines of getting-started documentation across 9 files.
Finds ~50% of the content compensates for tool-level UX gaps that should
be fixed rather than documented. Categorizes every section as genuinely
necessary, useful reference, workaround for fixable issue, or redundant.
Includes specific recommendations for both tool fixes and doc consolidation.

Requested by @csells.

https://claude.ai/code/session_01Fak22deVmDX3KRBKVptJBL

* Streamline getting-started docs: reduce noise, fix user-facing paths

QUICKSTART.md:
- Change all ./bd to bd (reflects installed binary, not local build)
- Replace go-build install section with brew/npm + link to INSTALLING.md
- Remove Notion sync, database maintenance, and migration sections
  (these are advanced topics, not quickstart material)
- Add "Database maintenance" link to Next Steps

README.md:
- Consolidate installation from ~30 lines to ~8 lines
- Remove CGO/build-from-source details (belong in INSTALLING.md)
- Add links to INSTALLING.md sections for all install methods

INSTALLING.md:
- Demote go install/source to "Contributors / Go developers" in matrix
- Move Build Dependencies section after platform installs, retitle to
  "Build Dependencies (Contributors Only)" with skip-if-prebuilt note
- Add cross-reference to TROUBLESHOOTING.md in troubleshooting section

Net effect: -91 lines, clearer separation between user and contributor
paths, less noise in the first-time experience.

https://claude.ai/code/session_01Fak22deVmDX3KRBKVptJBL

* fix: detect permission errors in bd init with platform-specific guidance

On Windows, Controlled Folder Access can block bd init from creating
.beads/ with no useful error. Now detects os.IsPermission and prints
specific guidance for Windows (CFA whitelist instructions) and Unix
(ls -la / chmod suggestions) instead of a generic failure message.

https://claude.ai/code/session_01Fak22deVmDX3KRBKVptJBL

* fix: add circuit breaker cleanup to bd doctor --fix

Stale circuit breaker files in /tmp/beads-circuit/ can block all bd
operations. Previously users had to manually rm these files. Now
bd doctor detects stale breaker files as a fixable check, and
bd doctor --fix clears them automatically via CleanStaleCircuitBreakerFiles.

https://claude.ai/code/session_01Fak22deVmDX3KRBKVptJBL

* feat: warn about multiple bd binaries in PATH

bd version now scans PATH for duplicate bd executables and warns when
more than one is found. This catches the common case where go install
and Homebrew binaries coexist, causing version confusion. Symlinks
are resolved to avoid false positives.

https://claude.ai/code/session_01Fak22deVmDX3KRBKVptJBL

* fix: show holding process PID in database lock errors

When the Dolt database is locked, the error message now tries to
identify the holding process by scanning /proc for bd/dolt processes.
On Linux, users see e.g. "Process 12345 (bd/dolt) may be holding
the lock." Gracefully degrades to the previous message on platforms
without /proc (macOS, Windows, FreeBSD).

https://claude.ai/code/session_01Fak22deVmDX3KRBKVptJBL

* fix: only flag circuit breaker files as stale after TTL expires

CheckCircuitBreaker() was counting any open/half-open breaker as stale
regardless of age. This could reset a legitimately active breaker
during a real outage. Now uses the same 5-minute staleness threshold
as CleanStaleCircuitBreakerFiles() — only breakers older than 5 minutes
(from TrippedAt or LastFailure) are flagged for cleanup.

https://claude.ai/code/session_01Fak22deVmDX3KRBKVptJBL

* fix: correct broken doc anchors in README installation links

The "go install" and "from source" links pointed to nonexistent anchors
in INSTALLING.md. Found during review checklist testing.

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

* fix: suppress gosec G304 false positive in circuit breaker check

Path comes from filepath.Glob with a controlled pattern, matching
the same nolint pattern used in internal/storage/dolt/circuit.go.

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

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-authored-by: Amp <amp@ampcode.com>
2026-04-05 16:09:58 -07:00
maphew
4d23a6cc7e harden installers and docs for transparent trust model (GH#1857)
Amp-Thread-ID: https://ampcode.com/threads/T-019cf2b7-8afa-717c-abda-e7a8000e1b9b
Co-authored-by: Amp <amp@ampcode.com>
2026-03-15 12:02:56 -07:00
topaz
062aedbed7 docs: remove stale daemon references from all documentation (GH#1982)
Sweep 65 markdown files across docs/, website/, claude-plugin/, examples/,
integrations/, and root to replace removed `bd daemon` references with
current Dolt server mode equivalents. CHANGELOG.md preserved per policy.

Key replacements:
- `bd daemon start/stop/status` → `bd dolt start/stop` / `bd doctor`
- `bd daemons killall/health/logs` → `bd dolt stop` / `bd doctor`
- `--no-daemon` flag → removed (embedded mode is default)
- `BEADS_NO_DAEMON` / `BEADS_DAEMON_MODE` env vars → removed
- `.beads/bd.sock` → removed
- "daemon mode" / "direct mode" → "server mode" / "embedded mode"
- daemon.pid/daemon.log → .beads/dolt/sql-server.pid/.log

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Executed-By: beads/polecats/topaz
Rig: beads
Role: polecats
2026-02-22 17:57:53 -08:00
beads/crew/lizzy
f383ce3efd feat(setup): add Mux setup recipe with layered AGENTS and managed hooks
Adds bd setup mux with support for layered AGENTS.md installation
(root, project .mux/, global ~/.mux/) and managed hook files
(.mux/init, .mux/tool_post, .mux/tool_env). Makes AGENTS removal
non-destructive (preserves user content outside managed markers).

From: PR #1888 by alexx-ftw (cherry-picked, rebased onto current main)

Co-Authored-By: Alexx <alexx-ftw@users.noreply.github.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-22 15:33:06 -08:00
ZenchantLive
818c6f0226 docs: remove stale daemon command references (GH#1819) 2026-02-18 22:50:21 -08:00
drmikecrowe
97fa7ccd18
Revise INSTALLING.md for mise installation methods
Updated installation instructions for beads using mise.
2026-02-15 07:08:52 -05:00
Jan Killian
5844fa8edb
Add installation via Mise to INSTALLING.md
Added installation instructions for Mise package manager.
2026-02-11 08:45:19 +01:00
Steve Yegge
55435d95a1
Merge pull request #1622 from PabloLION/fix/brew-naming-docs-ci
fix: correct brew commands and remove dead homebrew CI job
2026-02-09 11:28:47 -08:00
Pablo LION
a46c1db86e fix: correct brew commands and remove dead homebrew CI job
The Homebrew formula is named "beads" (not "bd"), so all brew commands
must use `brew install beads` / `brew upgrade beads`. Also removes the
dead update-homebrew job from release.yml — homebrew-core handles
formula updates automatically.

Follows up on #1557 which fixed the Go code in bd doctor.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-09 08:02:42 +01:00
Taylor Wilsdon
69cbfba8c7 add clarifying documentation on client upgrade process, currently unclear 2026-02-08 18:13:43 -05:00
jasper
8202e55ac3 fix: remove unnecessary ICU dependency from Windows CI build (dolt-test-h7bp)
Windows builds do not require ICU libraries:
- go-mysql-server uses pure-Go regex via gms_pure_go build tag
- go-icu-regex has a Windows-specific pure-Go implementation (regex_windows.go)
- The only CGO deps on Windows are runtime/cgo and gozstd (bundled C source)

Changes:
- CI: Remove MSYS2/ICU setup, build with CGO_ENABLED=0 -tags gms_pure_go
- Makefile: Add Windows-specific comments clarifying ICU is not needed
- docs/INSTALLING.md: Clarify Windows build instructions and ICU requirements

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Executed-By: beads/polecats/jasper
Rig: beads
Role: polecats
2026-02-07 22:47:08 -08:00
beads/crew/emma
2137693dad revert: restore embedded Dolt mode (was only supposed to be removed from Gas Town)
Revert commits e5330641 and 0df41523 which removed embedded Dolt mode
from the beads codebase. The embedded Dolt removal was only intended for
Gas Town, not for Beads.

Restores:
- dolthub/driver dependency and embedded connection path
- Advisory flock (AccessLock) for concurrent process protection
- Embedded connector lifecycle management in DoltStore
- All CGO build tags across ~45 files
- Vendored go-icu-regex library
- nocgo stub files for non-CGO builds
- Bootstrap and embedded_uow helpers
- factory_dolt_test.go and dolt_singleprocess_test.go

Merge conflict resolutions:
- store.go: TCP fail-fast check wrapped inside if cfg.ServerMode
- store.go: backtick-quoting for embedded CREATE DATABASE (prefix-based names)
- perf_dolt.go: port references updated from 3306 to 3307
- ci.yml: restored continue-on-error for Nix (dolthub/driver requires Go 1.25.6+)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Executed-By: beads/crew/emma
Rig: beads
Role: crew
2026-02-07 21:21:24 -08:00
beads/crew/emma
0df415230f chore: clean up orphaned embedded Dolt references
Remove dead -tags gms_pure_go from Windows cross-compile, remove //go:build
cgo constraint from benchmarks, and remove CGO/ICU build dependencies from
INSTALLING.md that no longer apply after embedded Dolt driver removal.

Resolves merge conflicts from PR #1579 and applies changes to main.

Co-authored-by: turian <turian@users.noreply.github.com>

Executed-By: beads/crew/emma
Rig: beads
Role: crew
2026-02-07 20:14:06 -08:00
matt wilkie
17e54c59a0 Enable Dolt on Windows via gms_pure_go build tag
- Add pure_go_windows.go with build constraint to auto-enable gms_pure_go tag
- Update Makefile to use -tags gms_pure_go on Windows builds
- Update INSTALLING.md to document Windows Dolt support via pure-Go regex

Uses upstream go-mysql-server's gms_pure_go build tag instead of vendoring.
This avoids ICU/CGO dependencies while keeping full functionality.

Fixes #1497

Amp-Thread-ID: https://ampcode.com/threads/T-019c3339-57d9-75b9-8d86-d5a79d77b9c6
Co-authored-by: Amp <amp@ampcode.com>
2026-02-06 15:32:14 -07:00
Matt Wilkie
fae6b4d975 Enable Dolt build on Windows via pure-go regex (main-3vt) 2026-02-04 10:14:50 -07:00
Matt Wilkie
c761bc3c89 Document Windows Dolt limitation (main-3vt) 2026-02-04 10:05:36 -07:00
Matt Wilkie
1a6beddbc8 Document ICU build deps and hint in installer (bd-1409) 2026-02-04 09:30:52 -07:00
Matt Wilkie
b7e0fc37e5 Use prebuilt Windows releases in installer (bd-1493) 2026-02-04 09:22:01 -07:00
Scott Nixon
18f47fe8b6
docs: add GitHub Copilot integration guide with cross-platform MCP paths (#1348)
* fix(export): populate export_hashes after successful export (GH#1278)

Child issues created with --parent were missing from export_hashes table,
which affects integrity tracking and future incremental export features.

This fix ensures SetExportHash() is called for all exported issues:
- Updated ExportResult to include IssueContentHashes map
- Updated finalizeExport() to call SetExportHash() for each exported issue
- Updated exportToJSONLDeferred() to collect content hashes during export
- Updated performIncrementalExport() to collect content hashes for dirty issues
- Updated exportToJSONLWithStore() to call SetExportHash() after export
- Updated daemon's handleExport() to call SetExportHash() after export

Added test TestExportPopulatesExportHashes to verify the fix works for
both regular and hierarchical (child) issue IDs.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* docs: add GitHub Copilot integration guide

Add comprehensive documentation for using beads with GitHub Copilot in VS Code via the MCP server.

New files:
- docs/COPILOT_INTEGRATION.md - Complete setup guide with prerequisites, MCP tools reference, example workflows, troubleshooting, and FAQ
- website/docs/integrations/github-copilot.md - Shorter website version

Updated files:
- docs/INSTALLING.md - Added GitHub Copilot row to setup matrix and new "GitHub Copilot (VS Code)" section with quick setup steps
- website/docs/getting-started/ide-setup.md - Added GitHub Copilot section
- website/docs/integrations/mcp-server.md - Added VS Code / GitHub Copilot configuration examples for both .vscode/mcp.json and settings.json

Key clarifications:
- Beads is a system-wide CLI tool installed once, not cloned into projects
- The .beads/ directory only contains the issue database
- Added FAQ addressing "Do I need to clone beads?" explicitly

Fixes #148

* docs: add cross-platform paths for user-level VS Code MCP config

  Add Linux and Windows paths alongside macOS for the VS Code
  user-level MCP configuration. Users can now find the correct
  path for their platform in a simple table format.

  Paths by platform:
  - macOS: ~/Library/Application Support/Code/User/mcp.json
  - Linux: ~/.config/Code/User/mcp.json
  - Windows: %APPDATA%\Code\User\mcp.json

  Fixes #148

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-27 11:25:14 -08:00
Rui Chen
66d1e63158
feat: update to use core tap for beads installation (#1261)
* feat: update to use core tap for beads installation

Signed-off-by: Rui Chen <rui@chenrui.dev>

* remove custom tap related code and refs

Signed-off-by: Rui Chen <rui@chenrui.dev>

---------

Signed-off-by: Rui Chen <rui@chenrui.dev>
2026-01-24 17:11:21 -08:00
matt wilkie
ce622f5688
feat(setup): add Codex CLI setup recipe (#1243)
* Add Codex setup recipe

* Sync beads issues (bd-1zo)

---------

Co-authored-by: Amp <amp@example.com>
2026-01-21 21:50:01 -08:00
Jordan Hubbard
8c04eb7e7f
docs(install): mention FreeBSD support (#1010)
Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
2026-01-11 00:03:18 -08:00
Yaroslav Lapin
4eb2856143
Add bun installation method to INSTALLING.md (#930) 2026-01-06 19:14:38 -08:00
beads/crew/dave
1ffd1431b7 docs: update skill names from /bd-* to /beads:* (#862)
The Claude Code plugin uses beads:* prefix for slash commands, not bd-*.
Updated all documentation to reflect actual installed command names.

Files updated:
- docs/PLUGIN.md
- docs/INSTALLING.md
- website/docs/integrations/claude-code.md
- website/static/llms-full.txt
- commands/init.md, stats.md, workflow.md

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

Executed-By: beads/crew/dave
Rig: beads
Role: crew
2026-01-02 17:07:49 -08:00
Steve Yegge
0f008d3979 docs: Add components overview explaining CLI vs Plugin vs MCP
Clarifies the relationship between bd CLI, Claude Code Plugin,
and MCP server. Most users only need the CLI.

Closes #782

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 14:00:05 -08:00
Steve Yegge
274f53514a docs: Add installation method comparison table
Clarifies trade-offs between Homebrew, npm, script, go install,
and source builds. Homebrew is recommended as the default.

Closes #779

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-28 13:56:31 -08:00
Steve Yegge
d0694e6171 docs: update documentation for CLI consolidation (bd-bxqv)
Update docs to reflect CLI command restructuring:
- migrate-tombstones → migrate tombstones
- bd quickstart is now hidden, point to docs/QUICKSTART.md
- Add CLI consolidation section to CHANGELOG.md
- Remove quickstart from command tables

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-27 16:21:08 -08:00
Steve Yegge
109fa6364b Merge GH#518 setup docs 2025-12-16 01:18:51 -08:00
Steve Yegge
39a58fd085 docs: document bd setup command
Add comprehensive documentation for the bd setup command which was
largely undocumented (GH#518):

- CLI_REFERENCE.md: Add new "Editor Integration" section documenting
  bd setup claude/cursor/aider commands with all flags
- INSTALLING.md: Fix incorrect reference to "bd hooks install" for
  editor integration - should be "bd setup <editor>"
- CLAUDE_INTEGRATION.md: Add Installation section with bd setup claude
  examples

Fixes: GH#518

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-16 01:08:42 -08:00
Steve Yegge
25ea1e7de3 docs: fix broken relative links across documentation
Fixes 46 broken relative links across 20 documentation files in docs/.

Changes:
- Added ../ prefix for root files (README.md, AGENTS.md)
- Removed ../ prefix for sibling docs files
- Removed dead links to non-existent files
- Fixed subdirectory paths

Based on PR #574 by chrisvaillancourt.

Co-Authored-By: Chris Vaillancourt <chrisvaillancourt@users.noreply.github.com>
2025-12-16 00:46:08 -08:00
matt wilkie
e01b7412d9 feat: add Git worktree compatibility (PR #478)
Adds comprehensive Git worktree support for beads issue tracking:

Core changes:
- New internal/git/gitdir.go package for worktree detection
- GetGitDir() returns proper .git location (main repo, not worktree)
- Updated all hooks to use git.GetGitDir() instead of local helper
- BeadsDir() now prioritizes main repository's .beads directory

Features:
- Hooks auto-install in main repo when run from worktree
- Shared .beads directory across all worktrees
- Config option no-install-hooks to disable auto-install
- New bd worktree subcommand for diagnostics

Documentation:
- New docs/WORKTREES.md with setup instructions
- Updated CHANGELOG.md and AGENT_INSTRUCTIONS.md

Testing:
- Updated tests to use exported git.GetGitDir()
- Added worktree detection tests

Co-authored-by: Claude <noreply@anthropic.com>
Closes: #478
2025-12-13 12:50:33 -08:00
Steve Yegge
b9bd45bcb3 docs: add mise installation instructions (#526)
Add mise (polyglot runtime manager) as an installation option using the
ubi backend to install from GitHub releases.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-13 09:55:27 +11:00
peter schilling
8052f3d6a5
Update slash commands to use beads: prefix (#467)
Marketplace-installed plugins use the beads: prefix instead of the
old bd- prefix. Updated all documentation and examples to reflect the
current slash command naming.

Fixes #463
2025-12-12 14:51:35 -08:00
Steve Yegge
3de3b60b45 Add uninstall documentation (GH #445)
- Create docs/UNINSTALLING.md with comprehensive uninstall steps
- Add link to UNINSTALLING.md from INSTALLING.md
- Cover: daemon, hooks, merge driver, .beads dir, worktree cleanup

Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
2025-12-01 21:05:19 -08:00
Steve Yegge
eeda2053b8 bd sync: 2025-11-26 18:07:01 2025-11-26 18:07:01 -08:00
anansi
a020c6c7fe
Add uv prerequisite to Claude Code plugin documentation (#293) 2025-11-12 10:49:38 -08:00
Steve Yegge
584c266684 Reorganize project structure: move Go files to internal/beads, docs to docs/
Amp-Thread-ID: https://ampcode.com/threads/T-7a71671d-dd5c-4c7c-b557-fa427fceb04f
Co-authored-by: Amp <amp@ampcode.com>
2025-11-05 21:04:00 -08:00
Renamed from INSTALLING.md (Browse further)