Chock.sh Build your plugin

CLI reference

chock compile

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

Low-level single-policy compile

Syntax

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

chock compile [-h] [--targets [TARGETS ...]] [--agents [AGENTS ...]] [--repo REPO]
              [--policy-dir POLICY_DIR] [--output-root OUTPUT_ROOT]
              policy_id

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
policy_id (required)Policy directory name under .agents/policies/
--targets [TARGETS ...]['ambient-rule', 'git-hook', 'ci-gate', 'pre-tool-use', 'stop', 'managed-setting', 'gateway', 'mcp-gateway', 'agent-hooks']Surfaces to emit (default: all)
--agents [AGENTS ...]Agents to include in coverage report (comma- or space-separated; default: the repo's supported_agents, else all)
--repo REPO.Repo root
--policy-dir POLICY_DIRPath to policy directory (default: <repo>/.agents/policies/<policy_id>)
--output-root OUTPUT_ROOTCompiled output root (default: <repo>/.chock/compiled)

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 [-h] [--targets [TARGETS ...]] [--agents [AGENTS ...]] [--repo REPO]
             [--policy-dir POLICY_DIR] [--output-root OUTPUT_ROOT]
             policy_id

Compile a Chock policy into target-surface artifacts

positional arguments:
  policy_id             Policy directory name under .agents/policies/

options:
  -h, --help            show this help message and exit
  --targets [TARGETS ...]
                        Surfaces to emit (default: all)
  --agents [AGENTS ...]
                        Agents to include in coverage report (comma- or space-separated; default:
                        the repo's supported_agents, else all)
  --repo REPO           Repo root
  --policy-dir POLICY_DIR
                        Path to policy directory (default: <repo>/.agents/policies/<policy_id>)
  --output-root OUTPUT_ROOT
                        Compiled output root (default: <repo>/.chock/compiled)

Built from engine 5a4b6287a46e and catalog 1e60d211c1bb.