Refresh generated CLI docs after rebasing PR #3609 onto current main, where formula search path help includes repo-local formulas. Refs GH#3609
114 lines
2.9 KiB
Markdown
114 lines
2.9 KiB
Markdown
---
|
|
id: formula
|
|
title: bd formula
|
|
slug: /cli-reference/formula
|
|
sidebar_position: 310
|
|
---
|
|
|
|
<!-- AUTO-GENERATED: do not edit manually -->
|
|
Generated from `bd help --doc formula`
|
|
|
|
## bd formula
|
|
|
|
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. <resolved-beads-dir>/formulas/ (active project)
|
|
2. <checkout-root>/.beads/formulas/ (repo-local formulas)
|
|
3. ~/.beads/formulas/ (user)
|
|
4. $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
|
|
|
|
```
|
|
bd formula
|
|
```
|
|
|
|
### bd formula convert
|
|
|
|
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
|
|
|
|
```
|
|
bd formula convert <formula-name|path> [--all] [flags]
|
|
```
|
|
|
|
**Flags:**
|
|
|
|
```
|
|
--all Convert all JSON formulas
|
|
--delete Delete JSON file after conversion
|
|
--stdout Print TOML to stdout instead of file
|
|
```
|
|
|
|
### bd formula list
|
|
|
|
List all formulas from search paths.
|
|
|
|
Search paths (in order of priority):
|
|
1. <resolved-beads-dir>/formulas/ (active project - highest priority)
|
|
2. <checkout-root>/.beads/formulas/ (repo-local formulas)
|
|
3. ~/.beads/formulas/ (user)
|
|
4. $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 convoy
|
|
|
|
```
|
|
bd formula list [flags]
|
|
```
|
|
|
|
**Flags:**
|
|
|
|
```
|
|
--type string Filter by type (workflow, expansion, aspect, convoy)
|
|
```
|
|
|
|
### bd formula show
|
|
|
|
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
|
|
|
|
```
|
|
bd formula show <formula-name>
|
|
```
|