Use this file to discover all available pages before exploring further.
Ruflo has two distinct install paths serving different needs. The CLI install (npx ruflo@latest init) sets up the full Ruflo loop in your project: 100+ agents, 26 CLI commands with 140+ subcommands, the MCP server with 313 tools, 27 hooks, 12 background workers, and the complete self-learning memory system. The Claude Code plugin path installs individual plugins from the marketplace and gives you slash commands and agent definitions only — no MCP server, no hooks, no persistent memory. Use the CLI install for production; use the plugin path to evaluate specific plugins before committing.
CLI Install (Recommended)
Claude Code Plugin (Lite)
The CLI install creates a full Ruflo project setup and is the path where everything in the documentation applies.
1
Choose Your Install Method
# Recommended — interactive prompts, runs identically on every platformnpx ruflo@latest init wizard
Windows (native PowerShell / cmd): The curl ... | bash form requires a POSIX shell. If you see 'bash' is not recognized, use npx ruflo@latest init wizard instead — it runs natively in PowerShell and cmd and produces the same project setup. For the curl one-liner, use Git-Bash, WSL, or MSYS2.
2
Verify the Installation
npx ruflo@latest --version# Prints installed version, e.g. 3.7.0-alpha.8npx ruflo@latest doctor# Runs diagnostics: Node version, MCP config, hooks, memory system
All items in the doctor output should show ✅. Any ❌ entry includes a specific remediation hint.
3
Add the MCP Server to Claude Code
Register Ruflo as an MCP server so Claude Code can call all 313 tools in every session:
claude mcp add ruflo -- npx ruflo@latest mcp start
Confirm it appears in Claude Code’s MCP list:
claude mcp list# ruflo npx ruflo@latest mcp start
Once registered, tools like swarm_init, agent_spawn, memory_store, memory_search, and hooks_route are available to Claude Code without any additional configuration.
The default install includes the full ML and embeddings stack. Use --omit=optional (or --minimal) if you only need the core CLI and want a faster, lighter install:
Auto-configure the MCP server for Claude Code after install
--doctor
-d
Run full diagnostics after install completes
--no-init
Skip project initialization (install binary only)
--full
-f
Full setup: global install + MCP auto-configure + diagnostics
--version=X.X.X
Install a specific version instead of latest
Examples:
# Minimal global install — fastest, no ML stackcurl -fsSL https://cdn.jsdelivr.net/gh/ruvnet/ruflo@main/scripts/install.sh | bash -s -- --global --minimal# Global install with MCP auto-setupcurl -fsSL https://cdn.jsdelivr.net/gh/ruvnet/ruflo@main/scripts/install.sh | bash -s -- --global --setup-mcp# Full setup with diagnosticscurl -fsSL https://cdn.jsdelivr.net/gh/ruvnet/ruflo@main/scripts/install.sh | bash -s -- --full
The Claude Code plugin path installs individual plugins from the Ruflo marketplace. Each plugin adds slash commands, agent definitions, and skills to your Claude Code session. This is a lite mode — the Ruflo MCP server is not registered, so memory tools, swarm tools, and hook-based routing are unavailable.
# Step 1 — Add the Ruflo plugin marketplace (one-time, per Claude Code install)/plugin marketplace add ruvnet/ruflo# Step 2 — Install the plugins you need/plugin install ruflo-core@ruflo/plugin install ruflo-swarm@ruflo
Additional plugins available from the marketplace:
After installing, new slash commands and agent types are available immediately. Run /reload-plugins if new commands do not appear.
Plugin mode limitations: MCP tools — including memory_store, memory_search, swarm_init, agent_spawn, hooks_route, and all 313 other Ruflo MCP tools — are not available in plugin-only mode. The MCP server must be running and registered via claude mcp add for those tools to work. If you need the full Ruflo loop, switch to the CLI install path.
To update Ruflo helpers, hooks, and statusline while preserving your project data and customizations:
# Update to latest — preserves existing datanpx ruflo@latest init upgrade# Update AND add any skills, agents, or commands introduced in newer versionsnpx ruflo@latest init upgrade --add-missing
The --add-missing flag detects newly added skills, agents, and commands that were not present in your current install and adds them without overwriting any of your existing customizations.
