CLI reference
chock incident
Ask the user before running chock incident: what it takes and prints, from the engine at the pinned commit.
An ordered, redacted timeline from the local decision log (incident --since T [--until T] [--share])
Syntax
This is the usage line argparse builds from this command's parser.
chock incident [-h] --since SINCE [--until UNTIL] [--format {text,md,json}] [--share]
[--repo REPO] [--route {sync,plugin}]
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.
| Argument | Default | Help |
|---|---|---|
--since SINCE (required) | Start, included: ISO date/time (UTC if no zone) or 24h, 90m, 3d ago | |
--until UNTIL | End, not included (default: now) | |
--format one of: text, md, json | text | |
--share | Leave out approver and who (a person's git email) | |
--repo REPO | . | Repository root whose sync-route log is read (default: cwd) |
--route one of: sync, plugin |
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 incident [-h] --since SINCE [--until UNTIL] [--format {text,md,json}] [--share]
[--repo REPO] [--route {sync,plugin}]
`chock incident`: an ordered, redacted timeline from the local decision log, as evidence. Never
sends anything.
options:
-h, --help show this help message and exit
--since SINCE Start, included: ISO date/time (UTC if no zone) or 24h, 90m, 3d ago
--until UNTIL End, not included (default: now)
--format {text,md,json}
--share Leave out approver and who (a person's git email)
--repo REPO Repository root whose sync-route log is read (default: cwd)
--route {sync,plugin}
Built from engine 5a4b6287a46e and catalog 1e60d211c1bb.