Chock.sh Build your plugin

CLI reference

chock stop

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

Refuse every agent tool call, commit and push here until resume (--agent C for one client)

Syntax

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

chock stop [-h] [--repo REPO]
           [--agent {antigravity,claude_code,codex_cli,cursor,devin,factory_droid,gemini_cli,goose,grok,mistral_vibe,openhands,tabnine,vscode_copilot,windsurf}]
           [--reason REASON] [--everywhere]

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
--repo REPO.Repo root (default: cwd)
--agent one of: antigravity, claude_code, codex_cli, cursor, devin, factory_droid, gemini_cli, goose, grok, mistral_vibe, openhands, tabnine, vscode_copilot, windsurfStop this one client only (default: every agent)
--reason REASONWhy: the agent is told stopped: <reason>
--everywhereStop every agent on this machine, in every repo

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 18 of 21, exit code 0.

$ chock stop --reason demo
STOPPED: every agent, by unknown at <time>: demo. Its tool calls, commits and pushes are refused; `chock resume` lifts it.
It refuses the NEXT action of an agent whose hooks Chock wires; it stops no running process and revokes no credential.

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 stop [-h] [--repo REPO]
                  [--agent {antigravity,claude_code,codex_cli,cursor,devin,factory_droid,gemini_cli,goose,grok,mistral_vibe,openhands,tabnine,vscode_copilot,windsurf}]
                  [--reason REASON] [--everywhere]

Write `.chock/stop.json`: every tool call, commit and push by an agent in scope is refused until
resume.

options:
  -h, --help            show this help message and exit
  --repo REPO           Repo root (default: cwd)
  --agent {antigravity,claude_code,codex_cli,cursor,devin,factory_droid,gemini_cli,goose,grok,mistral_vibe,openhands,tabnine,vscode_copilot,windsurf}
                        Stop this one client only (default: every agent)
  --reason REASON       Why: the agent is told `stopped: <reason>`
  --everywhere          Stop every agent on this machine, in every repo

Built from engine 5a4b6287a46e and catalog 1e60d211c1bb.