Installation

Ryvos ships as a single Rust binary. One install, zero runtime dependencies.

Prerequisites

• Docker (optional) — for sandboxed tool execution
• An LLM provider: Anthropic, OpenAI, Ollama, or any OpenAI-compatible API

Quick Install (Recommended)

The installer script detects your platform and downloads the correct binary:

curl -fsSL https://raw.githubusercontent.com/Ryvos/ryvos/main/install.sh | sh

This installs the ryvos binary to ~/.local/bin/. Make sure it's in your PATH:

export PATH="$HOME/.local/bin:$PATH"

Install from Source

Requires Rust 1.75+ — install via rustup.

git clone https://github.com/ryvos/ryvos.git
cd ryvos
cargo install --path .

This compiles all 10 workspace crates and installs the ryvos binary to ~/.cargo/bin/.

Verify

ryvos --version

Optional: Docker for Sandboxing

Ryvos can run shell commands inside isolated Docker containers. Install Docker if you want sandboxed execution for T2+ operations:

# Ubuntu/Debian
sudo apt install docker.io
sudo usermod -aG docker $USER
 
# macOS
brew install --cask docker

When Docker is available and [agent.sandbox] is enabled in config, the bash tool automatically runs commands inside a container with memory limits, network isolation, and timeouts.

Optional: Web Search

For the web_search tool, you'll need a Tavily API key:

export TAVILY_API_KEY="tvly-..."

Shell Completions

Generate tab-completions for your shell:

ryvos completions bash >> ~/.bashrc
ryvos completions zsh >> ~/.zshrc
ryvos completions fish > ~/.config/fish/completions/ryvos.fish

System Requirements

Next Steps

Run ryvos init to create your configuration — see Quick Start.