# Where to Find Ruflo Documentation: A Complete Guide to Repository Resources

> Find complete rufflo documentation within the ruvnet/ruflo GitHub repository. Explore the root README, V3 architecture guides, and subsystem specific READMEs for comprehensive resources.

- Repository: [rUv/ruflo](https://github.com/ruvnet/ruflo)
- Tags: documentation
- Published: 2026-03-09

---

**Ruflo's documentation is hosted entirely within the `ruvnet/ruflo` GitHub repository, organized across a comprehensive root README, detailed V3 architecture guides in [`v3/README.md`](https://github.com/ruvnet/ruflo/blob/main/v3/README.md), and subsystem-specific READMEs located in directories such as `v3/@claude-flow/swarm/`, `v3/mcp/`, and `v3/plugins/`.**

The `ruvnet/ruflo` repository maintains all ruflo documentation inline with its source code, ensuring that architectural guides, API references, and usage examples remain synchronized with the actual implementation. This structure allows developers to access authoritative, version-controlled resources directly alongside the code they describe.

## Primary Documentation Entry Points

### Root README ([`README.md`](https://github.com/ruvnet/ruflo/blob/main/README.md))

The project overview and quick-start guide reside at the repository root in [`README.md`](https://github.com/ruvnet/ruflo/blob/main/README.md). This file provides high-level descriptions, installation badges, and initial setup instructions that point toward the V3 documentation. According to the source code analysis, this is the first stop for any new user seeking ruflo documentation.

### V3 Architecture Guide ([`v3/README.md`](https://github.com/ruvnet/ruflo/blob/main/v3/README.md))

The [`v3/README.md`](https://github.com/ruvnet/ruflo/blob/main/v3/README.md) file contains the core architectural documentation for Ruflo V3, including detailed explanations of the agent taxonomy, swarm topologies, memory subsystems, security models, and routing mechanisms. This document serves as the authoritative reference for understanding how the V3 orchestration layer functions.

## Subsystem-Specific Documentation

### Swarm Orchestration (`v3/@claude-flow/swarm/README.md`)

For coordinating multiple agents, the swarm documentation at `v3/@claude-flow/swarm/README.md` provides the Swarm Orchestration API reference and explains anti-drift defaults. This guide details how to initialize and manage agent swarms using the hierarchical topology and other configuration options.

### Memory and Learning ([`v3/mcp/README.md`](https://github.com/ruvnet/ruflo/blob/main/v3/mcp/README.md))

The Model-Context-Protocol (MCP) server documentation at [`v3/mcp/README.md`](https://github.com/ruvnet/ruflo/blob/main/v3/mcp/README.md) explains the memory and learning subsystem. This file describes how to start the MCP server so Claude-compatible clients can invoke Ruflo tools, and documents the semantic routing capabilities for pattern retrieval.

### Agent Database Controllers (`v3/@claude-flow/agentdb/README.md`)

For persistent storage and memory management, `v3/@claude-flow/agentdb/README.md` documents the Agent-DB controllers and hierarchical memory structures. This guide covers database patterns and memory-related tooling implemented in the AgentDB subsystem.

### Plugin Development ([`v3/plugins/README.md`](https://github.com/ruvnet/ruflo/blob/main/v3/plugins/README.md))

The plugin SDK and publishing workflow are documented at [`v3/plugins/README.md`](https://github.com/ruvnet/ruflo/blob/main/v3/plugins/README.md). Each individual plugin directory contains its own README explaining specific capabilities, installation methods, and configuration options for extending Ruflo with custom functionality.

## Command-Line Reference Documentation

### Installation Script ([`scripts/install.sh`](https://github.com/ruvnet/ruflo/blob/main/scripts/install.sh))

The bash installer at [`scripts/install.sh`](https://github.com/ruvnet/ruflo/blob/main/scripts/install.sh) serves as executable documentation, demonstrating required environment variables, dependency checks, and installation flags. Reviewing this script reveals the exact setup process and system requirements for running Ruflo.

### CLI Entry Point ([`bin/cli.js`](https://github.com/ruvnet/ruflo/blob/main/bin/cli.js))

The main command-line interface implementation at [`bin/cli.js`](https://github.com/ruvnet/ruflo/blob/main/bin/cli.js) contains the source of truth for all CLI commands, flags, and options. This file documents how to invoke specific functionality such as initializing projects, starting MCP servers, and managing agent swarms.

The following commands demonstrate documented CLI usage patterns:

```bash

# Install Ruflo using the one-line installer

curl -fsSL https://cdn.jsdelivr.net/gh/ruvnet/claude-flow@main/scripts/install.sh | bash

# Initialize a new project with default configuration

npx ruflo@latest init

# Start the MCP server for Claude Desktop integration

npx ruflo@latest mcp start

# Execute a single-agent task

npx ruflo@latest --agent coder --task "Create a function that returns a greeting string"

# Initialize and start a hierarchical swarm

npx ruflo@latest swarm init --topology hierarchical --maxAgents 6
npx ruflo@latest swarm start --objective "Add JWT authentication to src/auth.ts"

# Search memory using semantic routing

agentdb_semantic-route --input "fix login bug"

```

## Testing and CI Documentation

### Integration Tests

The `tests/` directory, including files such as [`rvf-integration.test.ts`](https://github.com/ruvnet/ruflo/blob/main/rvf-integration.test.ts), provides executable documentation through Vitest integration tests. These files demonstrate real-world usage scenarios and expected behaviors for various Ruflo components.

### GitHub Workflows

The `.github/workflows/` directory contains CI/CD pipeline definitions that document how to run tests, perform linting, and execute releases. These workflow files serve as reference implementations for continuous integration with Ruflo.

## Summary

- **Ruflo documentation** is maintained entirely within the `ruvnet/ruflo` GitHub repository, ensuring version synchronization with the codebase.
- **Entry points** include the root [`README.md`](https://github.com/ruvnet/ruflo/blob/main/README.md) for quick-start guidance and [`v3/README.md`](https://github.com/ruvnet/ruflo/blob/main/v3/README.md) for architectural deep-dives.
- **Subsystem guides** are located in specific directories such as `v3/@claude-flow/swarm/`, `v3/mcp/`, and `v3/plugins/`, each containing focused README files.
- **CLI reference** is embedded in [`scripts/install.sh`](https://github.com/ruvnet/ruflo/blob/main/scripts/install.sh) and [`bin/cli.js`](https://github.com/ruvnet/ruflo/blob/main/bin/cli.js), demonstrating installation procedures and command usage.
- **Testing examples** in `tests/` and `.github/workflows/` provide practical implementation patterns.

## Frequently Asked Questions

### Is there external documentation for Ruflo outside of GitHub?

No, Ruflo does not maintain separate external documentation sites. All authoritative documentation resides within the repository itself, organized across README files in the root, `v3/`, and subsystem directories. This approach ensures that documentation stays synchronized with code changes and version releases.

### Which documentation should I read first as a new user?

Start with the root [`README.md`](https://github.com/ruvnet/ruflo/blob/main/README.md) for installation instructions and high-level concepts. Then proceed to [`v3/README.md`](https://github.com/ruvnet/ruflo/blob/main/v3/README.md) to understand the V3 architecture, agent taxonomy, and swarm topologies. If you plan to use specific features like the MCP server or swarm orchestration, consult the respective subsystem READMEs in `v3/mcp/` and `v3/@claude-flow/swarm/`.

### How do I find documentation for specific CLI commands?

CLI documentation is embedded in the source files [`scripts/install.sh`](https://github.com/ruvnet/ruflo/blob/main/scripts/install.sh) and [`bin/cli.js`](https://github.com/ruvnet/ruflo/blob/main/bin/cli.js). The install script documents environment setup and installation flags, while [`bin/cli.js`](https://github.com/ruvnet/ruflo/blob/main/bin/cli.js) contains the implementation and available flags for all commands including `init`, `mcp start`, `swarm init`, and `swarm start`. Additionally, the root README provides common usage examples.

### Are there code examples in the documentation?

Yes, code examples appear throughout the repository documentation. The root README and [`v3/README.md`](https://github.com/ruvnet/ruflo/blob/main/v3/README.md) contain installation and initialization commands. The `tests/` directory includes Vitest integration tests such as [`rvf-integration.test.ts`](https://github.com/ruvnet/ruflo/blob/main/rvf-integration.test.ts) that demonstrate real-world usage scenarios. Additionally, the CLI source in [`bin/cli.js`](https://github.com/ruvnet/ruflo/blob/main/bin/cli.js) and the install script in [`scripts/install.sh`](https://github.com/ruvnet/ruflo/blob/main/scripts/install.sh) serve as executable references for command syntax and options.