npm-package/README.md
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.
npm install -g @beads/bd
Or as a project dependency:
npm install --save-dev @beads/bd
Beads is an issue tracker designed specifically for AI coding agents. It provides:
bd init creates project-local database--json flags for programmatic integrationAfter 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:
bd ready# 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"
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.
This package downloads the appropriate native binary for your platform:
For complete documentation, see the beads GitHub repository:
This npm package wraps the native bd binary rather than using WebAssembly because:
MIT - See LICENSE for details.