velocirepo check

Run velocirepo’s checks and report their findings. Exits non-zero when there are errors that aren’t accepted in velocirepo/checks.toml. In a Git repository, the data is also compared with HEAD: a fetch only adds data, so removed records, changed values and removed content entries are reported. With --base and --head, two commits are compared instead, for example to check commits made by hand. Changes within a repair, given with --repair or a Velocirepo-Repair trailer, are warnings. With GITHUB_TOKEN set, stored totals are compared with GitHub’s own totals of issues, pull requests, forks and stars (--no-reconcile skips that).

velocirepo check [OPTIONS]

Full --help output

Run velocirepo's checks and report their findings. Exits non-zero when there are errors that aren't accepted in velocirepo/checks.toml.

In a Git repository, the data is also compared with HEAD: a fetch only adds data, so removed records, changed values and removed content entries are reported. With --base and --head, two commits are compared instead, for example to check commits made by hand. Changes within a repair, given with --repair or a Velocirepo-Repair trailer, are warnings.

With GITHUB_TOKEN set, stored totals are compared with GitHub's own totals of issues, pull requests, forks and stars (--no-reconcile skips that).

Usage:
  velocirepo check [flags]

Flags:
      --base string          compare the data with this commit (default: HEAD)
      --fetch-log string     check the runs in the fetch log of this day (YYYY-MM-DD)
      --head string          compare this commit with --base, instead of the work tree
  -h, --help                 help for check
      --json string          write the findings to this file (check.json)
      --no-reconcile         don't compare stored totals with the APIs' own totals
      --repair stringArray   changes within this repair are deliberate: <source>/<project> <from>..<to>
      --results string       a fetch run's results, from fetch --results
      --summary string       write a Markdown summary to this file

Global Flags:
      --config string   config file (default: walk up for velocirepo.toml)
  -q, --quiet           suppress progress output
  -v, --verbose         enable debug logging

Options

--base: string = HEAD: compare the data with this commit
--fetch-log: string: check the runs in the fetch log of this day (YYYY-MM-DD)
--head: string: compare this commit with --base, instead of the work tree
-h, --help: help for check
--json: string: write the findings to this file (check.json)
--no-reconcile: don’t compare stored totals with the APIs’ own totals
--repair: stringArray changes within this repair are deliberate: / ..
--results: string: a fetch run’s results, from fetch --results
--summary: string: write a Markdown summary to this file
--config: string = walk up for velocirepo.toml: config file
-q, --quiet: suppress progress output
-v, --verbose: enable debug logging