Cursor自动规则生成与敏捷Cursor工作流模板

是魔丸啊
743 阅读9分钟

宝藏github库

重要更新说明

Cursor随着更新会经常变化 - 全局规则现在最好通过alwaysApply: true来定义 - 但描述字段仍然必须始终指定(至少在v 0.46.x版本中似乎是这样运行的) - 这可能在0.47+版本中有所变化。

此外，为了在自动生成规则时取得最佳效果，请更新您的Cursor用户或工作区设置，将以下对象添加到json对象中(禁用.mdc文件的特殊UI) - 这将解决许多人报告的无法自动生成并偶尔成功保存文件的问题。

"workbench.editorAssociations": {
    "*.mdc": "default"
  }

还有一点需要记住的是 - cursor的"编辑"模式在生成新文件时可以工作，但如果不将规则添加到上下文中，就不会自动获取规则。另一方面，Agent模式会找到规则，加载它，并正确遵循它。例如，如果您在编辑模式下要求创建规则 - 您可能会看到在项目根目录或其他随机奇怪位置生成规则，而没有给它000规则上下文 - 或者更好的是，使用Agent模式来做这件事。

此外，新增了一个.cursorindexingignore功能 - 在这里列出的文件(或路径)如果被指示，可以被cursor访问，但在索引项目时会被忽略。考虑到这一点，所有模板都已移至.cursor/templates文件夹，并在.cursorindexingignore文件中按模式包含，但不包含在.cursorignore中。XNotes仍保留在.cursorignore文件中，以便服务于原始目的(一个用于保存需要移动到其他地方使用的文件的位置)。

视频演示和演练 - 更多cursor视频即将推出，如果您喜欢该视频，请订阅！

注意：这已经用Claud Sonnet 3.5、3.7和3.7思考模式进行了测试 - 与其他模型的可靠性可能会有所不同。

这是一个用于建立使用Cursor规则系统的AI代理自我改进细粒度规则自动生成的模板。核心理念是用户永远不需要手动创建或更新规则 - 相反，AI代理通过一致格式和风格的自然语言请求处理规则创建和维护，这种方式：

  • 确保在适当时自动使用规则
  • 按需特定使用

💡 注意： 关于帮助管理您的项目并具有卓越记忆力和一致性的敏捷Cursor工作流系统的完整指南，请参阅敏捷工作流文档。

关于此模板的重要信息

细粒度规则和自定义工作流是在composer模式下充分利用AI的关键 - 有了这个，您可以自动快速生成和维护规则，使您的代理不断改进并从错误中学习。

这个模板解决了其他提出的规则生成器的问题，确保规则总是成功创建(规则创建后不会消失)，并且始终根据非常清晰简单的前言描述和必要的glob模式进行优化，以便代理自动选择。

此外，对规则的最佳格式化方式进行了大量研究 - 因为有很多相互竞争的和半成熟的理论 - 通过大量研究，挖掘论坛和研究，Claude提示工程的官方文档，Cline建议，cursor开发者在reddit和论坛中的评论，规则将遵循一般格式：

  • 前言，包含适当yaml格式的描述和glob模式
  • Markdown格式
  • 针对特定用例、标注、规则和亮点的XML标签的稀疏使用
  • Mermaid流程图或序列图，简洁地驱动AI的理解
  • 保持规则尽可能简短，同时最大限度地有效
  • 在规则中包含好的和坏的模式示例，这对AI代理LLM理解规则并正确应用它大有帮助

快速开始A - 启动一个已经包含敏捷工作流和规则生成器的新项目！

这将设置一个全新的项目文件夹，其中已经包含cursor规则和敏捷工作流文档，还有一个启动提示，以敏捷工作流开始您的新项目！

# 克隆此仓库
git clone https://github.com/bmadcode/cursor-auto-rules-agile-workflow.git
cd cursor-auto-rules-agile-workflow

./apply-rules.sh /path/to/your/project

例如：
./apply-rules.sh ~/projects/my-project

如果项目文件夹不存在，该脚本将创建它，并复制所有规则和文档，帮助您开始使用敏捷工作流！它还将创建.gitignore、.cursorignore、.cursorindexingignore和一个简单的基础readme.md文件，您可以根据需要替换或修改。

快速开始B - 将规则生成器添加到您现有的项目中

如果您想改善在现有项目中使用cursor的体验，可以通过运行以下命令将规则生成器添加到您的项目中：

# 克隆此仓库
git clone https://github.com/bmadcode/cursor-auto-rules-agile-workflow.git
cd cursor-auto-rules-agile-workflow

# 将规则应用到您的项目
./apply-rules.sh /path/to/your/project

