CLI reference
chock policies
Ask the user before running chock policies: what it takes and prints, from the engine at the pinned commit.
Alias of: status
Syntax
This is the usage line argparse builds from this command's parser.
chock policies [-h] [--repo REPO]
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.
| Argument | Default | Help |
|---|---|---|
--repo REPO | . | Repo root |
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. Each example below shows the code its run returned.
Examples
Real runs, recorded by python -m sitegen.cliexamples with the engine at the pinned commit. The steps of data/cli-examples.yaml ran in order, offline, in one fresh git repository at /work/demo (made with git init -b main), with HOME at /home/demo. Those paths stand for the throwaway folders the runs used, and <time> stands for a timestamp. Output is stdout and stderr together.
Step 9 of 21, exit code 0.
$ chock policies
id state coverage mandatory
my-block-marker enabled claude: enforced-at-commit + best-effort at tool use (live-run); copilot: enforced-at-commit + best-effort at tool use (live-run-partial); gemini: enforced-at-commit + best-effort at tool use (vendor-source) no
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 status [-h] [--repo REPO]
options:
-h, --help show this help message and exit
--repo REPO Repo root
Built from engine 5a4b6287a46e and catalog 1e60d211c1bb.