Skip to content

Quick Start

ruv edited this page May 25, 2026 · 3 revisions

Quick Start

Get your first swarm running in 5 minutes.


1. Initialize the Project

npx ruflo@latest init wizard

Follow the prompts. This creates:

  • .claude/ — Ruflo config
  • .claude-flow/ — Plugin settings
  • CLAUDE.md — Agent definitions and hooks

2. Start the Daemon

npx ruflo@latest daemon start

This enables background workers and autonomous task loops.


3. Create Your First Swarm

Initialize a hierarchical swarm (recommended for learning):

npx ruflo@latest swarm init --topology hierarchical --max-agents 8 --strategy specialized

This creates a coordinated team with a central coordinator and 7 worker agents.


4. Spawn Your First Agent

npx ruflo@latest agent spawn -t coder --name my-coder

List all agents:

npx ruflo@latest agent list

5. Make Your First Memory Store

Store a pattern:

npx ruflo@latest memory store --key "auth-pattern" --value "JWT with refresh tokens" --namespace patterns

Search:

npx ruflo@latest memory search --query "authentication" --namespace patterns

6. Use in Claude Code

Open Claude Code and run a task:

@task
Analyze the src/auth module for security issues. Use the memory system to find relevant patterns.

Claude Code will:

  1. Route the task via hooks
  2. Spawn a researcher agent
  3. Search memory for past authentication audits
  4. Execute the analysis

Common Commands

Task Command
Check swarm status npx ruflo@latest swarm status
List all agents npx ruflo@latest agent list
Stop an agent npx ruflo@latest agent stop <agent-id>
Search memory npx ruflo@latest memory search --query "..."
View hooks npx ruflo@latest hooks list
Run benchmarks npx ruflo@latest performance benchmark
Security scan npx ruflo@latest security scan

Next Steps


Ruflo v3.10.1 · GitHub

Clone this wiki locally