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

# Plerion CLI

> A cross-platform command-line interface for the Plerion cloud security platform.

With the **[Plerion CLI](https://github.com/plerionhq/plerion-cli)**, you can access the Plerion cloud security platform from the command line. It follows the AWS CLI experience with INI-based profiles, multiple output formats, JMESPath filtering, and colored table output.

***

## Quick start

<Steps>
  <Step title="Install the CLI">
    Download a pre-built binary from [GitHub Releases](https://github.com/plerionhq/plerion-cli/releases) or [build from source](/cli-reference/installation#from-source).
  </Step>

  <Step title="Get an API key">
    Sign in to the [Plerion dashboard](https://app.plerion.com), navigate to **Settings > API Keys**, and create a new key.
  </Step>

  <Step title="Configure credentials">
    ```bash theme={"system"}
    plerion configure
    ```

    This creates `~/.plerion/credentials` and `~/.plerion/config` with your API key, region, and output preferences.
  </Step>

  <Step title="Run your first command">
    ```bash theme={"system"}
    plerion tenant get
    plerion findings list --severity CRITICAL --output table
    ```
  </Step>
</Steps>

***

## Global options

These flags apply to every command:

| Flag | Env var | Description |
| - | - | - |
| `--profile <name>` | `PLERION_PROFILE` | Use a named credentials profile |
| `--region <region>` | `PLERION_REGION` | Override region (`au`, `sg1`, `in1`, `us1`) |
| `--api-key <key>` | `PLERION_API_KEY` | Override API key |
| `--endpoint-url <url>` | `PLERION_ENDPOINT_URL` | Custom API base URL |
| `--output <format>` | — | Output format: `table`, `json`, `yaml`, `text` |
| `--query <jmespath>` | — | JMESPath expression to filter output |
| `--no-color` | `NO_COLOR` | Disable color output |

***

## Commands

| Command | Description |
| - | - |
| [`configure`](/cli-reference/commands/configure) | Interactive setup wizard |
| [`tenant`](/cli-reference/commands/tenant) | Tenant details and usage |
| [`findings`](/cli-reference/commands/findings) | Security findings |
| [`assets`](/cli-reference/commands/assets) | Asset inventory |
| [`asset-groups`](/cli-reference/commands/asset-groups) | Manage asset groups |
| [`alerts`](/cli-reference/commands/alerts) | Risk-based alerts |
| [`audit-logs`](/cli-reference/commands/audit-logs) | Audit logs |
| [`integrations`](/cli-reference/commands/integrations) | Cloud integrations |
| [`risks`](/cli-reference/commands/risks) | Security risks |
| [`vulnerabilities`](/cli-reference/commands/vulnerabilities) | Vulnerabilities and exemptions |
| [`compliance-frameworks`](/cli-reference/commands/compliance-frameworks) | Compliance posture and reports |
| [`well-architected-frameworks`](/cli-reference/commands/well-architected-frameworks) | Well-Architected assessments |
| [`iac`](/cli-reference/commands/iac) | Infrastructure as Code scanning |
| [`aws`](/cli-reference/commands/aws) | AWS integration helpers |


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