> ## 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](/docs/external-api/overview) 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

<CardGroup cols={2}>
  <Card title="Check and search assets" icon="shield-check" href="/docs/cli/commands/asset">
    Look up URLs and addresses against the blocklist, in bulk if you need to.
  </Card>

  <Card title="File and find reports" icon="flag" href="/docs/cli/commands/reports">
    Create reports, browse an organization's queue, and check for duplicates.
  </Card>

  <Card title="Clear your review queue" icon="gavel" href="/docs/cli/commands/proposals">
    Approve, reject, or watchlist the proposals waiting on your organization.
  </Card>

  <Card title="Tune detections" icon="radar" href="/docs/cli/commands/detections">
    Run configs on demand, validate that they still return results, and catch drift.
  </Card>

  <Card title="Pull metrics" icon="chart-line" href="/docs/cli/commands/metrics">
    Summary counts, breakdowns by day/type/brand, and multi-organization rollups.
  </Card>

  <Card title="Track takedowns" icon="list-check" href="/docs/cli/commands/takedowns">
    List takedown records with the same filters as the app's Takedowns view.
  </Card>
</CardGroup>

## Command index

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

<CardGroup cols={2}>
  <Card title="Installation" icon="download" href="/docs/cli/installation">
    Install the CLI, point it at an environment, and enable shell completions.
  </Card>

  <Card title="Authentication" icon="key" href="/docs/cli/authentication">
    Log in interactively, or use an API key for CI and headless runs.
  </Card>

  <Card title="Output and exit codes" icon="code" href="/docs/cli/output">
    JSON, markdown, and CSV output, plus the exit codes scripts should branch on.
  </Card>

  <Card title="Using the CLI with agents" icon="robot" href="/docs/cli/agents">
    The Claude Code skill, `--dry-run`, `--explain`, and non-interactive mode.
  </Card>
</CardGroup>

## 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).