- Add MIT LICENSE file - Update version to 0.1.0 - Add mol-version-bump molecule for release workflow - Terse README for OSS release 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
553 lines
13 KiB
Go
553 lines
13 KiB
Go
// Package beads provides a wrapper for the bd (beads) CLI.
|
|
package beads
|
|
|
|
// BuiltinMolecule defines a built-in molecule template.
|
|
type BuiltinMolecule struct {
|
|
ID string // Well-known ID (e.g., "mol-engineer-in-box")
|
|
Title string
|
|
Description string
|
|
}
|
|
|
|
// BuiltinMolecules returns all built-in molecule definitions.
|
|
func BuiltinMolecules() []BuiltinMolecule {
|
|
return []BuiltinMolecule{
|
|
EngineerInBoxMolecule(),
|
|
QuickFixMolecule(),
|
|
ResearchMolecule(),
|
|
InstallGoBinaryMolecule(),
|
|
BootstrapGasTownMolecule(),
|
|
PolecatWorkMolecule(),
|
|
VersionBumpMolecule(),
|
|
}
|
|
}
|
|
|
|
// EngineerInBoxMolecule returns the engineer-in-box molecule definition.
|
|
// This is a full workflow from design to merge.
|
|
func EngineerInBoxMolecule() BuiltinMolecule {
|
|
return BuiltinMolecule{
|
|
ID: "mol-engineer-in-box",
|
|
Title: "Engineer in a Box",
|
|
Description: `Full workflow from design to merge.
|
|
|
|
## Step: design
|
|
Think carefully about architecture. Consider:
|
|
- Existing patterns in the codebase
|
|
- Trade-offs between approaches
|
|
- Testability and maintainability
|
|
|
|
Write a brief design summary before proceeding.
|
|
|
|
## Step: implement
|
|
Write the code. Follow codebase conventions.
|
|
Needs: design
|
|
|
|
## Step: review
|
|
Self-review the changes. Look for:
|
|
- Bugs and edge cases
|
|
- Style issues
|
|
- Missing error handling
|
|
Needs: implement
|
|
|
|
## Step: test
|
|
Write and run tests. Cover happy path and edge cases.
|
|
Fix any failures before proceeding.
|
|
Needs: implement
|
|
|
|
## Step: submit
|
|
Submit for merge via refinery.
|
|
Needs: review, test`,
|
|
}
|
|
}
|
|
|
|
// QuickFixMolecule returns the quick-fix molecule definition.
|
|
// This is a fast path for small changes.
|
|
func QuickFixMolecule() BuiltinMolecule {
|
|
return BuiltinMolecule{
|
|
ID: "mol-quick-fix",
|
|
Title: "Quick Fix",
|
|
Description: `Fast path for small changes.
|
|
|
|
## Step: implement
|
|
Make the fix. Keep it focused.
|
|
|
|
## Step: test
|
|
Run relevant tests. Fix any regressions.
|
|
Needs: implement
|
|
|
|
## Step: submit
|
|
Submit for merge.
|
|
Needs: test`,
|
|
}
|
|
}
|
|
|
|
// ResearchMolecule returns the research molecule definition.
|
|
// This is an investigation workflow.
|
|
func ResearchMolecule() BuiltinMolecule {
|
|
return BuiltinMolecule{
|
|
ID: "mol-research",
|
|
Title: "Research",
|
|
Description: `Investigation workflow.
|
|
|
|
## Step: investigate
|
|
Explore the question. Search code, read docs,
|
|
understand context. Take notes.
|
|
|
|
## Step: document
|
|
Write up findings. Include:
|
|
- What you learned
|
|
- Recommendations
|
|
- Open questions
|
|
Needs: investigate`,
|
|
}
|
|
}
|
|
|
|
// InstallGoBinaryMolecule returns the install-go-binary molecule definition.
|
|
// This is a single step to rebuild and install the gt binary after code changes.
|
|
func InstallGoBinaryMolecule() BuiltinMolecule {
|
|
return BuiltinMolecule{
|
|
ID: "mol-install-go-binary",
|
|
Title: "Install Go Binary",
|
|
Description: `Single step to rebuild and install the gt binary after code changes.
|
|
|
|
## Step: install
|
|
Build and install the gt binary locally.
|
|
|
|
Run from the rig directory:
|
|
` + "```" + `
|
|
go build -o gt ./cmd/gt
|
|
go install ./cmd/gt
|
|
` + "```" + `
|
|
|
|
Verify the installed binary is updated:
|
|
` + "```" + `
|
|
which gt
|
|
gt --version # if version command exists
|
|
` + "```",
|
|
}
|
|
}
|
|
|
|
// BootstrapGasTownMolecule returns the bootstrap molecule for new Gas Town installations.
|
|
// This walks a user through setting up Gas Town from scratch after brew install.
|
|
func BootstrapGasTownMolecule() BuiltinMolecule {
|
|
return BuiltinMolecule{
|
|
ID: "mol-bootstrap",
|
|
Title: "Bootstrap Gas Town",
|
|
Description: `Complete setup of a new Gas Town installation.
|
|
|
|
Run this after installing gt and bd via Homebrew. This molecule guides you through
|
|
creating an HQ, setting up rigs, and configuring your environment.
|
|
|
|
## Step: locate-hq
|
|
Determine where to install the Gas Town HQ.
|
|
|
|
Ask the user for their preferred location. Common choices:
|
|
- ~/gt (recommended - short, easy to type)
|
|
- ~/gastown
|
|
- ~/workspace/gt
|
|
|
|
Validate the path:
|
|
- Must not already exist (or be empty)
|
|
- Parent directory must be writable
|
|
- Avoid paths with spaces
|
|
|
|
Store the chosen path for subsequent steps.
|
|
|
|
## Step: create-hq
|
|
Create the HQ directory structure.
|
|
|
|
` + "```" + `bash
|
|
mkdir -p {{hq_path}}
|
|
cd {{hq_path}}
|
|
gt install . --name {{hq_name}}
|
|
` + "```" + `
|
|
|
|
If the user wants to track the HQ in git:
|
|
` + "```" + `bash
|
|
gt git-init --github={{github_repo}} --private
|
|
` + "```" + `
|
|
|
|
The HQ now has:
|
|
- mayor/ directory
|
|
- .beads/ for town-level tracking
|
|
- CLAUDE.md for mayor context
|
|
|
|
Needs: locate-hq
|
|
|
|
## Step: setup-rigs
|
|
Configure which rigs to add to the HQ.
|
|
|
|
Default rigs for Gas Town development:
|
|
- gastown (git@github.com:steveyegge/gastown.git)
|
|
- beads (git@github.com:steveyegge/beads.git)
|
|
|
|
For each rig, run:
|
|
` + "```" + `bash
|
|
gt rig add <name> <git-url> --prefix <prefix>
|
|
` + "```" + `
|
|
|
|
This creates the full rig structure:
|
|
- refinery/rig/ (canonical main clone)
|
|
- mayor/rig/ (mayor's working clone)
|
|
- crew/main/ (default human workspace)
|
|
- witness/ (polecat monitor)
|
|
- polecats/ (worker directory)
|
|
|
|
Needs: create-hq
|
|
|
|
## Step: build-gt
|
|
Build the gt binary from source.
|
|
|
|
` + "```" + `bash
|
|
cd {{hq_path}}/gastown/mayor/rig
|
|
go build -o gt ./cmd/gt
|
|
` + "```" + `
|
|
|
|
Verify the build succeeded:
|
|
` + "```" + `bash
|
|
./gt version
|
|
` + "```" + `
|
|
|
|
Needs: setup-rigs
|
|
Tier: haiku
|
|
|
|
## Step: install-paths
|
|
Install gt to a location in PATH.
|
|
|
|
Check if ~/bin or ~/.local/bin is in PATH:
|
|
` + "```" + `bash
|
|
echo $PATH | tr ':' '\n' | grep -E '(~/bin|~/.local/bin|/home/.*/bin)'
|
|
` + "```" + `
|
|
|
|
Copy the binary:
|
|
` + "```" + `bash
|
|
mkdir -p ~/bin
|
|
cp {{hq_path}}/gastown/mayor/rig/gt ~/bin/gt
|
|
` + "```" + `
|
|
|
|
If ~/bin is not in PATH, add to shell config:
|
|
` + "```" + `bash
|
|
echo 'export PATH="$HOME/bin:$PATH"' >> ~/.zshrc
|
|
# or ~/.bashrc for bash users
|
|
` + "```" + `
|
|
|
|
Verify:
|
|
` + "```" + `bash
|
|
which gt
|
|
gt version
|
|
` + "```" + `
|
|
|
|
Needs: build-gt
|
|
Tier: haiku
|
|
|
|
## Step: init-beads
|
|
Initialize beads databases in all clones.
|
|
|
|
For each rig's mayor clone:
|
|
` + "```" + `bash
|
|
cd {{hq_path}}/<rig>/mayor/rig
|
|
bd init --prefix <rig-prefix>
|
|
` + "```" + `
|
|
|
|
For the town-level beads:
|
|
` + "```" + `bash
|
|
cd {{hq_path}}
|
|
bd init --prefix hq
|
|
` + "```" + `
|
|
|
|
Configure sync-branch for multi-clone setups:
|
|
` + "```" + `bash
|
|
echo "sync-branch: beads-sync" >> .beads/config.yaml
|
|
` + "```" + `
|
|
|
|
Needs: setup-rigs
|
|
Tier: haiku
|
|
|
|
## Step: sync-beads
|
|
Sync beads from remotes and fix any issues.
|
|
|
|
For each initialized beads database:
|
|
` + "```" + `bash
|
|
bd sync
|
|
bd doctor --fix
|
|
` + "```" + `
|
|
|
|
This imports existing issues from JSONL and sets up git hooks.
|
|
|
|
Needs: init-beads
|
|
Tier: haiku
|
|
|
|
## Step: verify
|
|
Verify the installation is complete and working.
|
|
|
|
Run health checks:
|
|
` + "```" + `bash
|
|
gt status # Should show rigs with crew/refinery/mayor
|
|
gt doctor # Check for issues
|
|
bd list # Should show issues from synced beads
|
|
` + "```" + `
|
|
|
|
Test spawning capability (dry run):
|
|
` + "```" + `bash
|
|
gt spawn --help
|
|
` + "```" + `
|
|
|
|
Print summary:
|
|
- HQ location
|
|
- Installed rigs
|
|
- gt version
|
|
- bd version
|
|
|
|
Needs: sync-beads, install-paths`,
|
|
}
|
|
}
|
|
|
|
// PolecatWorkMolecule returns the polecat-work molecule definition.
|
|
// This is the full polecat lifecycle from assignment to decommission.
|
|
// It's an operational molecule that enables crash recovery and context survival.
|
|
func PolecatWorkMolecule() BuiltinMolecule {
|
|
return BuiltinMolecule{
|
|
ID: "mol-polecat-work",
|
|
Title: "Polecat Work",
|
|
Description: `Full polecat lifecycle from assignment to decommission.
|
|
|
|
This molecule enables nondeterministic idempotence for polecat work.
|
|
A polecat that crashes after any step can restart, read its molecule state,
|
|
and continue from the last completed step. No work is lost.
|
|
|
|
## Step: load-context
|
|
Run gt prime and bd prime. Verify issue assignment.
|
|
Check inbox for any relevant messages.
|
|
|
|
Read the assigned issue and understand the requirements.
|
|
Identify any blockers or missing information.
|
|
|
|
## Step: implement
|
|
Implement the solution. Follow codebase conventions.
|
|
File discovered work as new issues with bd create.
|
|
|
|
Make regular commits with clear messages.
|
|
Keep changes focused on the assigned issue.
|
|
Needs: load-context
|
|
|
|
## Step: self-review
|
|
Review your own changes. Look for:
|
|
- Bugs and edge cases
|
|
- Style issues
|
|
- Missing error handling
|
|
- Security concerns
|
|
|
|
Fix any issues found before proceeding.
|
|
Needs: implement
|
|
|
|
## Step: verify-tests
|
|
Run existing tests. Add new tests for new functionality.
|
|
Ensure adequate coverage.
|
|
|
|
` + "```" + `bash
|
|
go test ./...
|
|
` + "```" + `
|
|
|
|
Fix any test failures before proceeding.
|
|
Needs: implement
|
|
|
|
## Step: rebase-main
|
|
Rebase against main to incorporate any changes.
|
|
Resolve conflicts if needed.
|
|
|
|
` + "```" + `bash
|
|
git fetch origin main
|
|
git rebase origin/main
|
|
` + "```" + `
|
|
|
|
If there are conflicts, resolve them carefully and
|
|
continue the rebase.
|
|
Needs: self-review, verify-tests
|
|
|
|
## Step: submit-merge
|
|
Submit to merge queue. Create PR if needed.
|
|
Verify CI passes.
|
|
|
|
` + "```" + `bash
|
|
gt done # Signal work ready for merge queue
|
|
` + "```" + `
|
|
|
|
If there are CI failures, fix them before proceeding.
|
|
Needs: rebase-main
|
|
|
|
## Step: update-handoff
|
|
Update handoff bead with final state.
|
|
File any remaining work as issues.
|
|
|
|
Document any important context for the next session
|
|
or for anyone reviewing the work.
|
|
Needs: submit-merge
|
|
|
|
## Step: request-shutdown
|
|
Send shutdown request to Witness.
|
|
Wait for termination.
|
|
|
|
The polecat is now ready to be cleaned up.
|
|
Do not exit directly - wait for Witness to kill the session.
|
|
Needs: update-handoff`,
|
|
}
|
|
}
|
|
|
|
// VersionBumpMolecule returns the version-bump molecule definition.
|
|
// This is the release checklist for Gas Town versions.
|
|
func VersionBumpMolecule() BuiltinMolecule {
|
|
return BuiltinMolecule{
|
|
ID: "mol-version-bump",
|
|
Title: "Version Bump",
|
|
Description: `Release checklist for Gas Town version {{version}}.
|
|
|
|
This molecule ensures all release steps are completed properly.
|
|
Replace {{version}} with the target version (e.g., 0.1.0).
|
|
|
|
## Step: update-version
|
|
Update version string in internal/cmd/version.go.
|
|
|
|
Change the Version variable to the new version:
|
|
` + "```" + `go
|
|
var (
|
|
Version = "{{version}}"
|
|
BuildTime = "unknown"
|
|
GitCommit = "unknown"
|
|
)
|
|
` + "```" + `
|
|
|
|
## Step: rebuild-binary
|
|
Rebuild the gt binary with version info.
|
|
|
|
` + "```" + `bash
|
|
go build -ldflags="-X github.com/steveyegge/gastown/internal/cmd.Version={{version}} \
|
|
-X github.com/steveyegge/gastown/internal/cmd.GitCommit=$(git rev-parse --short HEAD) \
|
|
-X github.com/steveyegge/gastown/internal/cmd.BuildTime=$(date -u +%Y-%m-%dT%H:%M:%SZ)" \
|
|
-o gt ./cmd/gt
|
|
` + "```" + `
|
|
|
|
Verify the version:
|
|
` + "```" + `bash
|
|
./gt version
|
|
` + "```" + `
|
|
|
|
Needs: update-version
|
|
|
|
## Step: run-tests
|
|
Run the full test suite.
|
|
|
|
` + "```" + `bash
|
|
go test ./...
|
|
` + "```" + `
|
|
|
|
Fix any failures before proceeding.
|
|
Needs: rebuild-binary
|
|
|
|
## Step: update-changelog
|
|
Update CHANGELOG.md with release notes.
|
|
|
|
Add a new section at the top:
|
|
` + "```" + `markdown
|
|
## [{{version}}] - YYYY-MM-DD
|
|
|
|
### Added
|
|
- Feature descriptions
|
|
|
|
### Changed
|
|
- Change descriptions
|
|
|
|
### Fixed
|
|
- Bug fix descriptions
|
|
` + "```" + `
|
|
|
|
Needs: run-tests
|
|
|
|
## Step: commit-release
|
|
Commit the release changes.
|
|
|
|
` + "```" + `bash
|
|
git add -A
|
|
git commit -m "release: v{{version}}"
|
|
` + "```" + `
|
|
|
|
Needs: update-changelog
|
|
|
|
## Step: tag-release
|
|
Create and push the release tag.
|
|
|
|
` + "```" + `bash
|
|
git tag -a v{{version}} -m "Release v{{version}}"
|
|
git push origin main
|
|
git push origin v{{version}}
|
|
` + "```" + `
|
|
|
|
Needs: commit-release
|
|
|
|
## Step: verify-release
|
|
Verify the release is complete.
|
|
|
|
- Check that the tag exists on GitHub
|
|
- Verify CI/CD (if configured) completed successfully
|
|
- Test installation from the new tag:
|
|
` + "```" + `bash
|
|
go install github.com/steveyegge/gastown/cmd/gt@v{{version}}
|
|
gt version
|
|
` + "```" + `
|
|
|
|
Needs: tag-release
|
|
|
|
## Step: update-installations
|
|
Update local installations and restart daemons.
|
|
|
|
` + "```" + `bash
|
|
# Rebuild and install
|
|
go install ./cmd/gt
|
|
|
|
# Restart any running daemons
|
|
pkill -f "gt daemon" || true
|
|
gt daemon start
|
|
` + "```" + `
|
|
|
|
Needs: verify-release`,
|
|
}
|
|
}
|
|
|
|
// SeedBuiltinMolecules creates all built-in molecules in the beads database.
|
|
// It skips molecules that already exist (by title match).
|
|
// Returns the number of molecules created.
|
|
func (b *Beads) SeedBuiltinMolecules() (int, error) {
|
|
molecules := BuiltinMolecules()
|
|
created := 0
|
|
|
|
// Get existing molecules to avoid duplicates
|
|
existing, err := b.List(ListOptions{Type: "molecule", Priority: -1})
|
|
if err != nil {
|
|
return 0, err
|
|
}
|
|
|
|
// Build map of existing molecule titles
|
|
existingTitles := make(map[string]bool)
|
|
for _, issue := range existing {
|
|
existingTitles[issue.Title] = true
|
|
}
|
|
|
|
// Create each molecule if it doesn't exist
|
|
for _, mol := range molecules {
|
|
if existingTitles[mol.Title] {
|
|
continue // Already exists
|
|
}
|
|
|
|
_, err := b.Create(CreateOptions{
|
|
Title: mol.Title,
|
|
Type: "molecule",
|
|
Priority: 2, // Medium priority
|
|
Description: mol.Description,
|
|
})
|
|
if err != nil {
|
|
return created, err
|
|
}
|
|
created++
|
|
}
|
|
|
|
return created, nil
|
|
}
|