This quickstart focuses on the current v0 working flow. It assumes you can already invoke punk. If not, start with Install.

What you will do

In the current public flow, you will:
  1. initialize a repository
  2. give SpecPunk a plain goal
  3. let go run the default happy path
  4. inspect status or fall back to the staged path when needed

Initialize a repository

In the repository you want to work on:
punk init --enable-jj --verify
If you are running directly from the SpecPunk source tree, prepend cargo run -p specpunk --:
cargo run -p specpunk -- init --enable-jj --verify
jj is preferred when available. git is the fallback.

Run the default happy path

Give SpecPunk a plain goal:
punk go --fallback-staged "add a bounded CLI feature with tests"
This is the default path:
goal -> draft -> approve -> cut -> gate -> proof
If autonomy blocks, SpecPunk prepares a staged recovery path instead of hiding the failure.

Inspect the result

After the run, the most useful follow-up commands are:
punk status
punk inspect work
Use JSON inspect when you want the underlying structured artifact view:
punk inspect <id> --json

Use the staged path when needed

Use the staged path when you want review between phases:
punk start "add a bounded CLI feature with tests"
punk plot approve <contract-id>
punk cut run <contract-id>
punk gate run <run-id>
punk gate proof <run-id|decision-id>

What is not in this quickstart

  • installation details
  • interactive shell
  • council-driven flows
  • examples gallery
  • research workflows
For the full current command surface, see CLI reference.