cli

Escape CLI

The official CLI for Escape — an AI-powered offensive security platform for APIs and web applications.

Two main use cases:

• Security scanning — trigger scans, manage vulnerabilities, and integrate Escape into CI/CD pipelines
• Private Location — run a self-hosted tunnel to reach APIs inside private networks

Full documentation: docs.escape.tech/documentation/tooling/cli

Installation

Binary (Linux, macOS, Windows): download from GitHub Releases.

Docker:

docker pull escapetech/cli:latest

Helm (for Private Location on Kubernetes):

helm install escape-location ./helm \
  --set ESCAPE_API_KEY=<your-api-key> \
  --set ESCAPE_PRIVATE_LOCATION=<location-name>

Authentication

export ESCAPE_API_KEY=your_api_key_here

Quick Start

# Start a scan and wait for results
escape-cli scans start <profile-id> --watch

# Review discovered issues
escape-cli issues list --severity CRITICAL,HIGH --status OPEN

Private Location

Private Location is a self-hosted tunnel that lets Escape reach APIs that are not publicly accessible — behind firewalls, in private VPCs, or in Kubernetes clusters.

# Start a Private Location
escape-cli locations start <location-name>

For Kubernetes, use the provided Helm chart. See helm/values.yaml for configuration options including existing secrets and K8s integration.

GitHub Actions

- name: Escape scan
  uses: Escape-Technologies/cli@v1
  with:
    profile_id: ${{ secrets.ESCAPE_PROFILE_ID }}
    api_key: ${{ secrets.ESCAPE_API_KEY }}
    watch: 'true'

Optional inputs: schema (path or URL to update the API schema before the scan), configuration_override (partial JSON config).

Commands

scans       Run and manage security scans
issues      Manage and track security vulnerabilities
problems    View scan problems and failures
profiles    Configure security testing profiles
assets      Manage your API inventory
locations   Manage Private Locations
custom-rules Manage custom security rules
tags        Organize resources with tags
upload      Upload schema files (OpenAPI, GraphQL, Postman)
audit       View audit logs
version     Display CLI version

Global flags: -o pretty|json|yaml|schema, -v/-vv/-vvv, and --input-schema.