本仓库将继续保留规则生成功能,但关于自定义代理和工作流的内容将合并至 BMAD-METHOD。新仓库实现了更通用的工具兼容性(Cursor/Roo/Cline/CoPilot),代理定义也更加完善实用。5月1日将完成仓库更新并推荐用户迁移至新仓库。
2025年4月19日
Cursor 0.49版本对规则系统进行了重大改进,修复了多项关键BUG。已发布新版教学视频和仓库,演示如何结合自定义代理使用规则系统,该方案对其他工具的兼容性更佳。
2025年4月16日
现可通过/Generate Cursor Rules
命令在对话中直接生成规则,无需离开聊天界面即可定义代理行为。
BMad版本:3.1(2025年3月30日)Cursor版本要求:0.48+
BMad公告
本仓库的发展远超预期,感谢社区的反馈、贡献与YouTube频道的支持。原计划仅作为Cursor规则实践文档的项目,现已演变为完整的工作流系统。未来重大更新将遵循版本规范,并提供迁移指南。我们的长期目标是构建更稳定的开发范式,例如正在演进的自定义代理模式。
仓库现更名为BMad Cursor主工作流代理与规则系统,持续跟进Cursor的迭代更新,满足AI开发社区的进阶需求。请查看CHANGELOG获取重要更新通知。
重要更新速览(2025年3月25日)
💡 强烈推荐IDE设置:在VS Code设置(通过右上角按钮以JSON格式打开)中添加:
json
"workbench.editorAssociations": { "*.mdc": "default" }
此配置可避免.mdc文件的UI渲染问题,确保保存功能正常,并清晰展示FrontMatter内容。
系统概览
视频演示即将上线,欢迎订阅获取最新Cursor教程!
本模板通过以下特性显著提升AI工作流效率:
- 自动规则生成:通过自然语言指令创建/更新四种主要规则类型
- 自定义代理生成:通过描述自动生成代理配置,更新.cursor/modes.json文件
- 行为一致性:根据规则类型自动/按需应用规则
- 快速项目初始化:无损集成核心规则到新/现有项目
- 自定义代理工作流指南:即将发布的新型敏捷工作流方案
- 示例代理:包含基础代理配置和趣味角色化代理示例(详见samples目录)
💡 传统敏捷工作流文档(已不推荐)参见:敏捷工作流文档
Cursor规则核心概念
- 使用YAML格式Frontmatter(含description/globs/alwaysApply字段)
- 支持显式/隐式规则生成
- 包含正反例提升模型训练效果
- 规则精简(目标25行,上限50行)
- 四类规则自动分类存储于.cursor/rules/子目录
- 文件扩展名强制为.mdc
快速入门
A) npm命令行
🛠 环境要求
Node.js >= 22.14.0
📥 安装与使用
bash
npx cursor-rules-deploy /项目路径
B) 新建项目
bash
git clone https://github.com/bmadcode/cursor-auto-rules-agile-workflow.git cd cursor-auto-rules-agile-workflow ./apply-rules.sh /项目路径 # 示例: ./apply-rules.sh ~/projects/my-project
脚本将创建包含核心规则和工作流的项目框架。
C) 现有项目集成
bash
git clone https://github.com/bmadcode/cursor-auto-rules-agile-workflow.git cd cursor-auto-rules-agile-workflow ./apply-rules.sh /项目路径
脚本将:
- 复制模板规则到.cursor/rules/
- 添加工作流文档
- 保留现有规则
规则生成示例
无需显式声明”创建规则”,描述需求即可:
- “创建兼顾详尽与简洁的TypeScript注释规范”
- “开发深度研究代理规则:调用系统时间戳+Tavily搜索”
- “禁止创建JS文件,强制使用TS/JSON”
- “确保TypeScript文件的错误处理规范”
- “代码文档保持专业,交流使用海盗语气”
AI将自动:
- 创建/更新规则文件
- 规范存储路径
- 维护版本控制
规则类型对照表
类型 | 应用场景 | description字段 | globs字段 | alwaysApply |
---|---|---|---|---|
代理选择 | 代理自主判断应用场景 | 关键描述 | 空 | false |
全局应用 | 所有请求生效 | 空 | 空 | true |
自动匹配 | 现有文件匹配 | 空 | 关键glob模式 | false |
增强匹配 | 新文件创建 | 包含描述 | 关键glob模式 | false |
手动触发 | 用户显式调用 | 空 | 空 | false |
私有规则与自定义代理
- 私有规则:可存储在用户目录.cursor/rules/,全局生效
- 自定义代理:通过定义工具集/模型/提示词实现精准控制,支持:
- 项目经理代理
- 架构师代理
- 领域专家代理
当前需手动维护modes.json文件,未来将适配Cursor官方格式。
最佳实践
规则创建
- 优先由AI生成规则
- 提供明确的正反例
- 新项目采用渐进式规则演进
- 定期合并同类规则
行为控制
- 发现异常时及时创建规则
- 使用清晰描述性语言
- 定期审核规则有效性
工作流整合
- 从模板规则起步
- 随项目演进优化规则
- 保持最小规则集原则
文件索引管理
.cursorindexingignore文件控制索引排除:
- 模板文件存放于.cursor/templates
- 包含在.cursorindexingignore但不在.cursorignore
- XNotes文件保持.cursorignore状态
💡 兼容性:支持Claude Sonnet 3.5/3.7/3.7T、o3-mini、GPT-4o等模型
贡献指南
欢迎提交符合现有标准的规则改进和新模板建议。
许可协议
MIT 🚀
阅读原文:https://github.com/bmadcode/cursor-custom-agents-rules-generator