chock install-ci

Syntax

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

chock install-ci [-h] [--path PATH] [repo_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.

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] [--path PATH] [repo_root]

Install the Chock CI gate workflow

positional arguments:
  repo_root    Repository root (default: .)

options:
  -h, --help   show this help message and exit
  --path PATH  Workflow file to write, relative to repo_root