SwarmSDK, SwarmCLI & SwarmMemory

✨ Key Features

🚀 Quick Start

Installation

gem install swarm_cli # Includes swarm_sdk
swarm --help # Explore the modern CLI

Your First Swarm

version: 2
agents:
 lead:
 model: claude-3-5-sonnet-20241022
 role: "Lead developer coordinating development efforts"
 tools:
 - Read
 - Write
 - Edit
 - Bash
 delegates_to:
 - frontend
 - backend
 frontend:
 model: claude-3-5-sonnet-20241022
 role: "Frontend specialist handling UI and user experience"
 tools: [Read, Write, Edit]
 backend:
 model: claude-3-5-sonnet-20241022
 role: "Backend developer managing APIs and data layer"
 tools: [Read, Write, Edit, Bash]

# Interactive REPL mode
swarm run my_swarm.yml
# Or with a specific prompt
swarm run my_swarm.yml -p "Build a simple TODO app with React and Node.js"

📚 Documentation

Getting Started

Comprehensive Tutorial

Reference Documentation

Integration Guides

💡 Core Concepts

SwarmSDK

SwarmCLI

SwarmMemory

Configuration Formats

🎯 Example: Code Review Team

version: 2
agents:
 lead_reviewer:
 model: claude-3-5-sonnet-20241022
 role: "Lead code reviewer ensuring quality and best practices"
 tools: [Read, Write]
 delegates_to: [security_expert, performance_analyst]
 hooks:
 on_user_message:
 - run: "git diff main..HEAD > /tmp/changes.diff"
 append_output_to_context: true
 security_expert:
 model: claude-3-5-sonnet-20241022
 role: "Security specialist checking for vulnerabilities"
 tools: [Read]
 hooks:
 on_user_message:
 - run: "semgrep --config=auto --json"
 append_output_to_context: true
 performance_analyst:
 model: claude-3-5-sonnet-20241022
 role: "Performance analyst identifying bottlenecks"
 tools: [Read, Bash]

swarm run code_review.yml -p "Review the recent changes in the authentication module"

🧠 SwarmMemory Example

gem install swarm_memory

version: 2
agents:
 research_assistant:
 model: claude-3-5-sonnet-20241022
 role: "Research assistant with long-term memory"
 tools: [Read, Write]
 plugins:
 - swarm_memory:
 storage_dir: ./memories

🔧 Ruby DSL Example

require 'swarm_sdk'
swarm = SwarmSDK.build do
 agent :lead do
 model "claude-3-5-sonnet-20241022"
 role "Lead developer"
 tools :Read, :Write, :Edit, :Bash
 delegates_to :frontend, :backend
 end
 agent :frontend do
 model "claude-3-5-sonnet-20241022"
 role "Frontend specialist"
 tools :Read, :Write, :Edit
 end
 agent :backend do
 model "claude-3-5-sonnet-20241022"
 role "Backend specialist"
 tools :Read, :Write, :Edit, :Bash
 end
end
# Execute with the lead agent
result = swarm.execute(
 agent: :lead,
 prompt: "Build a simple TODO app"
)
puts result.message

🛠️ Advanced Features

Node Workflows

version: 2
nodes:
 analyzer:
 agent: code_analyst
 prompt: "Analyze the codebase and identify issues"
 fixer:
 agent: code_fixer
 prompt: "Fix the issues identified: {{ analyzer.output }}"
 depends_on: [analyzer]
 reviewer:
 agent: code_reviewer
 prompt: "Review the fixes: {{ fixer.output }}"
 depends_on: [fixer]
agents:
 code_analyst:
 model: claude-3-5-sonnet-20241022
 role: "Code analyst"
 tools: [Read]
 code_fixer:
 model: claude-3-5-sonnet-20241022
 role: "Code fixer"
 tools: [Read, Write, Edit]
 code_reviewer:
 model: claude-3-5-sonnet-20241022
 role: "Code reviewer"
 tools: [Read]

Hooks System

version: 2
agents:
 developer:
 model: claude-3-5-sonnet-20241022
 role: "Full-stack developer"
 tools: [Read, Write, Edit, Bash]
 hooks:
 # Run before each tool execution
 on_pre_tool:
 - run: "echo 'About to use {{ tool_name }}'"
 # Run after successful tool execution
 on_post_tool:
 - run: "echo 'Tool {{ tool_name }} completed successfully'"
 # Append git diff to every user message
 on_user_message:
 - run: "git diff"
 append_output_to_context: true
 # Run tests before the agent responds
 on_pre_response:
 - run: "npm test"
 stop_on_error: true

📊 Cost Tracking & Logging

require 'swarm_sdk'
swarm = SwarmSDK.load('my_swarm.yml')
result = swarm.execute(
 agent: :lead,
 prompt: "Build a simple TODO app",
 logger: Logger.new($stdout)
)
# Access cost information
puts "Total cost: $#{result.cost}"
puts "Tokens used: #{result.tokens}"

🔗 Integration Examples

Rails Integration

# app/jobs/code_review_job.rb
class CodeReviewJob < ApplicationJob
 def perform(pull_request_id)
 swarm = SwarmSDK.load(Rails.root.join('config', 'code_review_swarm.yml'))
 result = swarm.execute(
 agent: :lead_reviewer,
 prompt: "Review PR ##{pull_request_id}"
 )
 PullRequest.find(pull_request_id).update(
 review_status: 'completed',
 review_comments: result.message
 )
 end
end

Custom Plugins

# lib/my_plugin.rb
class MyPlugin < SwarmSDK::Plugin
 def on_agent_init(agent)
 # Add custom behavior when agent initializes
 end
 def on_user_message(message, agent)
 # Process user messages
 end
 def provide_tools
 [MyCustomTool.new]
 end
end
# Register the plugin
SwarmSDK.register_plugin(:my_plugin, MyPlugin)

🆚 SwarmSDK (v2) vs Claude Swarm (v1)

📖 Looking for v1 Documentation?

gem install claude_swarm

🤝 Contributing

📄 License

🔗 Links