Skip to main content

Examples

The repository ships runnable broskifile examples under examples/, in increasing order of complexity. Clone the repo and run any of them directly — they're real, working broskifiles, not snippets.

Start here​

ExampleWhat it shows
examples/minimalThe smallest possible graph-mode task: @in + @out, nothing else.
examples/basicA simple multi-step file pipeline (several tasks with dependencies).
examples/python-cliA normal test/build workflow with real cache reuse across runs.

Broader stack coverage​

ExampleWhat it shows
examples/go-httpBuilding and testing a Go service.
examples/node-webBuilding and testing a Node service.
examples/polyglotA single pipeline spanning multiple languages/toolchains.
examples/showcaseA heavier React + Rust + Docker demonstration — not the first onboarding stop, but useful once you've seen the basics.

Running an example​

Run every example's smoke task from the repository root in one shot:

broski --workspace . run examples_smoke --explain

Or point Broski directly at a single example's workspace:

cargo run -p broski-cli -- --workspace examples/python-cli run ci --explain

Once you have a release build installed, drop the cargo run -p broski-cli -- prefix:

broski --workspace examples/go-http run ci --explain

Suggested reading order​

  1. Skim examples/minimal/broskifile next to Your First Broskifile — it's the same shape, distilled to the minimum.
  2. Read examples/basic/broskifile alongside Annotations to see @in/@out/deps used together in a real multi-task pipeline.
  3. Read examples/python-cli/broskifile to see cache reuse in practice — run it twice with --explain and watch the second run hit cache.
  4. Once comfortable, examples/polyglot and examples/showcase demonstrate larger, more realistic graphs.