CLI reference
chock registry
Ask the user before running chock registry: what it takes and prints, from the engine at the pinned commit.
Scan/list/resolve the artifact registry
Syntax
This is the usage line argparse builds from this command's parser.
chock registry [-h] [--root ROOT] {init,scan,list,get,resolve} ...
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 (default: cwd) |
Subcommands
| Subcommand | Summary |
|---|---|
chock registry init | Create an empty registry |
chock registry scan | Scan repo and rebuild registry |
chock registry list | List registered artifacts |
chock registry get | Get registry metadata for an ID |
chock registry resolve | Resolve ID to manifest path |
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 [-h] [--root ROOT] {init,scan,list,get,resolve} ...
Chock local JSON registry
positional arguments:
{init,scan,list,get,resolve}
init Create an empty registry
scan Scan repo and rebuild registry
list List registered artifacts
get Get registry metadata for an ID
resolve Resolve ID to manifest path
options:
-h, --help show this help message and exit
--root ROOT, --repo ROOT
Repo root (default: cwd)
Built from engine 5a4b6287a46e and catalog 1e60d211c1bb.