website/versioned_docs/version-1.0.0/cli-reference/formula.md
Generated from bd help --doc 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:
Search paths (in order):
Commands: list List available formulas from all search paths show Show formula details, steps, and composition rules
bd formula
Convert formula files from JSON to TOML format.
TOML format provides better ergonomics:
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
List all formulas from search paths.
Search paths (in order of priority):
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)
Show detailed information about a formula.
Displays:
Examples: bd formula show shiny bd formula show rule-of-five bd formula show security-audit --json
bd formula show <formula-name>