tfmetrics scan

Parse repos into facts JSON

Synopsis

Parse one or more repos into facts files, one per repo. Each argument is a local directory, a git URL, or a GitHub owner/name (shallow-cloned with a sparse checkout). Nothing is fetched beyond the clone.

With --sink, the facts are also aggregated and emitted, which is how the per-repo PR check works: tfmetrics scan . --sink markdown

A repo that cannot be cloned or scanned is reported and skipped; the others are still written and emitted, and the command exits non-zero.

tfmetrics scan <path|repo>... [flags]

Examples

  tfmetrics scan .
  tfmetrics scan ./infra acme/tf-network --out facts/
  tfmetrics scan . --sink markdown

Options

      --concurrency int   repos to clone and scan at once (default 16)
  -h, --help              help for scan
      --out string        directory to write facts files to (default "facts")
      --ref string        branch, tag or commit to clone for remote repos (default: the default branch)
      --sink strings      also aggregate and emit to these sinks: json, openmetrics, otlp, csv, parquet, markdown, sarif

Options inherited from parent commands

      --config string   config file (default: the first tfmetrics.yaml or tfmetrics.yml in $XDG_CONFIG_HOME/tfmetrics, ~/.config/tfmetrics, $HOME, then the current directory)
      --plain           print plain lines: no colors, styling or live progress, as when output is not a terminal

SEE ALSO

• tfmetrics - Org-wide Terraform metrics from static parsing

Every key the config file accepts, and which flag or environment variable overrides it, is in the config file reference.