> ## Documentation Index
> Fetch the complete documentation index at: https://chainpatrol.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# ChainPatrol CLI

> Install and use the ChainPatrol CLI to check assets, file reports, review proposals, and query detection and takedown data from your terminal or a script.

The ChainPatrol CLI is a terminal interface to the same platform the dashboard and the
[External API](https://chainpatrol.com/docs/external-api/overview.md) 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.

```bash theme={null}
npm install -g @chainpatrol/cli
chainpatrol login
chainpatrol asset check https://phish.example
```

## What you can do with it

> [card] [Check and search assets](https://chainpatrol.com/docs/cli/commands/asset.md)
>
> Look up URLs and addresses against the blocklist, in bulk if you need to.

> [card] [File and find reports](https://chainpatrol.com/docs/cli/commands/reports.md)
>
> Create reports, browse an organization's queue, and check for duplicates.

> [card] [Clear your review queue](https://chainpatrol.com/docs/cli/commands/proposals.md)
>
> Approve, reject, or watchlist the proposals waiting on your organization.

> [card] [Tune detection](https://chainpatrol.com/docs/cli/commands/detections.md)
>
> Run configs on demand, validate that they still return results, and catch drift.

> [card] [Pull metrics](https://chainpatrol.com/docs/cli/commands/metrics.md)
>
> Summary counts, breakdowns by day/type/brand, and multi-organization rollups.

> [card] [Track takedowns](https://chainpatrol.com/docs/cli/commands/takedowns.md)
>
> List takedown records with the same filters as the app's Takedowns view.

## Command index

| Command | What it does |
| - | - |
| [`login`](https://chainpatrol.com/docs/cli/authentication) | Authenticate with ChainPatrol via device-code flow |
| [`logout`](https://chainpatrol.com/docs/cli/authentication) | Clear stored credentials from this machine |
| [`whoami`](https://chainpatrol.com/docs/cli/authentication) | Show the current authenticated identity |
| [`asset`](https://chainpatrol.com/docs/cli/commands/asset) | Check, search, or list assets, or list supported asset types |
| [`reports`](https://chainpatrol.com/docs/cli/commands/reports) | Create, list, and search reports |
| [`proposals`](https://chainpatrol.com/docs/cli/commands/proposals) | Review proposals waiting on your organization |
| [`detections`](https://chainpatrol.com/docs/cli/commands/detections) | Validate, run, and update detection configs, and list suspected threats |
| [`configs`](https://chainpatrol.com/docs/cli/commands/detections#configs-list) | Shorthand for `detections configs list` |
| [`metrics`](https://chainpatrol.com/docs/cli/commands/metrics) | Query organization metrics and breakdowns |
| [`threats`](https://chainpatrol.com/docs/cli/commands/threats) | List confirmed threats blocked by ChainPatrol |
| [`takedowns`](https://chainpatrol.com/docs/cli/commands/takedowns) | List individual takedown records |
| [`orgs`](https://chainpatrol.com/docs/cli/commands/orgs) | List organizations, org assets, and asset groups |
| [`brands`](https://chainpatrol.com/docs/cli/commands/orgs#brands-list) | List brands |
| [`healthchecks`](https://chainpatrol.com/docs/cli/commands/healthchecks) | List and run organization healthchecks |
| [`queues`](https://chainpatrol.com/docs/cli/commands/queues) | Snapshot review and takedown queues |
| [`presets`](https://chainpatrol.com/docs/cli/commands/presets) | Run saved workflows for common jobs |
| [`setup`](https://chainpatrol.com/docs/cli/agents) | Install the Claude Code skill and shell completions |
| [`uninstall`](https://chainpatrol.com/docs/cli/agents) | Remove the Claude Code skill and shell completions |
| [`completions`](https://chainpatrol.com/docs/cli/installation#shell-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:

```bash theme={null}
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

> [card] [Installation](https://chainpatrol.com/docs/cli/installation.md)
>
> Install the CLI, point it at an environment, and enable shell completions.

> [card] [Authentication](https://chainpatrol.com/docs/cli/authentication.md)
>
> Log in interactively, or use an API key for CI and headless runs.

> [card] [Output and exit codes](https://chainpatrol.com/docs/cli/output.md)
>
> JSON, markdown, and CSV output, plus the exit codes scripts should branch on.

> [card] [Using the CLI with agents](https://chainpatrol.com/docs/cli/agents.md)
>
> The Claude Code skill, `--dry-run`, `--explain`, and non-interactive mode.

## Support

Report bugs and request features at
[github.com/chainpatrol/chainpatrol-cli/issues](https://github.com/chainpatrol/chainpatrol-cli/issues),
or email [support@chainpatrol.io](mailto:support@chainpatrol.io).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.