CLI Overview

What is the Riven CLI?

The Riven CLI (riven) is a unified command-line tool that consolidates proto codegen, service scaffolding, Docker publishing, platform operations, task management, and internal documentation into a single binary. It replaces four legacy tools (riven-gen, riven-proto-plugin, riven-proto Go CLI, and riven-publish).

Global Options

These options can be passed to any command:

Command Groups

The CLI is organized into the following command groups:

Core Workflow

• auth — Token and identity management (login, logout, status, token).
• proto — Proto codegen, registry, and validation (generate, lint, breaking, publish, pull, search, cache).
• service — Service scaffolding (create new gRPC services for Node.js or Python).
• publish — Build and push Docker images (workspace-aware monorepo support).

Platform Operations

• dev-center — Platform operations: service management, rollouts, rollbacks, secrets, resources, pods, logs, deployments, and version history.
• tasks — Kanban task management (list, create, update, delete, move, comment).

Internal Documentation

• spaces — Manage documentation spaces (list, create, get, delete).
• pages — Documentation pages (list, create, get, delete, move, tree).
• templates — Page templates (list, get).
• comments — Page comments (list, add, resolve, delete).
• labels — Page labels (list, add, remove).
• search — Full-text documentation search across spaces.
• permissions — Space-level RBAC (get, set, remove roles).
• attachments — Page file attachments (list).
• history — Page version history.
• diff — Compare page versions side-by-side.

Setup and Diagnostics

• init — Initialize workspace config (registry URL, org ID).
• doctor — Environment diagnostics (Node.js, Yarn, buf, git, Docker).
• completions — Generate shell completions for bash, zsh, or fish.
• dev — Local development overlay mode with HMR against production.

Quick Start

# Install the CLI
curl -fsSL https://docs.riven-ai.dev/api/install | bash
 
# Authenticate
riven auth login
 
# Initialize your workspace
riven init --registry-url https://proto.riven-ai.dev --org-id my-org
 
# Check your environment
riven doctor
 
# Enable shell completions
eval "$(riven completions)"

Configuration

The CLI resolves configuration from multiple sources in priority order:

1. Command-line flags — --registry-url, --token, --org-id
2. Environment variables — RIVEN_TOKEN, RIVEN_REGISTRY_URL
3. Stored credentials — ~/.config/riven/credentials.json
4. Project config — .rivenrc.json in the workspace root (created by riven init)