beads/examples/formulas
ecuthiell 80b13798dc
docs(lint): align contributor guidance with CI (saa-90w) (#5317)
Agent-Signature: codex-gpt-5-unknown-reasoning on behalf of Ewen Cuthiell
2026-08-07 05:37:12 -07:00
..
primitives feat(formula): make primitives discoverable to coding agents (GH#3621) (#3781) 2026-07-06 22:26:41 -07:00
feature-workflow.formula.toml feat: add starter formula examples (#3248) 2026-04-20 18:05:03 -07:00
gh-issue-to-pr.formula.toml docs(lint): align contributor guidance with CI (saa-90w) (#5317) 2026-08-07 05:37:12 -07:00
gh-pr-review.formula.toml docs(lint): align contributor guidance with CI (saa-90w) (#5317) 2026-08-07 05:37:12 -07:00
quick-check.formula.toml feat: add starter formula examples (#3248) 2026-04-20 18:05:03 -07:00
README.md docs: redirect legacy GitHub Pages site to Mintlify (#4759) 2026-07-13 14:19:13 -07:00
release.formula.toml feat: add starter formula examples (#3248) 2026-04-20 18:05:03 -07:00

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

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

Formula Description Use as
feature-workflow Design, implement, review, merge Molecule (persistent)
gh-issue-to-pr Triage a GitHub issue through implementation and PR creation Wisp (ephemeral)
gh-pr-review Triage and review a GitHub PR using maintainer guidelines Wisp (ephemeral)
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.