Chock.sh Build your plugin

CLI reference

chock check-matrix

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

Alias of: check --only matrix

Exit codes

  • This command reads its arguments itself, without argparse.
  • 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 17 of 21, exit code 1.

$ chock check-matrix
ERROR: enforcement matrix not found: /work/demo/spec/enforcement-matrix.md
       check-matrix is for work on Chock itself, not adopter repos.

Help as printed

This command reads its arguments itself, without argparse, so this is all the engine says about them: what it prints for --help.

usage: chock check --only matrix

Verify that every spec invariant ID appears in spec/enforcement-matrix.md, and that no matrix
row is missing its Check column. Takes no options; reads spec/ from the current directory.

For work on Chock itself. Anywhere without spec/enforcement-matrix.md it exits non-zero.

Built from engine 5a4b6287a46e and catalog 1e60d211c1bb.