@beads/bd 0.21.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (11) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +124 -0
  3. package/bin/CHANGELOG.md +865 -0
  4. package/bin/LICENSE +21 -0
  5. package/bin/README.md +632 -0
  6. package/bin/bd +0 -0
  7. package/bin/bd.js +54 -0
  8. package/bin/bd_0.21.5_darwin_arm64.tar.gz +0 -0
  9. package/package.json +52 -0
  10. package/scripts/postinstall.js +206 -0
  11. package/scripts/test.js +29 -0
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 Beads Contributors
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,124 @@
1
+ # @beads/bd - Beads Issue Tracker
2
+
3
+ [![npm version](https://img.shields.io/npm/v/@beads/bd)](https://www.npmjs.com/package/@beads/bd)
4
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
5
+
6
+ **Give your coding agent a memory upgrade**
7
+
8
+ 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.
9
+
10
+ ## Installation
11
+
12
+ ```bash
13
+ npm install -g @beads/bd
14
+ ```
15
+
16
+ Or as a project dependency:
17
+
18
+ ```bash
19
+ npm install --save-dev @beads/bd
20
+ ```
21
+
22
+ ## What is Beads?
23
+
24
+ Beads is an issue tracker designed specifically for AI coding agents. It provides:
25
+
26
+ - ✨ **Zero setup** - `bd init` creates project-local database
27
+ - 🔗 **Dependency tracking** - Four dependency types (blocks, related, parent-child, discovered-from)
28
+ - 📋 **Ready work detection** - Automatically finds issues with no open blockers
29
+ - 🤖 **Agent-friendly** - `--json` flags for programmatic integration
30
+ - 📦 **Git-versioned** - JSONL records stored in git, synced across machines
31
+ - 🌍 **Distributed by design** - Share one logical database via git
32
+
33
+ ## Quick Start
34
+
35
+ After installation, initialize beads in your project:
36
+
37
+ ```bash
38
+ bd init
39
+ ```
40
+
41
+ Then tell your AI agent to use bd for task tracking instead of markdown:
42
+
43
+ ```bash
44
+ echo "Use 'bd' commands for issue tracking instead of markdown TODOs" >> AGENTS.md
45
+ ```
46
+
47
+ Your agent will automatically:
48
+ - Create and track issues during work
49
+ - Manage dependencies between tasks
50
+ - Find ready work with `bd ready`
51
+ - Keep long-term context across sessions
52
+
53
+ ## Common Commands
54
+
55
+ ```bash
56
+ # Find ready work
57
+ bd ready --json
58
+
59
+ # Create an issue
60
+ bd create "Fix bug" -t bug -p 1
61
+
62
+ # Show issue details
63
+ bd show bd-a1b2
64
+
65
+ # List all issues
66
+ bd list --json
67
+
68
+ # Update status
69
+ bd update bd-a1b2 --status in_progress
70
+
71
+ # Add dependency
72
+ bd dep add bd-f14c bd-a1b2
73
+
74
+ # Close issue
75
+ bd close bd-a1b2 --reason "Fixed"
76
+ ```
77
+
78
+ ## Claude Code for Web Integration
79
+
80
+ To auto-install bd in Claude Code for Web sessions, add to your SessionStart hook:
81
+
82
+ ```bash
83
+ # .claude/hooks/session-start.sh
84
+ npm install -g @beads/bd
85
+ bd init --quiet
86
+ ```
87
+
88
+ This ensures bd is available in every new session without manual setup.
89
+
90
+ ## Platform Support
91
+
92
+ This package downloads the appropriate native binary for your platform:
93
+
94
+ - **macOS**: darwin-amd64, darwin-arm64
95
+ - **Linux**: linux-amd64, linux-arm64
96
+ - **Windows**: windows-amd64
97
+
98
+ ## Full Documentation
99
+
100
+ For complete documentation, see the [beads GitHub repository](https://github.com/steveyegge/beads):
101
+
102
+ - [Complete README](https://github.com/steveyegge/beads#readme)
103
+ - [Quick Start Guide](https://github.com/steveyegge/beads/blob/main/QUICKSTART.md)
104
+ - [Installation Guide](https://github.com/steveyegge/beads/blob/main/INSTALLING.md)
105
+ - [FAQ](https://github.com/steveyegge/beads/blob/main/FAQ.md)
106
+ - [Troubleshooting](https://github.com/steveyegge/beads/blob/main/TROUBLESHOOTING.md)
107
+
108
+ ## Why npm Package vs WASM?
109
+
110
+ This npm package wraps the native bd binary rather than using WebAssembly because:
111
+
112
+ - ✅ Full SQLite support (no custom VFS needed)
113
+ - ✅ All features work identically to native bd
114
+ - ✅ Better performance (native vs WASM overhead)
115
+ - ✅ Simpler maintenance
116
+
117
+ ## License
118
+
119
+ MIT - See [LICENSE](LICENSE) for details.
120
+
121
+ ## Support
122
+
123
+ - [GitHub Issues](https://github.com/steveyegge/beads/issues)
124
+ - [Documentation](https://github.com/steveyegge/beads)