Chock.sh Build your plugin

CLI reference

chock bundle off

Ask the user before running chock bundle off: what it takes and prints, from the engine at the pinned commit.

Switch one policy off

Syntax

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

chock bundle off [-h] [--bundle BUNDLE] [--scope {repo,user}] policy_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.

ArgumentDefaultHelp
policy_id (required)
--bundle BUNDLEBundle.name; needed when the policy is in several bundles
--scope one of: repo, userDefault: repo inside one, else user

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 bundle off [-h] [--bundle BUNDLE] [--scope {repo,user}] policy_id

positional arguments:
  policy_id

options:
  -h, --help           show this help message and exit
  --bundle BUNDLE      bundle.name; needed when the policy is in several bundles
  --scope {repo,user}  default: repo inside one, else user

Built from engine 5a4b6287a46e and catalog 1e60d211c1bb.