Skip to main content

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.

With the 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

1

Install the CLI

Download a pre-built binary from GitHub Releases or build from source.
2

Get an API key

Sign in to the Plerion dashboard, navigate to Settings > API Keys, and create a new key.
3

Configure credentials

plerion configure
This creates ~/.plerion/credentials and ~/.plerion/config with your API key, region, and output preferences.
4

Run your first command

plerion tenant get
plerion findings list --severity CRITICAL --output table

Global options

These flags apply to every command:
FlagEnv varDescription
--profile <name>PLERION_PROFILEUse a named credentials profile
--region <region>PLERION_REGIONOverride region (au, sg1, in1, us1)
--api-key <key>PLERION_API_KEYOverride API key
--endpoint-url <url>PLERION_ENDPOINT_URLCustom API base URL
--output <format>Output format: table, json, yaml, text
--query <jmespath>JMESPath expression to filter output
--no-colorNO_COLORDisable color output

Commands

CommandDescription
configureInteractive setup wizard
tenantTenant details and usage
findingsSecurity findings
assetsAsset inventory
asset-groupsManage asset groups
alertsRisk-based alerts
audit-logsAudit logs
integrationsCloud integrations
risksSecurity risks
vulnerabilitiesVulnerabilities and exemptions
compliance-frameworksCompliance posture and reports
well-architected-frameworksWell-Architected assessments
iacInfrastructure as Code scanning
awsAWS integration helpers