Chock.sh Build your plugin

CLI reference

chock bundle

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

Switch a member of an installed plugin bundle on or off (bundle on|off <id>, bundle status)

Syntax

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

chock bundle [-h] {on,off,status} ...

Arguments and options

This command takes no arguments besides -h, --help.

Subcommands

SubcommandSummary
chock bundle onSwitch one policy on
chock bundle offSwitch one policy off
chock bundle statusEvery installed bundle, each member's state and label

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 [-h] {on,off,status} ...

Switch a member of an installed bundle.

positional arguments:
  {on,off,status}
    on             switch one policy on
    off            switch one policy off
    status         every installed bundle, each member's state and label

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

Built from engine 5a4b6287a46e and catalog 1e60d211c1bb.