Documentation

Ruflo Documentation

Everything you need to install, configure and operate Ruflo in production.

Installation

Install Ruflo via npm or Homebrew.

npm install -g ruflo

Quick Start

Initialize a project and spawn your first swarm.

ruflo init
ruflo swarm spawn --task "build feature"

CLI Commands

Inspect available commands.

ruflo --help

MCP Setup

Register Ruflo as an MCP server.

ruflo mcp register --client claude

Swarm Creation

Compose a swarm with named roles.

ruflo swarm create --topology mesh --agents planner,coder,reviewer

Agent Management

List and inspect agents.

ruflo agent list

Memory System

Read and write shared memory.

ruflo memory query "auth decisions"

Federation Setup

Connect multiple Ruflo nodes.

ruflo federation join <peer-url>

Security

Generate keys, configure RBAC, enable audit logs.

Configuration

Edit ruflo.config.json for defaults and limits.

Troubleshooting

Run diagnostics with ruflo doctor.

ruflo doctor

FAQ

Common questions answered.