chock add

Syntax

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

chock add [-h] [--repo REPO] [--from SOURCE] [--ref REF] [--force] [--skip-compile]
          [--verify-sha SHA256]
          artifact_id

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.

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 add [-h] [--repo REPO] [--from SOURCE] [--ref REF] [--force] [--skip-compile]
                 [--verify-sha SHA256]
                 artifact_id

Install a policy or skill from a catalog and compile it

positional arguments:
  artifact_id          Policy or skill id, e.g. protect-main-branch

options:
  -h, --help           show this help message and exit
  --repo REPO          Target repo root
  --from SOURCE        Catalog URL or local path
  --ref REF            Full 40-hex commit SHA (recommended), or a branch/tag (mutable)
  --force              Replace an artifact that is already installed
  --skip-compile       Copy only; do not compile or install hooks
  --verify-sha SHA256  Refuse to install unless the fetched artifact hashes to this value