@relayplane/cli

Command-line interface for RelayPlane - AI model routing, cost estimation, and diagnostics.


Install

``bash
npm install -g @relayplane/cli
`

Or use npx:

`bash
npx @relayplane/cli
`

Commands

`bash
relay login # Authenticate with RelayPlane Cloud (device OAuth)
relay logout # Clear credentials and disconnect
relay status # Show CLI status and cloud connection
relay workflows # List all workflows in current project
relay sync # Sync local workflows with RelayPlane Cloud
relay dashboard # Open the cloud dashboard in browser
`

Quick Start

$3

`bash
relay login
`

This opens a browser for device authentication. Once authorized, your CLI is connected to RelayPlane Cloud.

$3

`bash
relay status
`

Shows your connection status, authenticated user, and project info.

$3

`bash
relay sync
`

Discovers local workflow files and syncs them with the cloud for monitoring and analytics.

$3

`bash
relay dashboard
`

Opens the RelayPlane dashboard in your browser to view runs, costs, and analytics.

Configuration

The CLI stores configuration at ~/.relayplane/:

- config.json - User preferences and settings
- credentials.json - Authentication tokens (keep private!)

Environment Variables

| Variable | Description |
|----------|-------------|
| RELAY_API_HOST | API host (default: https://api.relayplane.com) |
| RELAY_TELEMETRY | Enable/disable telemetry (true/false) |

Programmatic Usage

`typescript
import { getConfig, saveConfig } from '@relayplane/cli';

// Read current config
const config = await getConfig();
console.log(config.apiHost);

// Update config
await saveConfig({ ...config, telemetry: false });
``

Related Packages

- @relayplane/proxy - Intelligent AI model routing proxy
- @relayplane/sdk - SDK for workflow execution

Links

- Website: https://relayplane.com
- Documentation: https://relayplane.com/docs
- GitHub: https://github.com/RelayPlane/cli
- npm: https://www.npmjs.com/package/@relayplane/cli

License

MIT