CLI reference
chock registry scan
Ask the user before running chock registry scan: what it takes and prints, from the engine at the pinned commit.
Scan repo and rebuild registry
Syntax
This is the usage line argparse builds from this command's parser.
chock registry scan [-h] [--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 |
|---|---|---|
--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, 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 scan [-h] [--root ROOT]
options:
-h, --help show this help message and exit
--root ROOT, --repo ROOT
Repo root
Built from engine 5a4b6287a46e and catalog 1e60d211c1bb.