Back to Ruflo

Components Reference

v3/implementation/init/COMPONENTS.md

3.6.306.7 KB
Original Source

Components Reference

Detailed documentation for each component created by the V3 init system.

Directory Structure

project/
├── .claude/                    # Claude Code integration
│   ├── settings.json           # Hooks and permissions
│   ├── skills/                 # Claude Code skills
│   ├── commands/               # Claude Code commands
│   ├── agents/                 # Agent definitions
│   ├── helpers/                # Utility scripts
│   ├── statusline.sh           # Unix/macOS statusline
│   └── statusline.mjs          # ESM statusline module
├── .claude-flow/               # V3 runtime
│   ├── config.yaml             # Runtime configuration
│   ├── data/                   # Persistent data
│   ├── logs/                   # Log files
│   ├── sessions/               # Session archives
│   ├── hooks/                  # Custom hooks
│   ├── agents/                 # Agent state
│   ├── workflows/              # Workflow definitions
│   └── pids/                   # Process ID files
└── .mcp.json                   # MCP server configuration

Skills

Skills are installed to .claude/skills/ and provide specialized capabilities.

Core Skills

SkillDescription
swarm-orchestrationMulti-agent swarm coordination
swarm-advancedAdvanced swarm patterns
sparc-methodologySPARC development methodology
hooks-automationHook automation and learning
pair-programmingAI-assisted pair programming
verification-qualityCode quality verification
stream-chainData stream processing
skill-builderCustom skill creation

AgentDB Skills

SkillDescription
agentdb-advancedAdvanced AgentDB features
agentdb-learningAI learning with AgentDB
agentdb-memory-patternsMemory pattern implementation
agentdb-optimizationAgentDB performance optimization
agentdb-vector-searchSemantic vector search
reasoningbank-agentdbReasoningBank integration
reasoningbank-intelligenceAdaptive learning patterns

GitHub Skills

SkillDescription
github-code-reviewAI-powered code review
github-multi-repoMulti-repository management
github-project-managementProject board automation
github-release-managementRelease orchestration
github-workflow-automationGitHub Actions automation

V3 Skills

SkillDescription
v3-cli-modernizationCLI enhancement
v3-core-implementationCore module implementation
v3-ddd-architectureDomain-driven design
v3-integration-deepagentic-flow integration
v3-mcp-optimizationMCP server optimization
v3-memory-unificationMemory system unification
v3-performance-optimizationPerformance targets
v3-security-overhaulSecurity improvements
v3-swarm-coordinationSwarm coordination

Commands

Commands are installed to .claude/commands/ and provide quick actions.

Core Commands

  • claude-flow-help.md - Help documentation
  • claude-flow-swarm.md - Swarm operations
  • claude-flow-memory.md - Memory operations

Command Groups

GroupContents
analysis/Code analysis commands
automation/Task automation
github/GitHub operations
hooks/Hook management
monitoring/System monitoring
optimization/Performance tuning
sparc/SPARC methodology

Agents

Agent definitions are installed to .claude/agents/.

Core Agents

  • coder - Code generation and implementation
  • tester - Testing and quality assurance
  • reviewer - Code review and security
  • researcher - Information gathering
  • architect - System design

Agent Categories

CategoryAgents
core/Basic development agents
github/GitHub-integrated agents
sparc/SPARC methodology agents
swarm/Swarm coordination agents
consensus/Distributed consensus agents
hive-mind/Collective intelligence agents

Helpers

Helper scripts are installed to .claude/helpers/.

Cross-Platform Scripts (Node.js)

ScriptDescription
session.jsSession lifecycle management
router.jsIntelligent task routing
memory.jsKey-value memory store
statusline.jsProgress display

Unix/macOS Scripts

ScriptDescription
daemon-manager.shBackground process management
swarm-monitor.shReal-time swarm monitoring
checkpoint-manager.shSession checkpointing
pre-commitGit pre-commit hook
post-commitGit post-commit hook

Windows Scripts

ScriptDescription
daemon-manager.ps1PowerShell daemon manager
daemon-manager.cmdBatch wrapper for PowerShell

Statusline

The statusline provides real-time V3 progress in the shell.

statusline.sh (Unix/macOS)

Advanced bash script showing:

  • DDD domain progress
  • Swarm agent count
  • Security CVE status
  • Performance metrics
  • Context window usage
  • Model and branch info

statusline.mjs (ESM Module)

Claude Code statusline module showing:

  • Model name
  • Token usage
  • Cost tracking
  • Swarm status
  • Session time

MCP Configuration

.mcp.json configures MCP server integration.

json
{
  "mcpServers": {
    "claude-flow": {
      "command": "npx",
      "args": ["@claude-flow/cli", "mcp", "start"],
      "env": {
        "CLAUDE_FLOW_MODE": "v3",
        "CLAUDE_FLOW_HOOKS_ENABLED": "true",
        "CLAUDE_FLOW_TOPOLOGY": "hierarchical-mesh",
        "CLAUDE_FLOW_MAX_AGENTS": "15",
        "CLAUDE_FLOW_MEMORY_BACKEND": "hybrid"
      }
    }
  }
}

Runtime Configuration

.claude-flow/config.yaml configures V3 runtime.

yaml
version: "3.0.0"

swarm:
  topology: hierarchical-mesh
  maxAgents: 15
  autoScale: true
  coordinationStrategy: consensus

memory:
  backend: hybrid
  enableHNSW: true
  persistPath: .claude-flow/data
  cacheSize: 100

neural:
  enabled: true
  modelPath: .claude-flow/neural

hooks:
  enabled: true
  autoExecute: true

mcp:
  autoStart: false
  port: 3000

Platform-Specific Files

The init system auto-detects the platform and generates appropriate files:

Windows

  • daemon-manager.ps1 - PowerShell daemon management
  • daemon-manager.cmd - Batch wrapper
  • Platform paths use backslashes
  • Config stored in %APPDATA%

macOS

  • daemon-manager.sh - Bash daemon management
  • Zsh-compatible statusline hooks
  • Config stored in ~/Library/Application Support

Linux

  • daemon-manager.sh - Bash daemon management
  • XDG-compliant config paths
  • Config stored in ~/.config