快速开始

RelayCore 是一个高性能 Rust 流量拦截引擎。按照以下步骤，你可以在几分钟内启动并运行。

安装

选择适合你的安装方式：

Cargo（推荐）

cargo install relay-core-cli

npm

npm install -g @relay-core/cli

预构建二进制

从 GitHub Releases 下载最新版本。

下文命令是 relay-core。npm install -g @relay-core/cli 会安装这个命令；Cargo 装入的文件名是 relay-core-cli。

生成 CA 证书

要拦截 HTTPS 流量，需先生成 CA（默认写入 ~/.relay-core/）：

relay-core ca generate

查看状态：

relay-core ca status

安装到系统信任存储：

# macOS（推荐）
relay-core ca install

# Linux（Debian/Ubuntu 示例）
sudo cp ~/.relay-core/ca_cert.pem /usr/local/share/ca-certificates/relay-core.crt
sudo update-ca-certificates

# Windows
# 通过 certmgr.msc 导入 ~/.relay-core/ca_cert.pem

启动代理

一个后台守护进程独占引擎：它持有状态、服务控制 API / Web UI / MCP 端点，并且不随启动它的终端一起退出。代理默认监听 127.0.0.1:8080；relay-core status 会打印实际使用的端口，relay-core stop 只停代理、保留守护进程与历史。捕获历史默认最多保留 5000 条或 7 天（可用策略里的 retention 调整）。

CA 文件必须已存在；否则 run 会提示先执行 ca generate。

# 后台：守护进程 + 代理（幂等）
relay-core start

# 前台：同一守护进程，附带 TUI
relay-core run --ui

# 前台：同一守护进程，附带 Web UI（浏览器打开 status 打印的地址）
relay-core run --web

# 指定代理端口
relay-core start --listen 127.0.0.1:9090

代理默认监听 127.0.0.1:8080。控制 API 默认在 8082（被占则回落临时端口）。MCP 客户端（@relay-core/mcp）会附着到同一守护进程；未运行时也可自行拉起，再用 proxy_start 开代理。

配置客户端

将你的 HTTP 客户端指向 RelayCore：

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

# 环境变量
export HTTP_PROXY=http://localhost:8080
export HTTPS_PROXY=http://localhost:8080