# `chock status`

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

Policy states and coverage (--only registry,log for more)

> Ask the user before running any command on this page: each one changes how their agent or repository behaves.

## Syntax

This is the usage line argparse builds from this command's parser. Ask the user before running the commands below:

```text
chock status [-h] [--repo REPO] [--only ONLY] [--summary] [--verify-log]
             [--head SEQ:SHA256] [--policy POLICY] [--since DAYS] [--json]
             [--by {policy,rule,agent,event}] [--format {text,md}] [--route {sync,plugin}]
             [--level {info,debug}] [--verdict {allow,block,ask,warn,off}]
             [--plugin PLUGIN] [--follow]
```

## 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. Help for each argument is in the table on this page's HTML version and in Help as printed, as the engine words it.

| Argument | Default |
| --- | --- |
| `--repo REPO` | `.` |
| `--only ONLY` |  |
| `--summary` |  |
| `--verify-log` |  |
| `--head SEQ:SHA256` |  |
| `--policy POLICY` |  |
| `--since DAYS` |  |
| `--json` |  |
| `--by` one of: policy, rule, agent, event |  |
| `--format` one of: text, md |  |
| `--route` one of: sync, plugin |  |
| `--level` one of: info, debug |  |
| `--verdict` one of: allow, block, ask, warn, off |  |
| `--plugin PLUGIN` |  |
| `--follow` |  |

## 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 8 of 21, exit code 0. Ask the user before running the commands below:

```text
$ chock status --repo .
id               state    coverage                                                                                                                                                                                                         mandatory
my-block-marker  enabled  claude: enforced-at-commit + best-effort at tool use (live-run); copilot: enforced-at-commit + best-effort at tool use (live-run-partial); gemini: enforced-at-commit + best-effort at tool use (vendor-source)  no
```

Step 19 of 21, exit code 0. Ask the user before running the commands below:

```text
$ chock status --repo .
STOPPED: every agent, by unknown at <time>: demo. Its tool calls, commits and pushes are refused; `chock resume` lifts it.
id               state    coverage                                                                                                                                                                                                         mandatory
my-block-marker  enabled  claude: enforced-at-commit + best-effort at tool use (live-run); copilot: enforced-at-commit + best-effort at tool use (live-run-partial); gemini: enforced-at-commit + best-effort at tool use (vendor-source)  no
```

## Help as printed

This is what `--help` prints, from the same parser. The usage line names the program as the engine's parser does. Ask the user before running the commands below:

```text
usage: chock status [-h] [--repo REPO] [--only ONLY] [--summary] [--verify-log]
                    [--head SEQ:SHA256] [--policy POLICY] [--since DAYS] [--json]
                    [--by {policy,rule,agent,event}] [--format {text,md}] [--route {sync,plugin}]
                    [--level {info,debug}] [--verdict {allow,block,ask,warn,off}]
                    [--plugin PLUGIN] [--follow]
```

The full options are on this page's HTML version, as the engine prints them.


---

Built from engine [5a4b6287a46e](https://github.com/open-coder-ai/chock/commit/5a4b6287a46e07f9f856d9bbe10622bd1ff2e021) and catalog [1e60d211c1bb](https://github.com/open-coder-ai/chock-catalog/commit/1e60d211c1bb767152c6ab0167932da06ab3a10f).