Getting Started•Setup

Installation & Autostart

GoRoute distributes as a self-contained single executable. Choose your preferred package manager or use the universal one-line script.

1. Choose an Installation Method

Option A: npm / Bun (Recommended)Global CLI

Installs the verified pre-compiled native binary for Linux x86_64/arm64 or macOS Apple Silicon/Intel:

npm install -g goroute
Option B: Native One-Line Shell ScriptLinux & macOS

Detects your OS architecture, fetches the latest GitHub release, and installs to ~/.local/bin:

curl -fsSL https://raw.githubusercontent.com/ziuus/goroute/main/install.sh | bash
Option C: Homebrew TapmacOS
brew install ziuus/goroute/goroute
Option D: Go ToolchainFrom Source
go install github.com/ziuus/goroute/cmd/goroute@latest

2. Launch the Background Daemon

Run goroute serve in any terminal to start the proxy on port 8128:

# Start in foreground
goroute serve

# Or enable 24/7 background system autostart on boot (systemd / launchd)
goroute autostart enable

goroute autostart enable creates a persistent system user service (goroute.service on Linux systemd or dev.goroute.plist on macOS launchd) so the gateway remains running silently with < 5 MB memory consumption.

3. Verification

Confirm the gateway is healthy by checking the live health probe or accessing the dashboard:

curl -s http://127.0.0.1:8128/health

Expected output: {"status":"ok","version":"0.6.1","port":8128}