Chock.sh Build your plugin

CLI reference

chock review emit

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

Run the checks and write evidence

Syntax

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

chock review emit [-h] [--repo REPO] [--base BASE] [--checks [CHECKS ...]]
                  [--kind {agent,human}] [--by BY] [--out OUT] [--allow-empty]

Arguments and options

The table lists every argument the parser declares, except -h, --help, written as argparse prints it. Default is the value the parser uses when you leave the option out. It is empty for a flag or when the parser sets none.

ArgumentDefaultHelp
--repo REPO.Repo root
--base BASEorigin/mainBase ref to diff against (default: origin/main)
--checks [CHECKS ...]Registry keys to run (default: all built-ins)
--kind one of: agent, humanagent
--by BYunknownWho is producing this
--out OUTWrite here instead of .chock/evidence/
--allow-emptyRecord evidence even when the diff against --base is empty

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 emit [-h] [--repo REPO] [--base BASE] [--checks [CHECKS ...]]
                         [--kind {agent,human}] [--by BY] [--out OUT] [--allow-empty]

options:
  -h, --help            show this help message and exit
  --repo REPO           Repo root
  --base BASE           Base ref to diff against (default: origin/main)
  --checks [CHECKS ...]
                        Registry keys to run (default: all built-ins)
  --kind {agent,human}
  --by BY               Who is producing this
  --out OUT             Write here instead of .chock/evidence/
  --allow-empty         Record evidence even when the diff against --base is empty

Built from engine 5a4b6287a46e and catalog 1e60d211c1bb.