CLI reference
chock registry list
Ask the user before running chock registry list: what it takes and prints, from the engine at the pinned commit.
List registered artifacts
Syntax
This is the usage line argparse builds from this command's parser.
chock registry list [-h] [--type TYPE] [--root ROOT]
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 |
|---|---|---|
--type TYPE | Filter by artifact type | |
--root, --repo ROOT | 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 10 of 21, exit code 0.
$ chock registry list
hook my-block-marker 0.1.0 .agents/policies/my-block-marker
skill eval 0.0.1 .agents/skills/eval
skill optimize 0.0.1 .agents/skills/optimize
skill policy-init 0.0.1 .agents/skills/policy-init
skill validate 0.0.1 .agents/skills/validate
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 list [-h] [--type TYPE] [--root ROOT]
options:
-h, --help show this help message and exit
--type TYPE Filter by artifact type
--root ROOT, --repo ROOT
Repo root
Built from engine 5a4b6287a46e and catalog 1e60d211c1bb.