Chock.sh Build your plugin

CLI reference

chock install-hooks

Ask the user before running chock install-hooks: what it takes and prints, from the engine at the pinned commit.

Alias of: sync (hooks part)

Syntax

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

chock install-hooks [-h] [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.

ArgumentDefaultHelp
repo_rootRepository root (default: current git top-level)

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

Install Chock git hooks

positional arguments:
  repo_root   Repository root (default: current git top-level)

options:
  -h, --help  show this help message and exit

Built from engine 5a4b6287a46e and catalog 1e60d211c1bb.