Installation¶

The Escape CLI is distributed as a standalone binary for all major operating systems. Choose the installation method that best fits your environment.

Prerequisites¶

Operating System: Linux, macOS, or Windows
Architecture: x64 or ARM64
Privileges: Administrative access may be required for system-wide installation

Quick Install¶

Linux and macOS¶

Install the Escape CLI using the automated installation script:

curl -sf https://raw.githubusercontent.com/Escape-Technologies/cli/refs/heads/main/scripts/install.sh | sudo bash

This script automatically:

Detects your operating system and architecture
Downloads the appropriate binary
Installs it to /usr/local/bin/escape-cli
Sets proper execution permissions

Verify the installation:

escape-cli version

Windows¶

Install using PowerShell with administrative privileges:

powershell -c "irm https://raw.githubusercontent.com/Escape-Technologies/cli/refs/heads/main/scripts/install.ps1 | iex"

Verify the installation:

escape-cli version

Docker Installation¶

The Escape CLI is available as a Docker image, ideal for containerized environments and CI/CD pipelines.

Pull the Image¶

docker pull escapetech/cli:latest

Run Commands¶

docker run -e ESCAPE_API_KEY="${ESCAPE_API_KEY}" -it --rm escapetech/cli:latest version

Use in Docker Compose¶

services:
  escape-cli:
    image: escapetech/cli:latest
    environment:
      - ESCAPE_API_KEY=${ESCAPE_API_KEY}
    volumes:
      - ./config:/config

Manual Installation¶

For environments requiring manual installation or specific version control:

Download Binary¶

Visit the GitHub Releases page
Download the binary for your platform:
- escape-cli-linux-amd64 - Linux x64
- escape-cli-linux-arm64 - Linux ARM64
- escape-cli-darwin-amd64 - macOS Intel
- escape-cli-darwin-arm64 - macOS Apple Silicon
- escape-cli-windows-amd64.exe - Windows x64

Install Binary¶

Linux/macOS:

# Download (replace VERSION and PLATFORM)
curl -L -o escape-cli https://github.com/Escape-Technologies/cli/releases/download/VERSION/escape-cli-PLATFORM

# Make executable
chmod +x escape-cli

# Move to PATH
sudo mv escape-cli /usr/local/bin/

Windows:

Download the .exe file
Move it to a directory in your PATH (e.g., C:\Program Files\Escape\)
Add the directory to your system PATH if needed

Version Management¶

Check Current Version¶

escape-cli version

Update to Latest Version¶

Re-run the installation script to update to the latest version:

Linux/macOS:

curl -sf https://raw.githubusercontent.com/Escape-Technologies/cli/refs/heads/main/scripts/install.sh | sudo bash

Windows:

powershell -c "irm https://raw.githubusercontent.com/Escape-Technologies/cli/refs/heads/main/scripts/install.ps1 | iex"

Platform-Specific Notes¶

macOS Security¶

On first run, macOS may prevent the CLI from executing due to Gatekeeper. To allow execution:

xattr -d com.apple.quarantine /usr/local/bin/escape-cli

Linux Distributions¶

The CLI is statically compiled and should work on all modern Linux distributions without additional dependencies.

Windows Execution Policy¶

If you encounter execution policy restrictions, run PowerShell as Administrator and execute:

Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser

Verify Installation¶

After installation, verify the CLI is working correctly:

# Check version
escape-cli version

# View help
escape-cli help

# Test connectivity (requires API key configuration)
escape-cli locations list

Troubleshooting¶

Command Not Found¶

If the escape-cli command is not found:

Ensure /usr/local/bin is in your PATH
Try running with the full path: /usr/local/bin/escape-cli
Verify the binary has execute permissions: ls -l /usr/local/bin/escape-cli

Permission Denied¶

If you see permission errors:

sudo chmod +x /usr/local/bin/escape-cli

Docker Connection Issues¶

Ensure the API key is properly passed to the container:

docker run -e ESCAPE_API_KEY="your-key-here" -it --rm escapetech/cli:latest version

Next Steps¶

Once installed, proceed to Configuration to set up authentication with the Escape platform.