Chock.sh Build your plugin

CLI reference

chock witness export

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

Write one client's redacted log records to a local file; never uploads

Syntax

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

chock witness export [-h] --client CLIENT [--since DAYS] [--out OUT] [--repo REPO]

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
--client CLIENT (required)The client: an agentseam id, or a chock install/sync name
--since DAYSOnly records from the last N days
--out OUTA new .json file to write; an existing file is refused (default: ./chock-witness-<client>-<date>.json)
--repo REPO.Repository root whose sync-route log is read (default: cwd)

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 witness export [-h] --client CLIENT [--since DAYS] [--out OUT] [--repo REPO]

options:
  -h, --help       show this help message and exit
  --client CLIENT  The client: an agentseam id, or a chock install/sync name
  --since DAYS     Only records from the last N days
  --out OUT        A new .json file to write; an existing file is refused (default: ./chock-
                   witness-<client>-<date>.json)
  --repo REPO      Repository root whose sync-route log is read (default: cwd)

Built from engine 5a4b6287a46e and catalog 1e60d211c1bb.