CLI Reference#
Commands are organized by the question they answer:
| Group | Question | Commands |
|---|---|---|
flow | How fast is work flowing? | lead-time, cycle-time, throughput, velocity |
quality | Is this release good? | release |
status | What's happening right now? | wip, my-week, reviews |
risk | Where are structural risks? | bus-factor |
report | Give me the full picture | Composite dashboard |
config | How do I set this up? | preflight, discover, validate, show, create |
Auto-generated from command definitions. Do not edit — these are regenerated by task build:site.
- config — Inspect, validate, and generate configuration
- config create — Create a default .gh-velocity.yml in the current directory
- config discover — Discover Projects v2 boards and fields linked to a repo
- config preflight — Analyze a repo and recommend a .gh-velocity.yml configuration
- config show — Display resolved configuration with defaults applied
- config validate — Validate configuration and report errors
- flow — Flow metrics (lead-time, cycle-time, velocity)
- flow cycle-time — Cycle time for an issue, PR, or bulk query
- flow lead-time — Lead time for an issue or bulk query (created → closed)
- flow throughput — Count issues closed and PRs merged in a window
- flow velocity — Measure effort completed per iteration (sprint velocity)
- gh velocity — GitHub velocity and quality metrics
- quality — Quality metrics for releases
- quality release — Release velocity and quality metrics
- report — Composite dashboard of velocity and quality metrics
- risk — Structural risk signals
- risk bus-factor — Knowledge risk per directory from git history
- status — Current work status (wip, my-week, reviews)
- status my-week — Your activity summary for 1:1 prep
- status reviews — Show PRs awaiting review
- status wip — Show work in progress
- version — Print version information