ChainPatrol CLI - ChainPatrol

The ChainPatrol CLI is a terminal interface to the same platform the dashboard and the External API expose. It is built for two audiences at once: an operator who wants a fast answer without opening the app, and a script or AI agent that needs machine-readable output and predictable exit codes.

npm install -g @chainpatrol/cli
chainpatrol login
chainpatrol asset check https://phish.example

What you can do with it

Check and search assets

Look up URLs and addresses against the blocklist, in bulk if you need to.

File and find reports

Create reports, browse an organization’s queue, and check for duplicates.

Clear your review queue

Approve, reject, or watchlist the proposals waiting on your organization.

Tune detections

Run configs on demand, validate that they still return results, and catch drift.

Pull metrics

Summary counts, breakdowns by day/type/brand, and multi-organization rollups.

Track takedowns

List takedown records with the same filters as the app’s Takedowns view.

Command index

Command	What it does
`login`	Authenticate with ChainPatrol via device-code flow
`logout`	Clear stored credentials from this machine
`whoami`	Show the current authenticated identity
`asset`	Check, search, or list assets, or list supported asset types
`reports`	Create, list, and search reports
`proposals`	Review proposals waiting on your organization
`detections`	Validate, run, list, and update detection configs and results
`configs`	Shorthand for `detections configs list`
`metrics`	Query organization metrics and breakdowns
`threats`	List confirmed threats blocked by ChainPatrol
`takedowns`	List individual takedown records
`orgs`	List organizations, org assets, and asset groups
`brands`	List brands
`healthchecks`	List and run organization healthchecks
`queues`	Snapshot review and takedown queues
`presets`	Run saved workflows for common jobs
`setup`	Install the Claude Code skill and shell completions
`uninstall`	Remove the Claude Code skill and shell completions
`completions`	Output a shell completion script

Built-in help

Every command documents itself. chainpatrol --help prints the command list, and --help on any command or subcommand prints its full option set:

chainpatrol --help
chainpatrol reports list --help
chainpatrol help proposals review

The help text ships with the binary, so it always matches the version you have installed. This documentation describes CLI 1.6.x.

Next steps

Installation

Install the CLI, point it at an environment, and enable shell completions.

Authentication

Output and exit codes

JSON, markdown, and CSV output, plus the exit codes scripts should branch on.

Using the CLI with agents

The Claude Code skill, --dry-run, --explain, and non-interactive mode.

Support

Report bugs and request features at github.com/chainpatrol/chainpatrol-cli/issues, or email support@chainpatrol.io.

​What you can do with it