Skip to content
right agent
You usually won't need these docs. The agent guides you right in the chat, and simple setup, maintenance, and use is the whole point. They're a work in progress and actively being expanded.

Install

Prerequisites

Section titled “Prerequisites”

Install these before running the installer:

Claude Code CLI

Section titled “Claude Code CLI”
Terminal window
npm install -g @anthropic-ai/claude-code
claude  # authenticate

Requires an active Claude subscription. Right Agent calls claude -p directly — no API key needed.

Telegram bot token

Section titled “Telegram bot token”
  1. Open @BotFather in Telegram.
  2. Send /newbot, follow the prompts.
  3. Save the bot token. The installer’s wizard will ask for it.

cloudflared

Section titled “cloudflared”

A Cloudflare account plus the cloudflared CLI, authenticated. The installer creates the named tunnel for you.

Terminal window
# macOS
brew install cloudflare/cloudflare/cloudflared


# Linux
# https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/downloads/


cloudflared tunnel login   # authenticate against your Cloudflare account

If you don’t have a Cloudflare account yet, sign up at https://dash.cloudflare.com/sign-up (free tier is sufficient).

Quick Install

Section titled “Quick Install”

One command installs right and process-compose:

Terminal window
curl -LsSf https://raw.githubusercontent.com/onsails/right-agent/master/install.sh | sh

The installer then runs the interactive right init wizard (asks for the Telegram bot token and network policy) and right doctor to verify the setup. The microVM runtime installs itself the first time an agent starts — there is no separate step for it.

Supported platforms: linux x86_64, linux aarch64, darwin aarch64 (Apple Silicon).

Build from Source

Section titled “Build from Source”

For platforms without a prebuilt binary, or when you want to run from a checkout:

Terminal window
git clone https://github.com/onsails/right-agent.git
cd right-agent
cargo install --path crates/right
right init
right doctor

This path requires a Rust toolchain (edition 2024).

After install

Section titled “After install”

right installs to ~/.local/bin. The installer adds that directory to your shell profile; open a new shell (or source your profile) so right is found, then:

Terminal window
right up

right up launches your agents via process-compose. Message your Telegram bot from your account — the agent replies.

Re-run right doctor whenever something seems off. It checks dependencies, agent configuration, sandbox connectivity, MCP status, and tunnel health.