beads/npm-package
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
..
bin Add npm package for bd with native binaries (bd-febc) 2025-11-03 11:41:18 -08:00
scripts docs: update user-facing URLs from steveyegge/beads to gastownhall/beads 2026-04-24 08:17:42 -07:00
test docs: update user-facing URLs from steveyegge/beads to gastownhall/beads 2026-04-24 08:17:42 -07:00
.npmignore Add npm package for bd with native binaries (bd-febc) 2025-11-03 11:41:18 -08:00
CLAUDE_CODE_WEB.md Document supported go install modes (bd-o5a) (#3480) 2026-04-25 11:30:19 -07:00
INTEGRATION_GUIDE.md docs: update user-facing URLs from steveyegge/beads to gastownhall/beads 2026-04-24 08:17:42 -07:00
LAUNCH.md docs: update user-facing URLs from steveyegge/beads to gastownhall/beads 2026-04-24 08:17:42 -07:00
LICENSE Add npm package for bd with native binaries (bd-febc) 2025-11-03 11:41:18 -08:00
package.json Release 1.0.3 2026-04-24 16:15:11 -07:00
PUBLISHING.md docs: update user-facing URLs from steveyegge/beads to gastownhall/beads 2026-04-24 08:17:42 -07:00
README.md docs: update user-facing URLs from steveyegge/beads to gastownhall/beads 2026-04-24 08:17:42 -07:00
SUMMARY.md docs: update user-facing URLs from steveyegge/beads to gastownhall/beads 2026-04-24 08:17:42 -07:00
TESTING.md Add integration tests and release documentation for npm package 2025-11-03 11:54:37 -08:00

@beads/bd - Beads Issue Tracker

npm version License: MIT

Give your coding agent a memory upgrade

Beads is a lightweight memory system for coding agents, using a graph-based issue tracker. This npm package provides easy installation of the native bd binary for Node.js environments, including Claude Code for Web.

Installation

npm install -g @beads/bd

Or as a project dependency:

npm install --save-dev @beads/bd

What is Beads?

Beads is an issue tracker designed specifically for AI coding agents. It provides:

  • ✨ Zero setup - bd init creates project-local database
  • 🔗 Dependency tracking - Four dependency types (blocks, related, parent-child, discovered-from)
  • 📋 Ready work detection - Automatically finds issues with no open blockers
  • 🤖 Agent-friendly - --json flags for programmatic integration
  • 📦 Version-controlled - Dolt database with full history and branching
  • 🌍 Distributed by design - Share one logical database via Dolt remotes

Quick Start

After installation, initialize beads in your project:

bd init

Then tell your AI agent to use bd for task tracking instead of markdown:

echo "Use 'bd' commands for issue tracking instead of markdown TODOs" >> AGENTS.md

Your agent will automatically:

  • Create and track issues during work
  • Manage dependencies between tasks
  • Find ready work with bd ready
  • Keep long-term context across sessions

Common Commands

# Find ready work
bd ready --json

# Create an issue
bd create "Fix bug" -t bug -p 1

# Show issue details
bd show bd-a1b2

# List all issues
bd list --json

# Start work
bd update bd-a1b2 --claim

# Add dependency
bd dep add bd-f14c bd-a1b2

# Close issue
bd close bd-a1b2 --reason "Fixed"

Claude Code for Web Integration

To auto-install bd in Claude Code for Web sessions, add to your SessionStart hook:

# .claude/hooks/session-start.sh
npm install -g @beads/bd
bd init --quiet

This ensures bd is available in every new session without manual setup.

Platform Support

This package downloads the appropriate native binary for your platform:

  • macOS: darwin-amd64, darwin-arm64
  • Linux: linux-amd64, linux-arm64
  • Windows: windows-amd64

Full Documentation

For complete documentation, see the beads GitHub repository:

Why npm Package vs WASM?

This npm package wraps the native bd binary rather than using WebAssembly because:

  • ✅ Full SQLite support (no custom VFS needed)
  • ✅ All features work identically to native bd
  • ✅ Better performance (native vs WASM overhead)
  • ✅ Simpler maintenance

License

MIT - See LICENSE for details.

Support