chock bundle status

Syntax

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

chock bundle status [-h] [--adopt] [--reset]

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. Each example below shows the code its run returned.

Examples

Real runs, recorded by python -m sitegen.cliexamples with the engine at the pinned commit. The steps of data/cli-examples.yaml ran in order, offline, in one fresh git repository at /work/demo (made with git init -b main), with HOME at /home/demo. Those paths stand for the throwaway folders the runs used, and <time> stands for a timestamp. Output is stdout and stderr together.

Step 15 of 21, exit code 0.

$ chock bundle status
Toggle file: none, so every member is on
No chock bundle is installed in any client's default folder.

chock-guardrails-protect is built into every bundle and always on.
Switch one in your own shell: chock bundle off|on <policy-id> [--bundle <name>] [--scope repo|user]

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 status [-h] [--adopt] [--reset]

options:
  -h, --help  show this help message and exit
  --adopt     record each toggle file in scope as it is, after showing it
  --reset     with --adopt: rewrite an invalid toggle file all on