Installation

Install the Riven CLI and configure shell completions.

Install

The recommended way to install the Riven CLI is via the install script:

curl -fsSL https://docs.riven-ai.dev/api/install | bash

This downloads the latest release and adds riven to your PATH.

npm Fallback

If you prefer npm, install globally from the private registry:

bash

npm install -g @riven-private/riven-cli

Verify Installation

bash

riven --cli-version

Shell Completions

Enable tab completion for all commands and options:

bash

# Auto-detect your shell
eval "$(riven completions)"
 
# Or specify explicitly
eval "$(riven completions bash)"   # Add to ~/.bashrc
eval "$(riven completions zsh)"    # Add to ~/.zshrc
riven completions fish | source    # Add to ~/.config/fish/config.fish

Add the eval line to your shell profile so completions persist across sessions.

Upgrading

Run the same install command to upgrade to the latest version:

bash

curl -fsSL https://docs.riven-ai.dev/api/install | bash

Or via npm:

bash

npm update -g @riven-private/riven-cli

Uninstalling

bash

npm uninstall -g @riven-private/riven-cli

Requirements

The CLI requires the following tools for full functionality:

Tool	Minimum Version	Required For
Node.js	22+	Core CLI runtime
Yarn	4+	Workspace detection, monorepo support
buf	Latest	Proto linting, codegen
git	Any	Version detection, module publishing
Docker	Any	Image building and publishing

Run riven doctor to verify all prerequisites are installed and configured correctly.

PreviousCLI Overview NextAuth