Escape CLI¶

The Escape CLI is a powerful command-line interface that enables you to automate security testing workflows and integrate Escape's capabilities directly into your development pipeline. Built as an open-source tool in Go, the CLI provides comprehensive access to the Escape platform through a clean, intuitive interface.

Overview¶

The Escape CLI serves as a direct wrapper around the Escape V3 API, allowing you to perform all security testing operations from your terminal or CI/CD environment. Whether you're managing assets, running scans, or handling security findings, the CLI provides the tools you need to embed security seamlessly into your workflow.

Philosophy¶

The Escape CLI is designed with three core principles:

Automation-First¶

Every command is built to support scripting and automation. The CLI offers machine-readable output formats (JSON, YAML) alongside human-readable tables, making it equally suitable for interactive use and automated workflows.

Pipeline Integration¶

Security testing should be part of your development process, not an afterthought. The Escape CLI enables you to trigger scans, monitor results, and fail builds based on security findings—all from within your existing CI/CD pipelines.

Developer Experience¶

Commands follow intuitive patterns with helpful aliases and clear documentation. Whether you're a security engineer or a developer new to security testing, the CLI provides a straightforward interface to Escape's capabilities.

Key Capabilities¶

Security Testing¶

• Start and monitor security scans for REST APIs, GraphQL APIs, and web applications
• Retrieve and analyze security findings in real-time
• Configure scan parameters and override settings programmatically

Asset Management¶

• Create and manage security test profiles for your applications
• Track and organize assets across your infrastructure
• Import assets in bulk from various sources

Private Location Support¶

The CLI enables you to deploy and manage Private Locations, allowing Escape to test applications within your private network while maintaining security and compliance requirements.

CI/CD Integration¶

• Seamless integration with GitHub Actions, GitLab CI, Jenkins, and other CI/CD platforms
• Exit codes and output formats designed for pipeline automation
• Support for commit metadata and build context

Use Cases¶

Continuous Security Testing¶

Integrate security scanning into every pull request or deployment, ensuring vulnerabilities are identified before they reach production.

Asset Discovery and Management¶

Maintain an up-to-date inventory of your APIs and web applications, with automated tracking of new services and endpoints.

Security Operations¶

Automate security workflows, from initial scanning to issue triage and remediation tracking.

Compliance and Reporting¶

Generate security reports and track compliance status across your application portfolio through automated queries.

Getting Started¶

1. Install the CLI on your system using your preferred method
2. Configure authentication with your Escape API key
3. Learn basic commands to navigate the CLI
4. Explore practical examples for common security testing workflows

Open Source¶

The Escape CLI is fully open source and available on GitHub. Contributions, issues, and feature requests are welcome.

Support¶

• Documentation: Browse the sections below for detailed command references and examples
• API Reference: Escape V3 API Documentation
• Community: GitHub Issues

Index¶