Chock.sh Build your plugin

CLI reference

chock validate

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

Alias of: check --only validate

Syntax

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

chock validate [-h]
               [--mode {agnostic,frontier-agentskills,frontier-claude,frontier-openai,frontier-devin,frontier-cursor,frontier-copilot,frontier-codex}]
               [--json] [--include INCLUDE] [--exclude EXCLUDE] [--no-registry-check]
               [--event {commit}]
               [path]

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
path.Root path to validate
--mode one of: agnostic, frontier-agentskills, frontier-claude, frontier-openai, frontier-devin, frontier-cursor, frontier-copilot, frontier-codexagnostic
--jsonEmit JSON report
--include INCLUDE[]Limit to artifact type (repeatable)
--exclude EXCLUDE[]Skip artifact directories whose path contains this substring (repeatable)
--no-registry-checkDisable registry freshness check
--event one of: commitContext this run happens in. 'commit' scopes drift severity to the staged diff.

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 3 of 21, exit code 0.

$ chock validate
[PASS] All checks passed.

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 [-h]
             [--mode {agnostic,frontier-agentskills,frontier-claude,frontier-openai,frontier-devin,frontier-cursor,frontier-copilot,frontier-codex}]
             [--json] [--include INCLUDE] [--exclude EXCLUDE] [--no-registry-check]
             [--event {commit}]
             [path]

Chock deterministic artifact validator

positional arguments:
  path                  Root path to validate

options:
  -h, --help            show this help message and exit
  --mode {agnostic,frontier-agentskills,frontier-claude,frontier-openai,frontier-devin,frontier-cursor,frontier-copilot,frontier-codex}
  --json                Emit JSON report
  --include INCLUDE     Limit to artifact type (repeatable)
  --exclude EXCLUDE     Skip artifact directories whose path contains this substring (repeatable)
  --no-registry-check   Disable registry freshness check
  --event {commit}      Context this run happens in. 'commit' scopes drift severity to the staged
                        diff.

Built from engine 5a4b6287a46e and catalog 1e60d211c1bb.