Chock.sh Build your plugin

CLI reference

chock review

Ask the user before running chock review: what it takes and prints, from the engine at the pinned commit.

Produce or check reviewer evidence (review emit | review verify <file> | review require)

Syntax

This is the usage line argparse builds from this command's parser.

chock review [-h] {emit,verify,require} ...

Arguments and options

This command takes no arguments besides -h, --help.

Subcommands

SubcommandSummary
chock review emitRun the checks and write evidence
chock review verifyRe-derive every verified claim
chock review requireCI gate: is this PR merge-ready?

Exit codes

  • 2: argparse rejected the arguments, for example an option this command does not have. The site's tests run every command with an unknown option and check that it exits 2.
  • Chock documents no other exit codes, and this page has no recorded run.

Help as printed

This is what --help prints, from the same parser. The usage line names the program as the engine's parser does.

usage: chock review [-h] {emit,verify,require} ...

Produce and check reviewer evidence

positional arguments:
  {emit,verify,require}
    emit                Run the checks and write evidence
    verify              Re-derive every verified claim
    require             CI gate: is this PR merge-ready?

options:
  -h, --help            show this help message and exit

Built from engine 5a4b6287a46e and catalog 1e60d211c1bb.