Skip to main content

30-Second Quickstart

Goal: run one deterministic task and inspect cache behavior in less than a minute.

1) Create a minimal broskifile​

version = "0.5"

build:
    @in src/**/*.rs Cargo.toml Cargo.lock
    @out target/release
    cargo build --release

2) Run the task​

broski build

Expected outcome:

  • command executes successfully
  • outputs are written to target/release
  • execution metadata is recorded in .broski

3) Run again with explain​

broski run build --explain

Expected outcome:

  • second run reuses cache when inputs are unchanged
  • explain output shows cache hit or exact miss reason

4) Force a controlled miss​

echo "// touch" >> src/main.rs
broski run build --explain

Expected outcome:

  • explain reports input change
  • task reruns once, then returns to hit state on the next run

Next: