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, generate a CA first (default: ~/.relay-core/):

relay-core-cli ca generate

Check status:

relay-core-cli ca status

Install to the system trust store:

# macOS (recommended)
relay-core-cli ca install

# Linux (Debian/Ubuntu example)
sudo cp ~/.relay-core/ca_cert.pem /usr/local/share/ca-certificates/relay-core.crt
sudo update-ca-certificates

# Windows
# Import ~/.relay-core/ca_cert.pem via certmgr.msc

Start the Proxy

CA files must exist before run; otherwise the CLI exits with guidance to run ca generate.

# Basic usage
relay-core-cli run

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

# Custom listen address
relay-core-cli run --listen 127.0.0.1:9090

The proxy listens on 127.0.0.1:8080 by default. Use --ui for the interactive TUI, or --api-port 8082 to enable the REST API and SSE event stream.

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