# cursor-rule

**Repository Path**: cd20/cursor-rule

## Basic Information

- **Project Name**: cursor-rule
- **Description**: 开发项目时使用的 cursor rule
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 2
- **Created**: 2025-08-21
- **Last Updated**: 2025-11-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# AI 编程助手规则模板

一个全面的 AI 编程助手规则和模板集合，旨在通过标准化的工作流、文档结构和智能项目记忆系统，提升 AI 驱动的开发效率。

## 🌟 功能特性

- **🎯 全面的规则集**: 超过 15 个专业规则，覆盖从规划、构建到调试和测试的全过程。
- **📚 记忆库系统**: 基于 `docs/` 目录的智能文档结构，帮助 AI 理解项目历史和上下文。
- **🔄 标准化工作流**: 定义了 `PLAN`（规划）和 `ACT`（执行）两种工作模式，使 AI 协作更高效。
- **⚙️ 配置驱动**: 通过 `src/tools.json` 文件动态配置，轻松支持多种 AI 编程助手。
- **⚡ 智能安装**: 自动化安装脚本，支持递归复制、条件文件扩展名转换（例如为 `cursor` 将 `.md` 转为 `.mdc`）。

## 🗂️ 项目结构

```
cursor-rule/
├── docs/                      # 记忆库系统
│   ├── arch/
│   ├── PRD/
│   ├── record/
│   └── tasks/
├── src/
│   ├── entry.js               # Node.js 安装脚本
│   └── tools.json             # AI 工具配置文件
├── rules/                     # 规则集合
│   ├── memory.md              # 核心记忆库文档
│   ├── memory-file-path.md    # 记忆库文件路径定义
│   └── ...                    # 其他规则文件
└── README.md                  # 本文件
```

## 🚀 快速开始

### 先决条件

- Node.js (>= 18.0.0)

### 安装与使用

1.  **克隆仓库**

    ```bash
    git clone https://github.com/your-username/cursor-rule.git
    cd cursor-rule
    ```

2.  **执行安装脚本 (推荐)**

    我们推荐使用 `npm` 脚本来安装规则，因为它更简洁。

    ```bash
    # 语法: npm run init-rule -- -p <项目目录> -t <工具类型>

    # 示例: 为 cursor 安装规则到当前目录
    npm run init-rule -- -p . -t cursor
    ```

    **重要提示**: 命令中的 `--` 是必需的。它会告诉 `npm` 将其后的所有参数（例如 `-p . -t cursor`）都直接传递给我们的安装脚本。

    `工具类型` 必须是在 `src/tools.json` 文件中定义的 `tool_name` 之一。

3.  **查看帮助信息**

    ```bash
    npm run help
    ```

4.  **直接运行脚本 (备选)**

    你也可以不通过 `npm`，直接使用 `node` 来运行脚本：

    ```bash
    node src/entry.js -p . -t cursor
    ```

## 🔧 配置

本项目的核心在于 `src/tools.json` 配置文件。安装脚本通过读取此文件来确定支持的 AI 工具及其安装行为。

### 文件结构

该文件包含一个 `tools` 数组，每个对象代表一个工具的配置。

```json
{
  "tools": [
    {
      "tool_name": "cursor",
      "target": "rules"
    },
    {
      "tool_name": "another_tool",
      "target": "another_dir"
    }
  ]
}
```

- `tool_name`: 工具的唯一标识符，用于在执行脚本时通过 `-t` 参数指定。
- `target`: 安装规则的目标子目录名。

### 安装逻辑

当执行 `node src/entry.js -p ./my-project -t cursor` 时，脚本会：

1.  读取 `src/tools.json`。
2.  找到 `tool_name` 为 `cursor` 的配置。
3.  将 `rules/` 目录的内容复制到 `./my-project/.cursor/rules/`。
    - 目标路径结构为：`<项目目录>/.<tool_name>/<target>/`。
4.  **特殊处理**: 如果 `tool_name` 是 `cursor`，所有 `.md` 文件将被重命名为 `.mdc`。

你可以通过编辑 `src/tools.json` 来轻松添加或修改对不同 AI 工具的支持。

## 🔄 工作流与记忆库

本项目提倡一种结构化的 AI 协作模式，主要分为 `PLAN` 和 `ACT` 两个阶段。同时，通过 `docs/` 目录下的记忆库文件，AI 可以长期记忆项目的需求、架构和历史决策，从而提供更精准的辅助。

详细定义请参考 `rules/memory.md`。

## 🤝 贡献

欢迎提交 PR 或 Issue 来改进这套规则和工具！

## 📝 许可证

本项目基于 [MIT 许可证](LICENSE) 开源。