Skip to content

Installation

This guide covers all the ways to install Clown on your system.

The easiest way to install Clown is using our install script:

curl -fsSL https://raw.githubusercontent.com/neul-labs/ccswitch/main/install.sh | bash

This will:

  1. Detect your platform (Linux/macOS, x64/arm64)
  2. Download the pre-built binary
  3. Install to ~/.local/bin
  4. Provide instructions to add to your PATH

Installation Methods

Pre-built Binaries

Download the latest release directly:

Platform Architecture Download
Linux x86_64 ringlet-linux-x64
Linux arm64 ringlet-linux-arm64
macOS x86_64 ringlet-darwin-x64
macOS Apple Silicon ringlet-darwin-arm64

After downloading:

# Extract
tar -xzf ringlet-*.tar.gz

# Move to PATH
mv ringlet ringletd ~/.local/bin/

# Make executable
chmod +x ~/.local/bin/ringlet ~/.local/bin/ringletd

From Source

Build from source using Cargo:

# Install from git
cargo install --git https://github.com/neul-labs/ccswitch ringlet

# Or clone and build
git clone https://github.com/neul-labs/ccswitch
cd ccswitch
cargo build --release
cp target/release/ringlet target/release/ringletd ~/.local/bin/

Requirements

Building from source requires:

  • Rust 1.75 or later
  • A C compiler (for native dependencies)

Local Build

If you have the repository cloned, you can build and install directly:

cd /path/to/ccswitch
./install.sh --local

This is useful for:

  • Development and testing
  • Offline installation
  • When GitHub releases are unavailable

Verify Installation

After installation, verify everything works:

# Check version
ringlet --version

# List available agents
ringlet agents list

# Check daemon status
ringlet daemon status

Expected output:

ringlet 0.1.0

PATH Configuration

If ringlet is not found after installation, add it to your PATH:

echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc

echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc
source ~/.zshrc

fish_add_path ~/.local/bin

Installing Agents

Clown works with these coding agents:

Claude Code

# Via npm
npm install -g @anthropic-ai/claude-code

# Verify
claude --version

Codex CLI

# Via npm
npm install -g @openai/codex

# Verify
codex --version

Grok CLI

# Follow installation from xAI
# https://grok.x.ai/cli

Agent Detection

Clown automatically detects installed agents. Run ringlet agents list to see what's available.

Uninstalling

To remove Clown:

# Stop the daemon
ringlet daemon stop

# Remove binaries
rm ~/.local/bin/ringlet ~/.local/bin/ringletd

# Remove configuration (optional)
rm -rf ~/.config/ringlet

Next Steps

Now that Clown is installed:

  1. :octicons-arrow-right-24: Follow the Quick Start to create your first profile
  2. :octicons-arrow-right-24: Learn the Key Concepts to understand how Clown works