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
Binary (Linux, macOS, Windows): download from GitHub Releases.
Homebrew (macOS):
brew install --cask escape-technologies/tap/escape-cli brew upgrade --cask escape-technologies/tap/escape-cli
On first run, macOS Gatekeeper may block the binary ("Apple could not verify 'escape-cli' is free of malware"). Strip the quarantine attribute:
xattr -d com.apple.quarantine "$(which escape-cli)"
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>
export ESCAPE_API_KEY=your_api_key_here# Start a scan and wait for results escape-cli scans start <profile-id> --watch # List emails received by a scan inbox escape-cli emails list --email [email protected] # Review discovered issues escape-cli issues list --severity CRITICAL,HIGH --status OPEN
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.
- name: Escape scan uses: Escape-Technologies/[email protected] 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).
scans Run and manage security scans
emails List and read scan inbox emails
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.