Edge
Back to Academy
Getting Started 5 min read

CLI Installation

The Edge CLI is the fastest way to manage your infrastructure. Install it in seconds, authenticate, and start deploying.

Quick Install

The fastest way to install the Edge CLI is with our install script. It detects your operating system and architecture automatically.

# macOS and Linux
curl -fsSL https://edge.network/install.sh | sh
# Windows (PowerShell, run as Administrator)
iwr https://edge.network/install.ps1 -useb | iex

Verify it worked:

edge --version
edge version 1.x.x

Manual Install

If you prefer not to pipe to shell, download the binary directly for your platform.

macOS

# Apple Silicon (M1/M2/M3/M4)
curl -LO https://cli.edge.network/latest/edge-darwin-arm64
chmod +x edge-darwin-arm64
sudo mv edge-darwin-arm64 /usr/local/bin/edge
# Intel Macs
curl -LO https://cli.edge.network/latest/edge-darwin-amd64
chmod +x edge-darwin-amd64
sudo mv edge-darwin-amd64 /usr/local/bin/edge

Linux

# x86_64
curl -LO https://cli.edge.network/latest/edge-linux-amd64
chmod +x edge-linux-amd64
sudo mv edge-linux-amd64 /usr/local/bin/edge
# ARM64 (Raspberry Pi, AWS Graviton, etc.)
curl -LO https://cli.edge.network/latest/edge-linux-arm64
chmod +x edge-linux-arm64
sudo mv edge-linux-arm64 /usr/local/bin/edge

Windows

# PowerShell
Invoke-WebRequest -Uri "https://cli.edge.network/latest/edge-windows-amd64.exe" -OutFile "edge.exe"
# Move to a directory in your PATH, or add the directory to PATH
Move-Item edge.exe C:\Windows\System32\edge.exe

Authenticate

Once installed, log in with your API key. You can generate one in the control panel under API Keys.

# Interactive — prompts for your key
edge auth login
Enter your API key: ek_live_...
Authenticated as My Project (you@example.com)
# Non-interactive — pass the key directly (useful for CI/CD)
edge auth login --key ek_live_your_key_here
# Or via environment variable
export EDGE_API_KEY=ek_live_your_key_here

Check your authentication status at any time:

edge auth status
Status: Authenticated
Account: My Project
User: John Smith
Email: you@example.com
Plan: Startup

Try it out

Once authenticated, try a few commands to see what you've got:

# See your account overview
edge account
# List all your resources
edge compute list
edge cdn list
edge dns list
edge storage list
# Check your usage
edge account usage

Configuration

The CLI stores its configuration at ~/.edge/config.json. You can customise defaults to save typing:

# Set default output format to JSON
edge config set output json
# Set a default region for new resources
edge config set default_region london
# View all config
edge config list

Output formats

The CLI supports three output formats, controlled with the -o flag:

table

Human-readable tables (default). Best for interactive use.

json

JSON output. Best for scripting and piping to other tools like jq.

quiet

Minimal output — just IDs and essential values. Best for shell scripts.

Updating

The CLI checks for updates automatically and will let you know when a new version is available. To update, just run the install command again:

# Re-run the install script
curl -fsSL https://edge.network/install.sh | sh
# Or update from within the CLI
edge update

Next steps

First Deployment

Deploy your first resource

CLI Reference

Full command documentation