ClaudeOnRails

一个基于 Rails 的开发框架，利用 claude-swarm 创建一支由专注于 Rails 开发不同方面的 AI 代理组成的智能团队。

与手动管理角色不同，ClaudeOnRails 会自动编排一群专业化的代理，它们像真正的开发团队一样协同工作。你只需描述想要构建的内容，剩下的就交给这个团队来完成。

工作原理

ClaudeOnRails 会创建一支由专业化 AI 代理组成的团队：

• 架构师：协调开发并做出高层次决策
• 模型：处理 ActiveRecord、迁移和数据库设计
• 控制器：管理路由和请求处理
• 视图：创建 UI 模板并管理资源文件
• 服务层：实现业务逻辑和服务对象
• 测试：确保全面的测试覆盖率
• DevOps：负责部署和基础设施

每个代理在其特定领域（目录）内工作，并能与其他代理协作以实现复杂功能。

安装

在你的 Rails 应用程序的 Gemfile 中添加：

group :development do
  gem 'claude-on-rails'
end

然后运行：

bundle install
rails generate claude_on_rails:swarm

在生成过程中，系统会提示你设置 Rails MCP Server，以便更好地访问文档。只需在提示时按 Y 键即可！

这将：

• 分析你的 Rails 项目结构
• 可选地设置 Rails MCP Server（推荐）
• 生成自定义的 swarm 配置
• 创建针对各代理的提示
• 设置你的开发环境

有关详细安装说明，请参阅 SETUP.md。

使用方法

启动你的开发 swarm

# 在你的 Rails 项目目录下
claude-swarm

自然语言开发

当 swarm 运行起来后，只需在 Claude 界面中描述你想构建的内容：

> 添加带有邮箱确认的用户认证功能
[架构师协调所有代理共同实施]

> 创建一个支持 Stripe 支付集成的购物车
[复杂功能会被自动分解并实现]

> 优化仪表盘——加载速度太慢了
[全栈性能优化]

> 为我们的移动应用构建一个带有 JWT 认证的 RESTful API
[包含认证的 API 开发]

swarm 会自动：

• 分析你的请求
• 将任务分配给相应的专家
• 在各个层次（模型、控制器、视图、测试）上实施
• 遵循 Rails 最佳实践
• 确保测试覆盖率

不同之处

传统的 Rails 开发与 AI 结合

在使用 AI 助手进行 Rails 开发时，你通常需要：

• 手动协调实现的不同方面
• 在模型、控制器、视图和测试之间切换上下文
• 确保应用程序各部分的一致性
• 记得实现测试、安全性和性能方面的考虑

ClaudeOnRails 的方法

使用 ClaudeOnRails 时，你只需用自然语言描述想要实现的内容：

> 创建一个支持社交登录的用户系统

swarm 会自动：

• 创建带有适当验证和关联的模型
• 实现带有认证逻辑的控制器
• 构建包含表单和 UI 组件的视图
• 添加全面的测试覆盖
• 处理安全性相关问题
• 优化数据库查询

这一切都由专门的代理协同完成。

项目结构

运行生成器后，你会得到以下目录结构：

your-rails-app/
├── claude-swarm.yml             # Swarm 配置文件
├── CLAUDE.md                    # 项目特定的 Claude 配置文件（导入 context.md）
└── .claude-on-rails/
    ├── context.md               # 由 CLAUDE.md 导入的 Rails 项目上下文
    └── prompts/                 # 代理专用的提示文件
        ├── architect.md
        ├── models.md
        ├── controllers.md
        └── ...

自定义

Swarm 配置

生成的 claude-swarm.yml 文件可以自定义：

instances:
  architect:
    description: "你项目特定的架构师描述"
    connections: [models, controllers, custom_agent]

  custom_agent:
    description: "你领域内的专业代理"
    directory: ./app/custom
    prompt_file: .claude-on-rails/prompts/custom.md

代理提示

通过编辑 .claude-on-rails/prompts/ 目录下的提示文件，可以自定义代理的行为：

• 添加项目特定的约定
• 包含领域知识
• 定义编码标准

特点

• 自动代理选择：无需选择使用哪个角色
• 协作式实现：代理像真正的团队一样协同工作
• 熟悉 Rails：深入理解 Rails 的约定和最佳实践
• 适应项目：检测你的项目结构并相应调整
• 测试驱动：为所有代码自动生成测试
• 性能优先：内置优化能力

