Skip to content
Academy
Getting started

3 min readbeginner

CLI installation

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

CoversPlatform

Quick install#

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

Terminal
curl -fsSL https://edge.network/install.sh | sh
PowerShell
# Run PowerShell as Administrator
iwr https://edge.network/install.ps1 -useb | iex

Verify it worked:

Terminal
edge --version
Text
edge version 1.x.x

Manual install#

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

Terminal
# 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
Terminal
# 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
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 console under API Keys.

Terminal
# Interactive: prompts for your key
edge auth login
Text
Enter your API key: ek_live_...
Authenticated as My Project (you@example.com)
Terminal
# 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:

Terminal
edge auth status
Text
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:

Terminal
# 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:

Terminal
# 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:

Terminal
# Re-run the install script
curl -fsSL https://edge.network/install.sh | sh

# Or update from within the CLI
edge update

Next steps

Keep learning