beads/examples/formulas/README.md
seanmartinsmith a54ab6f55d
feat: add starter formula examples (#3248)
Add 3 example .formula.toml files to examples/formulas/:
- feature-workflow: design, implement, review, merge
- release: bump version, test, tag, publish
- quick-check: lint, test, build (designed for wisp use)

These serve as documentation-by-example and give new users
a starting point for creating their own formulas.

Closes #3246
2026-04-20 18:05:03 -07:00

951 B

Starter Formulas

Example .formula.toml files you can use as starting points.

Usage

Copy formulas to your project or user-level directory:

# Project-level (available in this project only)
cp *.formula.toml /path/to/project/.beads/formulas/

# User-level (available in all projects)
cp *.formula.toml ~/.beads/formulas/

Then list and use them:

bd formula list        # See available formulas
bd mol pour release --var version=1.2.0   # Pour into a molecule

Included Formulas

Formula Description Use as
feature-workflow Design, implement, review, merge Molecule (persistent)
release Bump version, test, tag, publish Molecule (persistent)
quick-check Lint, test, build sanity check Wisp (ephemeral)

Creating Your Own

See the Formulas documentation for the full reference.