通过 Rails MCP Server 增强文档支持

ClaudeOnRails 与 Rails MCP Server 集成，为你的 AI 代理提供对 Rails 文档和最佳实践的实时访问。

优势

• 最新文档：代理可以访问与你使用的 Rails 版本匹配的最新指南
• 框架资源：包括 Turbo、Stimulus 和 Kamal 的文档
• 一致标准：所有代理共享同一份文档来源
• 减少幻觉：代理会根据官方文档验证模式

自动设置

当你运行 rails generate claude_on_rails:swarm 时，系统会提示你自动设置 Rails MCP Server。只需按 Y 键即可！

如果你一开始跳过了这一步，也可以随时设置：

bundle exec rake claude_on_rails:setup_mcp

这个交互式命令会：

• 安装 Rails MCP Server gem
• 配置你的环境，以便更好地访问文档

检查状态

要验证 Rails MCP Server 是否已正确安装：

bundle exec rake claude_on_rails:mcp_status

工作原理

当 Rails MCP Server 可用时：

• 每个代理都可以实时查询 Rails 文档
• 版本特定的指导确保兼容性
• 代理参考官方实现
• 复杂功能遵循官方模式

系统要求

• Ruby 2.7+
• Rails 6.0+
• claude-swarm gem（作为依赖项自动安装）
• Claude Code CLI

示例

请查看 examples 目录中的示例，包括：

• 电子商务平台开发
• 仅 API 的应用程序
• 使用 Turbo/Stimulus 的实时功能
• 性能优化流程

贡献

我们欢迎贡献！请参阅 CONTRIBUTING.md 以获取指南。

许可证

MIT 许可证 - 详情请参阅 LICENSE。

致谢

• 由 claude-swarm 提供支持
• 专为 Claude Code 构建
• 集成 Rails MCP Server

ClaudeOnRails 快速上手指南

ClaudeOnRails 是一个基于 claude-swarm 的 Rails 开发框架，它能自动编排一组专业的 AI 智能体（如架构师、模型专家、控制器专家等），像真实开发团队一样协作完成你的需求。你只需用自然语言描述想要构建的功能，剩下的交给智能体集群处理。

环境准备

在开始之前，请确保你的开发环境满足以下要求：

• Ruby: 2.7 或更高版本
• Rails: 6.0 或更高版本
• 命令行工具: 必须安装 Claude Code CLI
• 依赖项: claude-swarm gem（安装过程中会自动作为依赖项安装）

安装步骤

1. 添加 Gem 依赖

在你的 Rails 项目根目录下的 Gemfile 中，将 claude-on-rails 添加到 :development 组：

group :development do
  gem 'claude-on-rails'
end

2. 安装依赖并生成配置

运行以下命令安装 gem 并启动生成器：

bundle install
rails generate claude_on_rails:swarm

3. 配置 Rails MCP Server（推荐）

在运行生成器时，系统会提示你是否设置 Rails MCP Server 以增强文档访问能力（提供实时的 Rails 官方文档、Turbo/Stimulus 资源等，减少 AI 幻觉）。

• 当出现提示时，直接输入 Y 确认。
• 如果错过了提示，后续也可随时通过以下命令补全设置：

  bundle exec rake claude_on_rails:setup_mcp
  

此过程将自动分析你的项目结构、生成定制的集群配置文件 (claude-swarm.yml) 以及各智能体的专属提示词。

基本使用

1. 启动开发集群

在项目根目录下运行以下命令启动 AI 智能体集群：

claude-swarm

2. 自然语言开发

集群启动后，直接在 Claude 界面中用自然语言描述你的需求。无需指定由哪个角色处理，系统会自动协调架构师、模型、控制器、视图、测试等智能体协同工作。

示例指令：

> Add user authentication with email confirmation

(架构师将协调所有智能体实现带邮件确认的用户认证)

> Create a shopping cart with Stripe payment integration

(复杂功能会被自动拆解并由相应领域的智能体实现)

> Optimize the dashboard - it's loading too slowly

(全栈性能优化)

> Build a RESTful API for our mobile app with JWT auth

(包含认证的 API 开发)

集群将自动执行以下操作：

• 分析需求并分配给对应的专业智能体
• 跨层级实现代码（Models, Controllers, Views, Tests）
• 遵循 Rails 最佳实践
• 自动生成测试用例以确保覆盖率