1

CLI Reference

ruv edited this page 2026-05-25 10:01:20 -04:00

Table of Contents

• CLI Reference
• Core Commands (26 Commands, 140+ Subcommands)
• Swarm Orchestration
• Memory & Knowledge
• Sessions & Configuration
• MCP & Integration
• Intelligence & Learning
• Security & Quality
• Operations
• Common Patterns
• Initialize and Start
• Spawn and Manage Agents
• Memory Operations
• Hooks & Routing
• Security & Performance
• Environment Variables
• Flags

CLI Reference

Complete list of Ruflo v3.10.1 commands and subcommands.

---

Core Commands (26 Commands, 140+ Subcommands)

Swarm Orchestration

Command	Subcommands	Description
swarm	init, status, shutdown, health	Create and manage multi-agent swarms
agent	spawn, list, status, stop, metrics, pool, health, logs	Individual agent lifecycle
task	create, list, status, assign, complete, cancel	Task creation and tracking

Memory & Knowledge

Command	Subcommands	Description
memory	store, search, retrieve, list, delete, export, import, init, migrate, compress, stats	Persistent vector memory (HNSW-indexed)
agentdb	query, search, feedback, causal-edge, hierarchical-store, hierarchical-recall	Graph intelligence and pattern storage

Sessions & Configuration

Command	Subcommands	Description
session	save, restore, list, info, delete, export, import, current	Cross-session state persistence
config	set, get, list, reset, export, import	Configuration management
hooks	17 hooks + 12 workers	Self-learning hooks and background tasks

MCP & Integration

Command	Subcommands	Description
mcp	start, status, stop, list	MCP server lifecycle
plugins	list, install, uninstall, enable, disable	Plugin management
workflow	create, execute, list, status, pause, resume, stop, cancel, delete	Multi-step workflows

Intelligence & Learning

Command	Subcommands	Description
neural	train, status, patterns, predict, optimize	Neural pattern training (SONA, MoE)
intelligence	Trajectory start/step/end, pattern search/store, stats	RuVector learning pipeline
hooks	route, explain, pretrain	Intelligent routing and explanations

Security & Quality

Command	Subcommands	Description
security	scan, audit, cve, threats, validate, report	Security scanning and compliance
performance	benchmark, profile, metrics, optimize, report	Performance profiling
testgen	Coverage analysis and test generation	Test gap analysis
witness	sign, verify, update	Artifact verification (ADR-103)

Operations

Command	Subcommands	Description
daemon	start, stop, status, trigger, enable	Background worker daemon
doctor	Health checks and diagnostics	System health validation
migrate	status, run, rollback, validate	V2→V3 migration
completions	bash, zsh, fish, powershell	Shell autocompletion setup

---

Common Patterns

Initialize and Start

npx ruflo@latest init wizard
npx ruflo@latest daemon start
npx ruflo@latest swarm init --topology hierarchical --max-agents 8

Spawn and Manage Agents

npx ruflo@latest agent spawn -t coder --name my-coder
npx ruflo@latest agent list
npx ruflo@latest agent status <agent-id>
npx ruflo@latest agent stop <agent-id>

Memory Operations

# Store
npx ruflo@latest memory store --key "pattern" --value "content" --namespace patterns

# Search (semantic vector search)
npx ruflo@latest memory search --query "authentication" --namespace patterns

# List and retrieve
npx ruflo@latest memory list --namespace patterns
npx ruflo@latest memory retrieve --key "pattern" --namespace patterns

Hooks & Routing

# Check routing recommendation before spawning agents
npx ruflo@latest hooks route --task "Build REST API with auth"

# Run a background worker
npx ruflo@latest hooks worker dispatch --trigger optimize

# Check worker status
npx ruflo@latest hooks worker status

Security & Performance

# Security audit
npx ruflo@latest security scan --depth full

# Run benchmarks
npx ruflo@latest performance benchmark --suite all

# Verify artifacts
npx ruflo@latest witness verify

---

Environment Variables

# Configuration
CLAUDE_FLOW_CONFIG=./claude-flow.config.json
CLAUDE_FLOW_LOG_LEVEL=info

# API Keys
ANTHROPIC_API_KEY=sk-ant-...

# Memory
CLAUDE_FLOW_MEMORY_BACKEND=hybrid
CLAUDE_FLOW_MEMORY_PATH=./data/memory

# MCP
CLAUDE_FLOW_MCP_PORT=3000
CLAUDE_FLOW_MCP_TRANSPORT=stdio

---

Flags

Flag	Description
--version	Show Ruflo version
--verbose	Detailed output
--json	JSON output format
--help	Show command help

---

For detailed help on any command:

npx ruflo@latest <command> --help

---

Ruflo v3.10.1 · GitHub

Getting Started

• Home
• Installation
• Quick Start

Reference

• CLI Reference
• MCP Tools
• Agents

Architecture

• Memory & Graph
• Intelligence Pipeline
• Hooks & Workers
• Hive-Mind

Advanced

• Plugins
• ADR Index
• Benchmarks
• Witness Verification

Operations

• Troubleshooting
• Contributing
• Roadmap

Ruflo v3.10.1 · npm · GitHub · Benchmarks