CLI reference

Install and login

Node.js 22 or later is required. Install the published versioned package from this website. The public CLI opens the access flow, which remains closed. Do not enter private project data or production provider secrets into a preview demo.

npm install -g https://optinrouter.ai/downloads/optinrouter-cli-0.3.1.tgz
optinrouter --version
optinrouter login

Available commands

Version 0.1.0 supports login, signup, status and version. Login and signup open the closed access pages; no credentials are issued. Status reads OPTINROUTER_API_KEY and reports the current access state. It does not route inference, capture sessions, start an MCP server, publish policy or register providers.

Command	Current behavior
optinrouter login	Open closed login flow
optinrouter signup	Open closed signup flow
optinrouter status	Check access with configured environment key
optinrouter --version	Print installed CLI version

Planned workspace commands

The following commands are proposed interface names only and are not implemented in 0.1.0. policies validate, routes explain, actions simulate, traces get and usage list should use the same versioned contracts and tenant scopes as REST. A future local validation mode must never fetch remote schemas, execute graph tools or infer permissions from text. Buyer offer-preview and provider certification-preview are also proposed, effect-free commands mapped to their preview REST scopes.

text

# Proposed only — not implemented in CLI 0.1.0
optinrouter policies validate policy.json
optinrouter routes explain --policy pol_engineering@3
optinrouter actions simulate graph.json --fixture review
optinrouter traces get trace_example
optinrouter usage list --region eu --outcome blocked
optinrouter buyer offer-preview --dataset ds_example --use evaluation --region eu
optinrouter provider certification-preview --endpoint ep_example --profile managed

Configuration and release gates

Future commands need explicit workspace selection, immutable policy/grammar/graph references, scoped credentials, bounded input files, deterministic error codes and redacted output. Publishing, activation, registration, purchase, canary rollout and delivery require separate authenticated write authority. A transport error or absent evidence must not fall back to an unconstrained route. Production CLI and MCP interoperability require certification alongside the gateway.