The current install story is intentionally simple: run SpecPunk from source with Cargo. This matches the current state of the project. A broader packaged install story can be added later.

​
Requirements

You need:
  • Rust toolchain
  • Cargo
  • Git
jj is preferred when available, but it is not required to start.

​
Clone the repository

git clone https://github.com/heurema/specpunk.git
cd specpunk

​
Run from source

Use Cargo to run the punk binary from the workspace: 
cargo run -p specpunk -- --help
You can also run commands this way: 
cargo run -p specpunk -- init --enable-jj --verify
cargo run -p specpunk -- go --fallback-staged "add a bounded CLI feature with tests"

​
Build a local binary

If you want a local compiled binary: 
cargo build --release -p specpunk
./target/release/punk --help

​
Next step

This page only covers how to get the current CLI running. For the first working flow after install, continue to Quickstart.