Skip to main content

​
Installation

Surge is available on multiple platforms. Choose the method that works best for you.

​
System Requirements

Before installing Surge, ensure your system meets these requirements:
  • Operating System: Linux, macOS, or Windows
  • Go Version: 1.24.4+ (only if installing via go install)
  • Terminal: ANSI color support recommended for the best TUI experience

​
Installation Methods

​
Download Prebuilt Binary

The easiest method—just download and run.
1

Download the Latest Release

Visit the Surge Releases page and download the binary for your platform.
2

Extract the Archive

Extract the downloaded archive to a directory of your choice.
3

Make it Executable (Linux/macOS)

chmod +x surge
4

Move to PATH (Optional)

For easy access from anywhere:Linux/macOS:
sudo mv surge /usr/local/bin/
Windows: Add the surge directory to your PATH environment variable.
5

Verify Installation

surge --version

​
Post-Installation

​
Generate API Token

Surge uses a bearer token for API authentication. Generate or view your token: 
surge token
The token is automatically generated on first run and stored in ~/.local/state/surge/token (Linux) or equivalent on other platforms.

​
Configuration Directories

Surge uses the following directories:
  • State: ~/.local/state/surge/ (database, token)
  • Logs: ~/.local/state/surge/logs/
  • Settings: ~/.config/surge/settings.json

​
Next Steps

Quickstart Guide

Learn how to download your first file with Surge.

CLI Reference

Explore all available commands and options.