openrelayai

CLI tool to connect your local services to the cloud via OpenRelay.

Quick Start

# Connect directly with your API key (recommended)
npx @openrelayai/connector --api-key YOUR_API_KEY

# Or pair using a code from the OpenRelay dashboard
npx @openrelayai/connector --code ABC12345

# Specify a custom local port
npx @openrelayai/connector --api-key YOUR_API_KEY --port 8080

# Start with saved config
npx @openrelayai/connector --start

# Check status
npx @openrelayai/connector --status

How It Works

1. Get your API key from the OpenRelay dashboard (or generate a pairing code)
2. Run the connector with npx @openrelayai/connector --api-key <KEY> (or --code <CODE>)
3. The connector validates your key, connects to the relay, and forwards incoming requests to your local service
4. Your local service is now accessible from the cloud ✨

Options

| Flag | Short | Description | Default | |------|-------|-------------|---------| | --api-key | -k | API key from dashboard (no expiration) | — | | --code | -c | Pairing code from dashboard (expires in 10 min) | — | | --port | -p | Local port to forward to | 18789 | | --host | | Local host to forward to | 127.0.0.1 | | --start | | Start with saved config | — | | --status | | Show current config | — | | --api-url | | Custom API endpoint | production |

Configuration

Config is saved to ~/.openrelayai/config.json after connecting. You can edit this file directly or reconnect with a new key.

License

MIT