Skip to main content

Documentation Index

Fetch the complete documentation index at: https://ryvn.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

The Ryvn CLI is in beta. Commands and flags may change between releases.
The Ryvn CLI lets you manage environments, services, installations, and deployments directly from your terminal. It connects to the same Ryvn API as the dashboard, so everything you can do in the UI is available from the command line.

​
Install

Recommended 
curl -fsSL https://ryvn.ai/install.sh | bash
This detects your OS and architecture, downloads the latest release, and adds ryvn to your PATH. Homebrew 
brew tap ryvn-technologies/tap
brew install ryvn
Homebrew installations do not auto-update. Run brew upgrade ryvn periodically to get the latest features and security fixes.
Verify the installation: 
ryvn --version

​
Authenticate

Log in with your Ryvn account using the browser-based device flow: 
ryvn auth login

​
Upgrade

The CLI checks for updates automatically. To upgrade: 
ryvn upgrade
If you installed via Homebrew, use brew upgrade ryvn instead — ryvn upgrade is not supported for Homebrew installations.

​
Using the CLI with agents

AI coding agents need their own identity to use the CLI. Service users provide scoped, programmatic access that you can assign to an agent without sharing your personal credentials.

​
Create a service user

Service users provide scoped, programmatic access to your Ryvn organization. Create one from the CLI: 
ryvn auth create service-user my-agent
This outputs a client ID and client secret. Save these securely. The client secret cannot be retrieved again. 
Service user "my-agent" created successfully

Client ID:     abc123...
Client Secret: secret456...

Save these credentials securely. The client secret cannot be retrieved again.

​
Use service users via profiles

For agents running on your local machine, create a profile with the service user credentials: 
ryvn auth create profile my-agent \
  --client-id your-client-id \
  --client-secret your-client-secret \
  --org-id your-org-id
Then set it as the active profile: 
ryvn auth use profile my-agent
ryvn get service

​
Use service users via environment variables

For CI pipelines, remote servers, or agent runtimes, pass credentials via environment variables: 
export RYVN_CLIENT_ID=your-client-id
export RYVN_CLIENT_SECRET=your-client-secret
export RYVN_ORG_ID=your-org-id
This ensures the CLI operates against the correct org and environment without requiring interactive setup.

​
Core commands

The CLI is organized around verbs. Each verb operates on one or more resource types.
VerbPurposeExample
getList or get a resourceryvn get service
describeDetailed view of a resourceryvn describe installation my-app -e production
createCreate a resourceryvn create release my-service 1.0.0
deleteDelete a resourceryvn delete installation my-app -e staging
logsStream logs from an installationryvn logs my-app -e production
Run ryvn --help for the full command list, or ryvn <command> --help for details on any command.

​
Marketplace blueprints

The CLI supports browsing and installing marketplace blueprints. Marketplace blueprints use the ryvn.app/ prefix: 
# List available marketplace blueprints
ryvn get blueprint --marketplace

# View inputs and outputs for a marketplace blueprint
ryvn describe blueprint ryvn.app/postgres

# Install a marketplace blueprint
ryvn create blueprint-installation my-database \
  --blueprint ryvn.app/postgres \
  -e production

# List installations of marketplace blueprints
ryvn get blueprint-installation --blueprint ryvn.app/postgres

​
Output formats

All commands that display data support JSON output: 
# Table output (default)
ryvn get service

# JSON output
ryvn get service -o json