Files
beads/cmd/bd/formula.go
Steve Yegge 5f3cb0fdf3 refactor: remove Gas Town references from codebase
Replace Gas Town-specific terminology with generic orchestrator concepts:
- "Gas Town" → "orchestrator" or "multi-clone"
- Hardcoded ~/gt/ paths → GT_ROOT environment variable
- signalGasTownActivity → signalOrchestratorActivity
- GUPP → hook-based work assignment

Updated 21 files across CHANGELOG, cmd/bd/, internal/, docs/, scripts.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

Executed-By: beads/crew/dave
Rig: beads
Role: crew
2025-12-30 14:13:32 -08:00

776 lines
20 KiB
Go

package main
import (
"bytes"
"encoding/json"
"fmt"
"os"
"path/filepath"
"sort"
"strings"
"github.com/BurntSushi/toml"
"github.com/spf13/cobra"
"github.com/steveyegge/beads/internal/formula"
"github.com/steveyegge/beads/internal/ui"
)
// formulaCmd is the parent command for formula operations.
var formulaCmd = &cobra.Command{
Use: "formula",
Short: "Manage workflow formulas",
Long: `Manage workflow formulas - the source layer for molecule templates.
Formulas are YAML/JSON files that define workflows with composition rules.
They are "cooked" into proto beads which can then be poured or wisped.
The Rig → Cook → Run lifecycle:
- Rig: Compose formulas (extends, compose)
- Cook: Transform to proto (bd cook expands macros, applies aspects)
- Run: Agents execute poured mols or wisps
Search paths (in order):
1. .beads/formulas/ (project)
2. ~/.beads/formulas/ (user)
3. $GT_ROOT/.beads/formulas/ (orchestrator, if GT_ROOT set)
Commands:
list List available formulas from all search paths
show Show formula details, steps, and composition rules`,
}
// formulaListCmd lists all available formulas.
var formulaListCmd = &cobra.Command{
Use: "list",
Short: "List available formulas",
Long: `List all formulas from search paths.
Search paths (in order of priority):
1. .beads/formulas/ (project - highest priority)
2. ~/.beads/formulas/ (user)
3. $GT_ROOT/.beads/formulas/ (orchestrator, if GT_ROOT set)
Formulas in earlier paths shadow those with the same name in later paths.
Examples:
bd formula list
bd formula list --json
bd formula list --type workflow
bd formula list --type aspect`,
Run: runFormulaList,
}
// formulaShowCmd shows details of a specific formula.
var formulaShowCmd = &cobra.Command{
Use: "show <formula-name>",
Short: "Show formula details",
Long: `Show detailed information about a formula.
Displays:
- Formula metadata (name, type, description)
- Variables with defaults and constraints
- Steps with dependencies
- Composition rules (extends, aspects, expansions)
- Bond points for external composition
Examples:
bd formula show shiny
bd formula show rule-of-five
bd formula show security-audit --json`,
Args: cobra.ExactArgs(1),
Run: runFormulaShow,
}
// FormulaListEntry represents a formula in the list output.
type FormulaListEntry struct {
Name string `json:"name"`
Type string `json:"type"`
Description string `json:"description"`
Source string `json:"source"`
Steps int `json:"steps"`
Vars int `json:"vars"`
}
func runFormulaList(cmd *cobra.Command, args []string) {
typeFilter, _ := cmd.Flags().GetString("type")
// Get all search paths
searchPaths := getFormulaSearchPaths()
// Track seen formulas (first occurrence wins)
seen := make(map[string]bool)
var entries []FormulaListEntry
// Scan each search path
for _, dir := range searchPaths {
formulas, err := scanFormulaDir(dir)
if err != nil {
continue // Skip inaccessible directories
}
for _, f := range formulas {
if seen[f.Formula] {
continue // Skip shadowed formulas
}
seen[f.Formula] = true
// Apply type filter
if typeFilter != "" && string(f.Type) != typeFilter {
continue
}
entries = append(entries, FormulaListEntry{
Name: f.Formula,
Type: string(f.Type),
Description: truncateDescription(f.Description, 60),
Source: f.Source,
Steps: countSteps(f.Steps),
Vars: len(f.Vars),
})
}
}
// Sort by name
sort.Slice(entries, func(i, j int) bool {
return entries[i].Name < entries[j].Name
})
if jsonOutput {
outputJSON(entries)
return
}
if len(entries) == 0 {
fmt.Println("No formulas found.")
fmt.Println("\nSearch paths:")
for _, p := range searchPaths {
fmt.Printf(" %s\n", p)
}
return
}
fmt.Printf("📜 Formulas (%d found)\n\n", len(entries))
// Group by type
byType := make(map[string][]FormulaListEntry)
for _, e := range entries {
byType[e.Type] = append(byType[e.Type], e)
}
// Print in type order: workflow, expansion, aspect
typeOrder := []string{"workflow", "expansion", "aspect"}
for _, t := range typeOrder {
typeEntries := byType[t]
if len(typeEntries) == 0 {
continue
}
typeIcon := getTypeIcon(t)
fmt.Printf("%s %s:\n", typeIcon, strings.Title(t))
for _, e := range typeEntries {
varInfo := ""
if e.Vars > 0 {
varInfo = fmt.Sprintf(" (%d vars)", e.Vars)
}
fmt.Printf(" %-25s %s%s\n", e.Name, e.Description, varInfo)
}
fmt.Println()
}
}
func runFormulaShow(cmd *cobra.Command, args []string) {
name := args[0]
// Create parser with default search paths
parser := formula.NewParser()
// Try to load the formula
f, err := parser.LoadByName(name)
if err != nil {
fmt.Fprintf(os.Stderr, "Error: %v\n", err)
fmt.Fprintf(os.Stderr, "\nSearch paths:\n")
for _, p := range getFormulaSearchPaths() {
fmt.Fprintf(os.Stderr, " %s\n", p)
}
os.Exit(1)
}
if jsonOutput {
outputJSON(f)
return
}
// Print header
typeIcon := getTypeIcon(string(f.Type))
fmt.Printf("\n%s %s\n", typeIcon, f.Formula)
fmt.Printf(" Type: %s\n", f.Type)
if f.Description != "" {
fmt.Printf(" Description: %s\n", f.Description)
}
fmt.Printf(" Source: %s\n", f.Source)
// Print extends
if len(f.Extends) > 0 {
fmt.Printf("\n%s Extends:\n", ui.RenderAccent("📎"))
for _, ext := range f.Extends {
fmt.Printf(" - %s\n", ext)
}
}
// Print variables
if len(f.Vars) > 0 {
fmt.Printf("\n%s Variables:\n", ui.RenderWarn("📝"))
// Sort for consistent output
varNames := make([]string, 0, len(f.Vars))
for name := range f.Vars {
varNames = append(varNames, name)
}
sort.Strings(varNames)
for _, name := range varNames {
v := f.Vars[name]
attrs := []string{}
if v.Required {
attrs = append(attrs, ui.RenderFail("required"))
}
if v.Default != "" {
attrs = append(attrs, fmt.Sprintf("default=%q", v.Default))
}
if len(v.Enum) > 0 {
attrs = append(attrs, fmt.Sprintf("enum=[%s]", strings.Join(v.Enum, ",")))
}
if v.Pattern != "" {
attrs = append(attrs, fmt.Sprintf("pattern=%q", v.Pattern))
}
attrStr := ""
if len(attrs) > 0 {
attrStr = fmt.Sprintf(" [%s]", strings.Join(attrs, ", "))
}
desc := ""
if v.Description != "" {
desc = fmt.Sprintf(": %s", v.Description)
}
fmt.Printf(" {{%s}}%s%s\n", name, desc, attrStr)
}
}
// Print steps
if len(f.Steps) > 0 {
fmt.Printf("\n%s Steps (%d):\n", ui.RenderPass("🌲"), countSteps(f.Steps))
printFormulaStepsTree(f.Steps, " ")
}
// Print template (for expansion formulas)
if len(f.Template) > 0 {
fmt.Printf("\n%s Template (%d steps):\n", ui.RenderAccent("📐"), len(f.Template))
printFormulaStepsTree(f.Template, " ")
}
// Print advice rules
if len(f.Advice) > 0 {
fmt.Printf("\n%s Advice:\n", ui.RenderWarn("💡"))
for _, a := range f.Advice {
parts := []string{}
if a.Before != nil {
parts = append(parts, fmt.Sprintf("before: %s", a.Before.ID))
}
if a.After != nil {
parts = append(parts, fmt.Sprintf("after: %s", a.After.ID))
}
if a.Around != nil {
parts = append(parts, "around")
}
fmt.Printf(" %s → %s\n", a.Target, strings.Join(parts, ", "))
}
}
// Print compose rules
if f.Compose != nil {
hasCompose := len(f.Compose.BondPoints) > 0 || len(f.Compose.Expand) > 0 ||
len(f.Compose.Map) > 0 || len(f.Compose.Aspects) > 0
if hasCompose {
fmt.Printf("\n%s Composition:\n", ui.RenderAccent("🔗"))
if len(f.Compose.BondPoints) > 0 {
fmt.Printf(" Bond Points:\n")
for _, bp := range f.Compose.BondPoints {
loc := ""
if bp.AfterStep != "" {
loc = fmt.Sprintf("after %s", bp.AfterStep)
} else if bp.BeforeStep != "" {
loc = fmt.Sprintf("before %s", bp.BeforeStep)
}
fmt.Printf(" - %s (%s)\n", bp.ID, loc)
}
}
if len(f.Compose.Expand) > 0 {
fmt.Printf(" Expansions:\n")
for _, e := range f.Compose.Expand {
fmt.Printf(" - %s → %s\n", e.Target, e.With)
}
}
if len(f.Compose.Map) > 0 {
fmt.Printf(" Maps:\n")
for _, m := range f.Compose.Map {
fmt.Printf(" - %s → %s\n", m.Select, m.With)
}
}
if len(f.Compose.Aspects) > 0 {
fmt.Printf(" Aspects: %s\n", strings.Join(f.Compose.Aspects, ", "))
}
}
}
// Print pointcuts (for aspects)
if len(f.Pointcuts) > 0 {
fmt.Printf("\n%s Pointcuts:\n", ui.RenderWarn("🎯"))
for _, p := range f.Pointcuts {
parts := []string{}
if p.Glob != "" {
parts = append(parts, fmt.Sprintf("glob=%q", p.Glob))
}
if p.Type != "" {
parts = append(parts, fmt.Sprintf("type=%q", p.Type))
}
if p.Label != "" {
parts = append(parts, fmt.Sprintf("label=%q", p.Label))
}
fmt.Printf(" - %s\n", strings.Join(parts, ", "))
}
}
fmt.Println()
}
// getFormulaSearchPaths returns the formula search paths in priority order.
func getFormulaSearchPaths() []string {
var paths []string
// Project-level formulas
if cwd, err := os.Getwd(); err == nil {
paths = append(paths, filepath.Join(cwd, ".beads", "formulas"))
}
// User-level formulas
if home, err := os.UserHomeDir(); err == nil {
paths = append(paths, filepath.Join(home, ".beads", "formulas"))
}
// Orchestrator formulas (via GT_ROOT)
if gtRoot := os.Getenv("GT_ROOT"); gtRoot != "" {
paths = append(paths, filepath.Join(gtRoot, ".beads", "formulas"))
}
return paths
}
// scanFormulaDir scans a directory for formula files (both TOML and JSON).
func scanFormulaDir(dir string) ([]*formula.Formula, error) {
entries, err := os.ReadDir(dir)
if err != nil {
return nil, err
}
parser := formula.NewParser(dir)
var formulas []*formula.Formula
for _, entry := range entries {
if entry.IsDir() {
continue
}
// Support both .formula.toml and .formula.json
name := entry.Name()
if !strings.HasSuffix(name, formula.FormulaExtTOML) && !strings.HasSuffix(name, formula.FormulaExtJSON) {
continue
}
path := filepath.Join(dir, name)
f, err := parser.ParseFile(path)
if err != nil {
continue // Skip invalid formulas
}
formulas = append(formulas, f)
}
return formulas, nil
}
// countSteps recursively counts steps including children.
func countSteps(steps []*formula.Step) int {
count := len(steps)
for _, s := range steps {
count += countSteps(s.Children)
}
return count
}
// truncateDescription truncates a description to maxLen characters.
func truncateDescription(desc string, maxLen int) string {
// Take first line only
if idx := strings.Index(desc, "\n"); idx >= 0 {
desc = desc[:idx]
}
if len(desc) > maxLen {
return desc[:maxLen-3] + "..."
}
return desc
}
// getTypeIcon returns an icon for the formula type.
func getTypeIcon(t string) string {
switch t {
case "workflow":
return "📋"
case "expansion":
return "📐"
case "aspect":
return "🎯"
default:
return "📜"
}
}
// printFormulaStepsTree prints steps in a tree format.
func printFormulaStepsTree(steps []*formula.Step, indent string) {
for i, step := range steps {
connector := "├──"
if i == len(steps)-1 {
connector = "└──"
}
// Collect dependency info
var depParts []string
if len(step.DependsOn) > 0 {
depParts = append(depParts, fmt.Sprintf("depends: %s", strings.Join(step.DependsOn, ", ")))
}
if len(step.Needs) > 0 {
depParts = append(depParts, fmt.Sprintf("needs: %s", strings.Join(step.Needs, ", ")))
}
if step.WaitsFor != "" {
depParts = append(depParts, fmt.Sprintf("waits_for: %s", step.WaitsFor))
}
depStr := ""
if len(depParts) > 0 {
depStr = fmt.Sprintf(" [%s]", strings.Join(depParts, ", "))
}
typeStr := ""
if step.Type != "" && step.Type != "task" {
typeStr = fmt.Sprintf(" (%s)", step.Type)
}
fmt.Printf("%s%s %s: %s%s%s\n", indent, connector, step.ID, step.Title, typeStr, depStr)
if len(step.Children) > 0 {
childIndent := indent
if i == len(steps)-1 {
childIndent += " "
} else {
childIndent += "│ "
}
printFormulaStepsTree(step.Children, childIndent)
}
}
}
// formulaConvertCmd converts JSON formulas to TOML.
var formulaConvertCmd = &cobra.Command{
Use: "convert <formula-name|path> [--all]",
Short: "Convert formula from JSON to TOML",
Long: `Convert formula files from JSON to TOML format.
TOML format provides better ergonomics:
- Multi-line strings without \n escaping
- Human-readable diffs
- Comments allowed
The convert command reads a .formula.json file and outputs .formula.toml.
The original JSON file is preserved (use --delete to remove it).
Examples:
bd formula convert shiny # Convert shiny.formula.json to .toml
bd formula convert ./my.formula.json # Convert specific file
bd formula convert --all # Convert all JSON formulas
bd formula convert shiny --delete # Convert and remove JSON file
bd formula convert shiny --stdout # Print TOML to stdout`,
Run: runFormulaConvert,
}
var (
convertAll bool
convertDelete bool
convertStdout bool
)
func runFormulaConvert(cmd *cobra.Command, args []string) {
if convertAll {
convertAllFormulas()
return
}
if len(args) == 0 {
fmt.Fprintf(os.Stderr, "Error: formula name or path required\n")
fmt.Fprintf(os.Stderr, "Usage: bd formula convert <name|path> [--all]\n")
os.Exit(1)
}
name := args[0]
// Determine the JSON file path
var jsonPath string
if strings.HasSuffix(name, formula.FormulaExtJSON) {
// Direct path provided
jsonPath = name
} else if strings.HasSuffix(name, formula.FormulaExtTOML) {
fmt.Fprintf(os.Stderr, "Error: %s is already a TOML file\n", name)
os.Exit(1)
} else {
// Search for the formula in search paths
jsonPath = findFormulaJSON(name)
if jsonPath == "" {
fmt.Fprintf(os.Stderr, "Error: JSON formula %q not found\n", name)
fmt.Fprintf(os.Stderr, "\nSearch paths:\n")
for _, p := range getFormulaSearchPaths() {
fmt.Fprintf(os.Stderr, " %s\n", p)
}
os.Exit(1)
}
}
// Parse the JSON file
parser := formula.NewParser()
f, err := parser.ParseFile(jsonPath)
if err != nil {
fmt.Fprintf(os.Stderr, "Error parsing %s: %v\n", jsonPath, err)
os.Exit(1)
}
// Convert to TOML
tomlData, err := formulaToTOML(f)
if err != nil {
fmt.Fprintf(os.Stderr, "Error converting to TOML: %v\n", err)
os.Exit(1)
}
if convertStdout {
fmt.Print(string(tomlData))
return
}
// Determine output path
tomlPath := strings.TrimSuffix(jsonPath, formula.FormulaExtJSON) + formula.FormulaExtTOML
// Write the TOML file
if err := os.WriteFile(tomlPath, tomlData, 0600); err != nil {
fmt.Fprintf(os.Stderr, "Error writing %s: %v\n", tomlPath, err)
os.Exit(1)
}
fmt.Printf("✓ Converted: %s\n", tomlPath)
if convertDelete {
if err := os.Remove(jsonPath); err != nil {
fmt.Fprintf(os.Stderr, "Warning: could not delete %s: %v\n", jsonPath, err)
} else {
fmt.Printf("✓ Deleted: %s\n", jsonPath)
}
}
}
func convertAllFormulas() {
converted := 0
errors := 0
for _, dir := range getFormulaSearchPaths() {
entries, err := os.ReadDir(dir)
if err != nil {
continue
}
parser := formula.NewParser(dir)
for _, entry := range entries {
if entry.IsDir() {
continue
}
if !strings.HasSuffix(entry.Name(), formula.FormulaExtJSON) {
continue
}
jsonPath := filepath.Join(dir, entry.Name())
tomlPath := strings.TrimSuffix(jsonPath, formula.FormulaExtJSON) + formula.FormulaExtTOML
// Skip if TOML already exists
if _, err := os.Stat(tomlPath); err == nil {
fmt.Printf("⏭ Skipped (TOML exists): %s\n", entry.Name())
continue
}
f, err := parser.ParseFile(jsonPath)
if err != nil {
fmt.Fprintf(os.Stderr, "✗ Error parsing %s: %v\n", jsonPath, err)
errors++
continue
}
tomlData, err := formulaToTOML(f)
if err != nil {
fmt.Fprintf(os.Stderr, "✗ Error converting %s: %v\n", jsonPath, err)
errors++
continue
}
if err := os.WriteFile(tomlPath, tomlData, 0600); err != nil {
fmt.Fprintf(os.Stderr, "✗ Error writing %s: %v\n", tomlPath, err)
errors++
continue
}
fmt.Printf("✓ Converted: %s\n", tomlPath)
converted++
if convertDelete {
if err := os.Remove(jsonPath); err != nil {
fmt.Fprintf(os.Stderr, "Warning: could not delete %s: %v\n", jsonPath, err)
}
}
}
}
fmt.Printf("\nConverted %d formulas", converted)
if errors > 0 {
fmt.Printf(" (%d errors)", errors)
}
fmt.Println()
}
// findFormulaJSON searches for a JSON formula file by name.
func findFormulaJSON(name string) string {
for _, dir := range getFormulaSearchPaths() {
path := filepath.Join(dir, name+formula.FormulaExtJSON)
if _, err := os.Stat(path); err == nil {
return path
}
}
return ""
}
// formulaToTOML converts a Formula to TOML bytes.
// Uses a custom structure optimized for TOML readability.
func formulaToTOML(f *formula.Formula) ([]byte, error) {
// We need to re-read the original JSON to get the raw structure
// because the Formula struct loses some ordering/formatting
if f.Source == "" {
return nil, fmt.Errorf("formula has no source path")
}
// Read the original JSON
jsonData, err := os.ReadFile(f.Source)
if err != nil {
return nil, fmt.Errorf("reading source: %w", err)
}
// Parse into a map to preserve structure
var raw map[string]interface{}
if err := json.Unmarshal(jsonData, &raw); err != nil {
return nil, fmt.Errorf("parsing JSON: %w", err)
}
// Fix float64 to int for known integer fields
fixIntegerFields(raw)
// Encode to TOML
var buf bytes.Buffer
encoder := toml.NewEncoder(&buf)
encoder.Indent = ""
if err := encoder.Encode(raw); err != nil {
return nil, fmt.Errorf("encoding TOML: %w", err)
}
// Post-process to convert escaped \n in strings to multi-line strings
result := convertToMultiLineStrings(buf.String())
return []byte(result), nil
}
// convertToMultiLineStrings post-processes TOML to use multi-line strings
// where strings contain newlines. This improves readability for descriptions.
func convertToMultiLineStrings(input string) string {
// Regular expression to match key = "value with \n"
// We look for description fields specifically as those benefit most
lines := strings.Split(input, "\n")
var result []string
for _, line := range lines {
// Check if this line has a string with escaped newlines
if strings.Contains(line, "\\n") {
// Find the key = "..." pattern
eqIdx := strings.Index(line, " = \"")
if eqIdx > 0 && strings.HasSuffix(line, "\"") {
key := strings.TrimSpace(line[:eqIdx])
// Only convert description fields
if key == "description" {
// Extract the value (without quotes)
value := line[eqIdx+4 : len(line)-1]
// Unescape the newlines
value = strings.ReplaceAll(value, "\\n", "\n")
// Use multi-line string syntax
result = append(result, fmt.Sprintf("%s = \"\"\"\n%s\"\"\"", key, value))
continue
}
}
}
result = append(result, line)
}
return strings.Join(result, "\n")
}
// fixIntegerFields recursively fixes float64 values that should be integers.
// JSON unmarshals all numbers as float64, but TOML needs proper int types.
func fixIntegerFields(m map[string]interface{}) {
// Known integer fields
intFields := map[string]bool{
"version": true,
"priority": true,
"count": true,
"max": true,
}
for k, v := range m {
switch val := v.(type) {
case float64:
// Convert whole numbers to int64 if they're known int fields
if intFields[k] && val == float64(int64(val)) {
m[k] = int64(val)
}
case map[string]interface{}:
fixIntegerFields(val)
case []interface{}:
for _, item := range val {
if subMap, ok := item.(map[string]interface{}); ok {
fixIntegerFields(subMap)
}
}
}
}
}
func init() {
formulaListCmd.Flags().String("type", "", "Filter by type (workflow, expansion, aspect)")
formulaConvertCmd.Flags().BoolVar(&convertAll, "all", false, "Convert all JSON formulas")
formulaConvertCmd.Flags().BoolVar(&convertDelete, "delete", false, "Delete JSON file after conversion")
formulaConvertCmd.Flags().BoolVar(&convertStdout, "stdout", false, "Print TOML to stdout instead of file")
formulaCmd.AddCommand(formulaListCmd)
formulaCmd.AddCommand(formulaShowCmd)
formulaCmd.AddCommand(formulaConvertCmd)
rootCmd.AddCommand(formulaCmd)
}