cursor-rule/README.md

CLI工具用于自动生成Cursor项目规则

# Cursor-CLI

自动生成Cursor项目规则的命令行工具，旨在统一团队开发规范，提高AI编程场景下的精准度。

## 功能特点

- 自动检测项目技术栈并生成相应规则
- 支持手动指定开发语言生成规则
- 生成三类规则文件：
  - general.mdc: 通用项目规则（RuleType: Always）
  - [语言].mdc: 特定语言规则（RuleType: Auto Attached）
  - document.mdc: 文档规范（RuleType: Auto Attached）

## 安装

### 使用npm安装

```bash
npm install -g cursor-rule
```

## 使用方法

### 在项目中自动生成规则

```bash
# 自动检测项目类型
cursor-rule init

# 指定开发语言
cursor-rule init --lang=javascript
```

### 查看支持的语言列表

```bash
cursor-rule list-langs
```

### 显示帮助信息

```bash
cursor-rule --help
```

## 生成的规则

工具会在项目目录下的`.cursor/rules`目录中生成以下文件：

1. **general.mdc**: 包含项目的基本信息和通用规范，对所有聊天框生效
2. **[语言].mdc**: 特定语言的编码规范和最佳实践
3. **document.mdc**: 文档文件的编写规范

## 定制规则模板

您可以在`src/templates`目录中添加或修改规则模板，支持以下文件：

- general.template.mdc: 通用规则模板
- [语言].template.mdc: 特定语言规则模板
- document.template.mdc: 文档规则模板

## 支持的语言

- JavaScript
- TypeScript
- Python
- Java
- Go
- Rust
- C#
- C++
- PHP
- Ruby
- Swift
- Kotlin
- Dart

## 贡献指南

欢迎贡献代码、报告问题或提出改进建议。

## 许可证

MIT