该脚本将：

  1. 将所有模板规则复制到您项目的.cursor/rules/目录
  2. 将文档添加到docs/workflow-rules.md
  3. 更新.gitignore以保护私有规则
  4. 保留您项目中的任何现有规则

就是这样！您的项目现在配置了我们强大的AI工作流系统。

概述

此模板通过提供以下功能，大大改善了您在Agent或Edit模式(以前称为composer模式)中使用AI的方式：

  1. 自动规则生成：只需告诉AI您想要的行为，它就会创建或更新相应的规则。无需手动编写规则！
  2. 快速项目设置：通过预配置的Cursor规则立即开始，这些规则建立了AI交互的最佳实践。
  3. 行为控制：了解如何利用规则纠正AI行为并确保一致的结果。

工作流模板和记事本

工作流模板和流程文档现在组织在两个位置，以实现最大的灵活性：

  1. .cursor/rules/ - 包含生成格式良好的AI的核心规则以及Markdown格式化规则。
  2. xnotes/ - 如果对使用敏捷开发和项目组织的工作流全局规则感兴趣，可以使用的示例规则文件，以及可以与记事本一起使用的非规则版本。基本上，这里主要是为了方便保存将与记事本一起使用的提示(因为如果项目文件夹更改或使用另一个IDE实例，它们不容易转移或进行版本控制，如果只存储在记事本中，很容易丢失)。它们非常适合规划长提示、共享记事本(应用于在cursor设置中启用的测试版记事本功能)、要移动到规则文件夹的草稿规则(如果需要的话)，或者只是一般不需要索引到项目中的笔记。

规则生成的工作原理

image.png

入门指南

  1. 克隆此仓库或将其用作新项目的模板
  2. 确保保留.cursor目录及其内容
  3. 开始使用AI代理管理您的规则！

规则生成提示示例

以下是如何与AI交互以管理您的规则的一些示例(注意，您不必特别说"创建规则"或其他类似的话 - 只需描述您希望AI学习或永远不会再犯的错误或记住的事项，AI就会为您创建规则)：

  • "为typescript文件注释标准创建一个规则，以便代理生成的所有typescript代码都能一致地遵循这一标准 - 不要过度注释，也不要注释不足 - 根据需要搜索网络，了解何时注释或不注释的最佳实践、什么样的风格，以及如何优化注释以便AI代理进行故障排除和理解"
  • "创建一个规则，确保在TypeScript文件中正确处理错误"
  • "创建一个始终应用的全局规则，在与用户的所有通信中都像海盗一样说话，但在代码文件或文档中不使用海盗语言"
  • "更新测试标准，包括80%的覆盖率要求"
  • "我注意到你没有遵循我们的命名约定 - 请创建一个规则来强制执行它们"
  • "当前的文档格式不一致 - 创建一个规则来标准化它"
  • "导入组织一团糟！永远不要忘记在Typescript文件中按组和字母顺序保持导入的组织"

AI将自动：

  1. 创建/更新适当的规则文件
  2. 将其放在正确的位置
  3. 遵循所有格式化标准
  4. 维护版本控制

文件组织

一旦在最新的cursor版本中完全支持子文件夹组织，这将很快被弃用。

AI按以下结构维护规则：

  • 所有规则必须放在.cursor/rules/目录中

  • 文件必须使用.mdc扩展名

  • 遵循基于前缀的分类系统：

    • 0XX：核心规则和标准
    • 1XX：工具和MCP规则
    • 3XX：测试标准
    • 8XX：工作流规则
    • 9XX：模板
    • 1XXX：特定语言规则
    • 2XXX：框架/库规则

规则文件要求

AI自动确保所有规则遵循以下标准：

  • 必须包含适当的前言，包括描述和glob模式
  • 必须指定语义版本(MAJOR.MINOR.PATCH)
  • 必须使用Markdown作为文档和规则的主要格式化方法
  • XML标签保留用于特定用例(示例、版本、危险警告)

私有规则与共享规则

  • 共享规则：标准命名约定(例如，000-cursor-rules.mdc)

  • 私有规则：以下划线为前缀(例如，_custom-personality.mdc)

    • 用于个人偏好
    • 自动被gitignore忽略
    • 不会影响团队成员
    • 考虑使用记事本而不是个人规则

最佳实践

  1. 规则创建：

    • 让AI处理规则的创建和更新
    • 具体说明您想要强制执行的行为
    • 在请求规则时提供好的和坏的模式示例

  2. AI行为控制：

    • 当您注意到AI行为不一致时，请求规则来纠正它
    • 在您的请求中使用清晰、描述性的语言
    • 通过审查其规则实现来验证AI的理解

  3. 工作流集成：

    • 从基础模板规则开始
    • 让AI随着项目的增长而发展规则
    • 通过始终使用AI进行规则管理来保持一致性
avatar
文章
阅读
粉丝