CLI Overview

The Rivano CLI lets you manage agents, policies, and traces from your terminal. It’s designed for developers who want to inspect and operate Rivano without opening a browser, and for CI/CD pipelines that need to deploy agents or run diagnostics.

Installation

npm install -g @rivano/cli

Verify:

rivano --version
# @rivano/cli 1.0.0

Authentication

Log in once and your credentials are saved to ~/.rivano/config.json:

rivano login
# Rivano API key: rv_...
# ✔ Logged in as [email protected]

Check who you are logged in as:

rivano whoami
# Email:   [email protected]
# Plan:    Pro
# Tenant:  acme-corp

Log out and delete stored credentials:

rivano logout
# ✔ Logged out

Config file

The CLI stores credentials at ~/.rivano/config.json:

{
  "apiKey": "rv_...",
  "baseUrl": "https://api.rivano.ai"
}

You can edit this file directly. The baseUrl field is useful for self-hosted control plane deployments.

Environment variables

Set these to override the config file in CI/CD environments:

VariableDescription
RIVANO_API_KEYAPI key — overrides apiKey in config file
RIVANO_BASE_URLBase URL — overrides baseUrl in config file
# In CI
RIVANO_API_KEY=rv_... rivano agents list

Global flags

All CLI commands accept these flags:

FlagShortDescription
--api-key <key>Override API key for this command only
--base-url <url>Override base URL for this command only
--jsonOutput raw JSON instead of formatted tables
--no-colorDisable ANSI color codes (useful in CI logs)
--help-hShow command help

Examples:

# Use a specific key for one command
rivano agents list --api-key rv_ci_key

# Get JSON output for scripting
rivano traces stats --json | jq '.avgDurationMs'

# Disable colors in CI
rivano deploy --no-color

Config priority

Configuration is resolved in this order (highest wins):

  1. Command flags (--api-key, --base-url)
  2. Environment variables (RIVANO_API_KEY, RIVANO_BASE_URL)
  3. Config file (~/.rivano/config.json)
💡

Use environment variables in CI/CD. Never hardcode API keys in scripts or commit them to source control.

Available commands

CommandDescription
rivano loginAuthenticate and save credentials
rivano logoutRemove stored credentials
rivano whoamiShow current user and plan
rivano statusDashboard overview
rivano doctorRun 5 diagnostic checks
rivano initCreate rivano.yaml in current directory
rivano deployDeploy agents from rivano.yaml
rivano agents <subcommand>Manage agents
rivano policies <subcommand>Manage policies
rivano traces <subcommand>Query traces