Chock.sh Build your plugin

CLI reference

chock install

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

Build a chock.sh selection into one plugin for one agent (install --selection <file> [--client C])

Syntax

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

chock install [-h] --selection SELECTION
              [--client {claude-code,copilot,codex,cursor,devin,goose,grok,antigravity,openhands,kimi-code,factory-droid}]
              [--dest DEST] [--marketplace-name NAME] [--apply] [--allow-source SOURCE]
              [--trust-local ID=SHA256]

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
--selection SELECTION (required)Chock.selection.yaml, a URL with #s=..., or the bare code
--client one of: claude-code, copilot, codex, cursor, devin, goose, grok, antigravity, openhands, kimi-code, factory-droid, gemini-cliThe agent to build for (default: the selection's client)
--dest DESTInstall folder (default: the client's own, e.g. ~/.chock/marketplace/<client>)
--marketplace-name NAMEName the build's local marketplace (default: chock-local), so a team's own build can use its own
--applyAlso run the client's own install commands, if any
--allow-source SOURCE[]Also trust this exact catalog source (the selection itself can never widen trust)
--trust-local ID=SHA256[]Accept this local policy at exactly this hash without asking (for scripts, after reading its code)

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 install [-h] --selection SELECTION
                     [--client {claude-code,copilot,codex,cursor,devin,goose,grok,antigravity,openhands,kimi-code,factory-droid}]
                     [--dest DEST] [--marketplace-name NAME] [--apply] [--allow-source SOURCE]
                     [--trust-local ID=SHA256]

Build a chock selection into one plugin for one agent

options:
  -h, --help            show this help message and exit
  --selection SELECTION
                        chock.selection.yaml, a URL with #s=..., or the bare code
  --client {claude-code,copilot,codex,cursor,devin,goose,grok,antigravity,openhands,kimi-code,factory-droid}
                        The agent to build for (default: the selection's client)
  --dest DEST           Install folder (default: the client's own, e.g.
                        ~/.chock/marketplace/<client>)
  --marketplace-name NAME
                        Name the build's local marketplace (default: chock-local), so a team's own
                        build can use its own
  --apply               Also run the client's own install commands, if any
  --allow-source SOURCE
                        Also trust this exact catalog source (the selection itself can never widen
                        trust)
  --trust-local ID=SHA256
                        Accept this local policy at exactly this hash without asking (for scripts,
                        after reading its code)

Built from engine 5a4b6287a46e and catalog 1e60d211c1bb.