# cursor-guide

**Repository Path**: charispeng/cursor-guide

## Basic Information

- **Project Name**: cursor-guide
- **Description**: 常用 Cursor AI 编程开发规则和文档管理
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2025-08-15
- **Last Updated**: 2025-08-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Cursor Guide

**Cursor Guide** 是专为 Cursor IDE 设计的通用规则模板和使用指南，提供标准化的开发规范、AI指令系统、MCP工具配置以及使用记录，便于在不同项目中复用和定制。

## 核心价值

- **通用规则模板**：提供标准化的Cursor规则模板，覆盖多语言、多框架
- **使用指南记录**：记录Cursor IDE的使用技巧、配置方法和最佳实践
- **AI指令系统**：完整的AI指令系统，支持结构化开发流程
- **MCP工具集成**：集成常用MCP工具，增强AI能力

## 核心特性

- **规则模板库**：完整的 `.cursor/rules/` 目录结构，包含通用规则模板
- **AI 指令系统**：18个核心指令，支持结构化工作流程
- **MCP 工具集成**：集成 Context 7、Sequential Thinking、MCP Feedback Enhanced
- **使用记录**：记录Cursor IDE的使用经验、配置方法和技巧
- **多技术栈**：内置主流框架及语言规范
- **可复用性**：模板化设计，便于在不同项目中复用和定制

## 快速上手

1. **复制规则模板**：将 `.cursor/rules/` 目录复制到你的项目中
2. **使用指令**：通过 `/[指令名]` 快捷指令快速操作
3. **配置 MCP**：安装和配置 MCP 工具增强 AI 能力
4. **参考使用记录**：查看 `.docs/` 目录中的使用指南和配置方法

## AI 指令系统

### 核心指令（18个）

| 指令 | 功能 | 优先级 |
|------|------|--------|
| `/research` | 研究模式 | 最高 |
| `/plan` | 规划模式 | 最高 |
| `/execute` | 执行模式 | 最高 |
| `/review` | 审查模式 | 最高 |
| `/innovate` | 创新模式 | 最高 |
| `/status` | 查看状态 | 中等 |
| `/exit` | 退出模式 | 中等 |
| `/reset` | 重置模式 | 中等 |
| `/help` | 帮助查询 | 普通 |
| `/memory` | 更新开发记忆 | 普通 |
| `/doc` | 更新项目文档 | 普通 |
| `/code` | 代码审查 | 普通 |
| `/debug` | 问题诊断 | 普通 |
| `/summary` | 项目总结 | 普通 |
| `/check` | 综合验证检查 | 普通 |
| `/git` | Git提交辅助 | 普通 |
| `/rules` | 规则检查 | 普通 |

### 结构化模式

提供工作流程指导，帮助保持思维专注：

```bash
/research   # 研究模式 - 信息收集和深度理解
/innovate   # 创新模式 - 头脑风暴潜在方法
/plan       # 规划模式 - 制定详细计划
/execute    # 执行模式 - 精确实施规划内容
/review     # 审查模式 - 验证实施与计划的一致性
```

### 使用流程

```bash
# 典型开发任务流程
/research        # 1. 分析任务需求和技术约束
/innovate        # 2. 探索多种解决方案
/plan            # 3. 制定详细实施计划
/execute         # 4. 严格按照计划执行
/review          # 5. 验证实施结果
```

## 项目结构

```
cursor-guide/
├── .cursor/rules/          # Cursor 规则配置目录
│   ├── always/            # 始终应用规则
│   │   ├── core.mdc       # AI指令系统核心
│   │   ├── general.mdc    # 通用开发规范
│   │   └── git.mdc        # Git版本控制规范
│   ├── auto-select/       # 自动选择规则
│   │   ├── languages/     # 编程语言规则
│   │   │   ├── python.mdc     # Python开发规范
│   │   │   ├── typescript.mdc # TypeScript规范
│   │   │   └── nodejs.mdc     # Node.js开发规范
│   │   ├── frameworks/    # 框架规则
│   │   │   ├── react.mdc      # React开发规范
│   │   │   ├── vue.mdc        # Vue.js规范
│   │   │   ├── angular.mdc    # Angular规范
│   │   │   ├── nextjs.mdc     # Next.js规范
│   │   │   ├── flutter.mdc    # Flutter规范
│   │   │   └── springboot.mdc # Spring Boot规范
│   │   └── tools/         # 工具规则
│   │       └── tailwind.mdc   # Tailwind CSS规范
│   ├── agent/             # AI助手专用规则 (预留)
│   └── manual/            # 手动选择规则 (预留)
├── .docs/                 # 文档目录
│   └── 01-常用MCP安装配置.md # MCP 工具安装配置指南
├── LICENSE                # 开源协议
└── README.md              # 项目说明
```

## 重要说明

### 模板使用原则
- **保持模板状态**：所有规则文件保持通用模板格式，便于复用
- **按需定制**：复制到具体项目时，根据项目需求进行定制
- **记录使用经验**：在 `.docs/` 目录中记录使用技巧和配置方法

### 使用记录管理
- **经验积累**：记录Cursor IDE的使用经验和最佳实践
- **配置方法**：详细记录各种工具的安装和配置步骤
- **问题解决**：记录常见问题的解决方案和技巧

## 最佳实践

1. **模板复用**：将规则模板复制到新项目中，根据需求定制
2. **指令驱动**：通过 AI 指令系统提高开发效率
3. **MCP 集成**：充分利用 MCP 工具增强 AI 能力
4. **经验记录**：及时记录使用经验和配置方法
5. **持续更新**：根据使用情况持续完善规则模板和使用指南
6. **分享交流**：与团队分享使用技巧和最佳实践

## 最新更新

### 2025-08-07
- **项目结构更新**：根据实际目录结构更新了README.md
- **规则文件完善**：已完成所有核心规则文件的创建
  - 始终应用规则：core.mdc, general.mdc, git.mdc
  - 编程语言规则：python.mdc, typescript.mdc, nodejs.mdc
  - 框架规则：react.mdc, vue.mdc, angular.mdc, nextjs.mdc, flutter.mdc, springboot.mdc
  - 工具规则：tailwind.mdc
- **文档结构**：已创建.docs目录和MCP安装配置指南
- **目录结构完善**：添加了agent/和manual/预留目录，确保Git正确跟踪