RelayPlane Logo

CLI Reference

Complete reference for the relayplane-proxy command.

Basic Usage

1relayplane-proxy [command] [options]

Commands

(default)

Start the proxy server.

1relayplane-proxy
2relayplane-proxy --port 3002
3relayplane-proxy --host 0.0.0.0

stats

Show usage statistics and cost breakdown.

1relayplane-proxy stats

telemetry

Manage telemetry settings.

1relayplane-proxy telemetry status   # Check current setting
2relayplane-proxy telemetry on       # Enable telemetry
3relayplane-proxy telemetry off      # Disable telemetry

config

View or modify configuration.

1relayplane-proxy config             # Show current config
2relayplane-proxy config set-key YOUR_API_KEY  # Set API key

Options

OptionDefaultDescription
--port4801Port to listen on
--host127.0.0.1Host to bind to
--offlinefalseDisable all network calls except LLM endpoints
--auditfalseShow telemetry payloads before sending
-v, --verbosefalseEnable verbose logging
-h, --help-Show help message
--version-Show version number

Examples

1# Start on custom port
2relayplane-proxy --port 8080
3
4# Start with verbose logging
5relayplane-proxy -v
6
7# Start in offline mode (no telemetry)
8relayplane-proxy --offline
9
10# Audit telemetry before sending
11relayplane-proxy --audit
12
13# Bind to all interfaces (for Docker/remote access)
14relayplane-proxy --host 0.0.0.0

Configuration File

Configuration is stored in ~/.relayplane/config.json:

1{
2  "telemetry_enabled": true,
3  "api_key": "rp_...",
4  "device_id": "anon_abc123...",
5  "config_version": 1,
6  "created_at": "2026-01-15T10:30:00Z",
7  "updated_at": "2026-01-15T10:30:00Z"
8}