gh-velocity config validate#

Validate configuration and report errors

Synopsis#

Validate a .gh-velocity.yml file and report any errors.

Checks include: YAML syntax, known top-level keys, matcher syntax (label:, type:, title:, field: patterns), project URL format, numeric ranges (e.g., hotfix_window_hours), and category name requirements.

Use --velocity to additionally verify that velocity-specific config (effort strategy, iteration strategy, project field names) is correctly configured against your actual GitHub project board.

This command does not make API calls (except with --velocity, which queries the project board to validate field names).

gh-velocity config validate [flags]

Examples#

  gh velocity config validate
  gh velocity config validate --velocity

Options#

  -h, --help       help for validate
      --velocity   Live-test velocity matchers against recent issues

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 config - Inspect, validate, and generate configuration