gh-velocity report#

Composite dashboard of velocity and quality metrics

Synopsis#

Show a trailing-window report composing lead time, cycle time, throughput, work in progress, and quality metrics.

Default window is the last 30 days. Use --since and --until to customize.

Each section computes independently; a failure in one section does not block others. Sections that require specific config (WIP needs project.id or active_labels; quality needs releases) are gracefully omitted when unavailable.

gh-velocity report [flags]

Examples#

  # Default: last 30 days
  gh velocity report

  # Custom window
  gh velocity report --since 14d --until 2026-03-01

  # Remote repo, JSON for CI dashboards
  gh velocity report --since 30d -R cli/cli -r json

  # Write all formats to a directory (single data-gathering pass)
  gh velocity report --since 30d --results md,json --write-to ./out

Options#

  -h, --help           help for report
      --since string   Start of date window (default: 30d)
      --summary-only   Show only the summary dashboard table, omit per-item detail sections
      --until string   End of date window (default: now)

Options inherited from parent commands#

      --config string     Path to config file (default: .gh-velocity.yml)
      --debug             Print diagnostic info to stderr
      --new-post          Force a new post (skip idempotent update; implies --post)
      --no-cache          Disable disk cache (in-memory deduplication still active)
      --post              Post output to GitHub (dry-run by default; set GH_VELOCITY_POST_LIVE=true for live)
  -R, --repo string       Repository in owner/name format
  -r, --results strings   Output format(s): json, pretty, markdown, html (comma-separated) (default [pretty])
      --scope string      Additional GitHub search qualifier(s) ANDed with config scope
      --title string      Override discussion title (with --post)
      --write-to string   Write result files to this directory (silences stdout)

SEE ALSO#

• gh-velocity - GitHub velocity and quality metrics