Reading the repo

Opening the box…

How to set up ruflo (ruvnet/ruflo) · gitmanual

Assembly instructions

ruvnet/ruflo

🌊 The original agent harness. Deploy intelligent multi-player swarms, coordinate autonomous workflows, and build conversational AI systems. Features adaptive memory, self-learning intelligence, federation, vector RAG integration, and native Claude Code / Codex / Hermes and many more Integrated

Node.jsRust#agentic-ai#agentic-framework#agentic-workflow#agents

Difficulty: Moderate
Time: about 15 min
Stars: ★ 81,035
Activity: Updated this month
License: MIT
Open issues: 646
Got it running: Be the first
Looked up: 6 h ago

Saved setup from 6 h ago

Start here

Website ↗cognitum.oneThe project's own site.

Setup script in the repo

The maintainers included scripts/install.sh. Run it from the cloned folder after reading it.

bash scripts/install.sh

Will it work on my device?

Yes, it installs on your macOS

The README gives a install script install for macOS.

Checking for

Install with a package manager

install script

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

Pipes a remote script into your shell. Read it before running.

npm

npm install -g ruflo@latest

From the README, exactly as the maintainers wrote it.

Did you get it running?

No reports for macOS yet.

Still stuck? Get a written guide

Claude reads the 12 key files and writes a step-by-step guide for macOS. Once written, it's saved for everyone.

Parts list

1×Node.js >=20.0.0runtime
1×Rust stableruntime
1×pnpm package manager

33× settings in .env

BRAND_NAME
BRAND_DESCRIPTION
PUBLIC_ORIGIN
OPENAI_API_KEYsecret
GOOGLE_API_KEYsecret
OPENROUTER_API_KEYsecret
MONGODB_DB_NAME
OPENID_PROVIDER_URLoptional
OPENID_CLIENT_IDoptional
OPENID_CLIENT_SECRETsecretoptional
OPENID_SCOPESoptional
OPENID_NAME_CLAIMoptional
COOKIE_SECUREoptional
COOKIE_SAMESITEoptional
SEARCH_API_URL
RESEARCH_API_URL
MCP_GROUP_INTELLIGENCE
MCP_GROUP_AGENTS
MCP_GROUP_MEMORY
MCP_GROUP_DEVTOOLS
MCP_GROUP_SECURITY
MCP_GROUP_BROWSER
MCP_GROUP_NEURAL
MCP_GROUP_AGENTIC_FLOW
MCP_GROUP_CLAUDE_CODE
MCP_GROUP_GEMINI
MCP_GROUP_CODEX
ANTHROPIC_API_KEYsecret
GCP_PROJECT_ID
GCP_REGION
VITE_SUPABASE_URL
VITE_SUPABASE_PUBLISHABLE_KEYsecret
VITE_SUPABASE_PROJECT_ID

Share this manual

Is this your repo?

Add a badge to your README so newcomers find these steps.

[![Setup manual](https://gitmanual.com/ruvnet/ruflo/badge.svg)](https://gitmanual.com/ruvnet/ruflo)

Good to know

Monorepo (workspaces) — install from the repo root.
Cargo workspace — pick a crate with cargo run -p <name>.
Has AGENTS.md — instructions for coding agents. You can open Claude Code (or another agent) in the cloned folder and ask it to do the setup for you.
Nested projects: plugins/ruflo-ai-team/package.json, plugins/ruflo-arena/package.json, plugins/ruflo-chatgpt-federation/package.json, plugins/ruflo-graph-intelligence/package.json and 11 more

package.json scripts (16)

devtsx watch src/index.ts
buildtsc
build:tscd v3/@claude-flow/cli && npm run build || true
prepublishOnlynode scripts/prepare-root-publish.mjs
testvitest
e2enode scripts/e2e/host-matrix.mjs
e2e:liveRUFLO_E2E_LIVE=1 node scripts/e2e/host-matrix.mjs --live
test:uivitest --ui
test:securityvitest run v3/__tests__/security/
lintcd v3/@claude-flow/cli && npm run lint || true
security:auditnpm audit --audit-level high
security:fixnpm audit fix
security:testnpm run test:security
v3:domainsnpm run build:domains
v3:swarmnpm run start:swarm
v3:securitynpm run security:audit && npm run security:test

Files we read (12)

.github/workflows/adr-166-mcp-bridge-security.yml

.github/workflows/all-plugins-smoke.yml

.github/workflows/ci.yml

.github/workflows/integration-tests.yml

.github/workflows/metaharness-ci.yml

.github/workflows/v3-ci.yml

CONTRIBUTING.md

Cargo.toml

README.md

package.json

ruflo/.env.example

v3/goal_ui/example.env

Branch main · 8,558 files in the repo