Esper CLI

What the Esper CLI does

The Esper CLI enables:

Workspace initialization and authentication
Builder resource creation and updates
Policy deployment and management
Results inspection
Hybrid runtime orchestration, including esper sync, esper capture, and esper run

Installation

# Install the latest Esper CLI
curl --proto '=https' --tlsv1.2 -fsSL https://sh.esperr.com/ | sh

# Install a specific version
curl --proto '=https' --tlsv1.2 -fsSL https://sh.esperr.com/ | sh -s -- --version 0.10.0

Use a specific version when you need a reproducible install or when pinning the CLI version for a deployment environment.

Getting started

Initialize the local workspace with an API key and tenant:

esper init \
  --api-base https://api.esperr.com \
  --api-key <secret> \
  --tenant-id <tenant-id>

The CLI stores the API key in ~/.esper/config.yaml and uses it for authenticated API calls. Operators who need to discover or rotate keys can use esper auth login --token <jwt> followed by esper keys list.

Learn more

Configuration - Local workspace and credential management
Authentication - Authorization workflows and token handling

Commands

The CLI provides comprehensive commands for managing Esper resources:

Actions - Define semantic traffic behaviors
Entities - Establish identity semantics
Mitigations - Configure response behaviors
Policies - Create and manage evaluation rules
Hybrid Runtime - Local capture and enforcement
Results - View analytics and metrics

Choosing a Deployment ModeIf you are deciding between Esper Cloud and customer-hosted hybrid runtime, read the Operation Modes section in the overview before choosing a deployment path.

Settings

Policies

Services

Integrations

CLI

What the Esper CLI does

Installation

Getting started

Learn more

Commands

​What the Esper CLI does

​Installation

​Getting started

​Learn more

​Commands

What the Esper CLI does

Installation

Getting started

Learn more

Commands