Back to Beads

Starter Formulas

examples/formulas/README.md

1.0.51.3 KB
Original Source

Starter Formulas

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

Usage

Copy formulas to your project or user-level directory:

bash
# 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:

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

For advanced GitHub workflows like gh-issue-to-pr and gh-pr-review, customize repo variables (repo, remotes, base branch) and quality-gate commands to match your project before first use.

Included Formulas

FormulaDescriptionUse as
feature-workflowDesign, implement, review, mergeMolecule (persistent)
gh-issue-to-prTriage a GitHub issue through implementation and PR creationWisp (ephemeral)
gh-pr-reviewTriage and review a GitHub PR using maintainer guidelinesWisp (ephemeral)
releaseBump version, test, tag, publishMolecule (persistent)
quick-checkLint, test, build sanity checkWisp (ephemeral)

Creating Your Own

See the Formulas documentation for the full reference.