Quick Start

RelayCore is a high-performance Rust traffic interception engine. This guide will help you get up and running in under 5 minutes.

Installation

Choose your preferred installation method:

Cargo (Recommended)

cargo install relay-core-cli

npm

npm install -g @relay-core/cli

Pre-built Binaries

Download the latest release from GitHub Releases.

Generate CA Certificate

For HTTPS interception, you need a CA certificate:

relay-core-cli ca init

Then install it system-wide:

# macOS
sudo security add-trusted-cert ~/.relay-core/ca.crt

# Linux
sudo cp ~/.relay-core/ca.crt /usr/local/share/ca-certificates/
sudo update-ca-certificates

# Windows
# Import via certmgr.msc

Start the Proxy

# Basic usage
relay-core-cli run

# With TUI interface
relay-core-cli run --ui

# On specific port
relay-core-cli run --port 8080

The proxy will start on port 8080 by default. Open http://localhost:8080/ui for the web interface.

Configure Your Client

Point your HTTP client to RelayCore:

# curl
curl --proxy http://localhost:8080 https://example.com

# Environment variables
export HTTP_PROXY=http://localhost:8080
export HTTPS_PROXY=http://localhost:8080