beads/npm-package/LAUNCH.md
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

4.3 KiB

🚀 @beads/bd Launch Summary

✅ Published Successfully!

Package: @beads/bd Version: 0.21.5 Published: November 3, 2025 Registry: https://registry.npmjs.org Package Page: https://www.npmjs.com/package/@beads/bd

📦 What Was Published

  • Package size: 6.4 MB (tarball)
  • Unpacked size: 17.2 MB
  • Total files: 11
  • Access: Public

Package Contents

@beads/bd@0.21.5
├── bin/
│   ├── bd              (17.1 MB - native binary)
│   ├── bd.js           (1.3 KB - CLI wrapper)
│   ├── CHANGELOG.md    (40.5 KB)
│   ├── LICENSE         (1.1 KB)
│   └── README.md       (23.6 KB)
├── scripts/
│   ├── postinstall.js  (6.2 KB - binary downloader)
│   └── test.js         (802 B - test suite)
├── LICENSE             (1.1 KB)
├── README.md           (3.5 KB)
└── package.json        (1.0 KB)

🎯 Installation

Users can now install bd via npm:

# Global installation (recommended)
npm install -g @beads/bd

# Project dependency
npm install --save-dev @beads/bd

# Verify installation
bd version

🔧 How It Works

  1. User runs npm install -g @beads/bd
  2. npm downloads package (6.4 MB)
  3. Postinstall script runs automatically
  4. Downloads platform-specific binary from GitHub releases
  5. Extracts binary to bin/ directory
  6. Makes binary executable
  7. bd command is ready to use!

🌐 Claude Code for Web Integration

Users can add to .claude/hooks/session-start.sh:

#!/bin/bash
npm install -g @beads/bd
bd init --quiet

This gives automatic bd installation in every Claude Code for Web session!

📊 Success Metrics

All success criteria from bd-febc met:

  • ✅ npm install @beads/bd works - Published and available
  • ✅ All bd commands function identically - Native binary wrapper
  • ✅ SessionStart hook documented - Complete guide in CLAUDE_CODE_WEB.md
  • ✅ Package published to npm registry - Live at npmjs.com

📚 Documentation Provided

  • README.md - Quick start and installation
  • PUBLISHING.md - Publishing workflow for maintainers
  • CLAUDE_CODE_WEB.md - Claude Code for Web integration
  • INTEGRATION_GUIDE.md - Complete end-to-end setup
  • SUMMARY.md - Implementation details
  • LAUNCH.md - This file

🎉 What's Next

For Users

  1. Visit: https://www.npmjs.com/package/@beads/bd
  2. Install: npm install -g @beads/bd
  3. Use: bd init in your project
  4. Read: https://github.com/gastownhall/beads for full docs

For Maintainers

Future updates:

  1. Update npm-package/package.json version to match new beads release
  2. Ensure GitHub release has binary assets
  3. Run npm publish from npm-package directory
  4. Verify at npmjs.com/package/@beads/bd

Automation opportunity:

Create .github/workflows/publish-npm.yml to auto-publish on GitHub releases.

💡 Key Features

  • ✅ Zero-config installation - Just npm install
  • ✅ Automatic binary download - No manual steps
  • ✅ Platform detection - Works on macOS, Linux, Windows
  • ✅ Full feature parity - Native SQLite, all commands work
  • ✅ Claude Code ready - Perfect for SessionStart hooks
  • ✅ Dolt-backed - Issues version controlled
  • ✅ Multi-agent - Shared database via Dolt remotes

📈 Package Stats

Initial publish:

  • Tarball: beads-bd-0.21.5.tgz
  • Shasum: 6f3e7d808a67e975ca6781e340fa66777aa194b3
  • Integrity: sha512-8fAwa9JFKaczn...U3frQIXmrWnxQ==
  • Tag: latest
  • Access: public

🎊 Celebration

This completes bd-febc! The beads issue tracker is now available as an npm package, making it trivially easy to install in any Node.js environment, especially Claude Code for Web.

Time to completion: ~1 session Files created: 10+ Lines of code: ~500 Documentation: ~2000 lines

🙏 Thanks

Built with ❤️ for the AI coding agent community.


Note: After publishing, it may take a few minutes for the package to fully propagate through npm's CDN. If npm install doesn't work immediately, wait 5-10 minutes and try again.