@qile-c/cursor-rules-cli
v1.0.2
Published
Cursor Rules 智能管理工具 - 一款用于生成、管理和优化 Cursor IDE AI 协作规范的命令行工具
Downloads
2
Maintainers
qile-cReadme
Cursor Rules CLI
Cursor Rules 智能管理工具 - 一键生成、管理和优化 Cursor IDE AI 协作规范
✨ 特性
- 🚀 一键初始化 - 自动检测项目类型，生成最适合的规则配置
- 🎯 智能推荐 - 基于项目依赖和技术栈推荐最佳实践规则
- 📦 模板丰富 - 内置 React、Vue、TypeScript、Node.js 等主流技术栈模板
- 🔧 高度可配置 - 支持自定义模板和全局配置
- 🌍 多语言支持 - 支持中文和英文界面
- 📋 标准化 - 遵循最新的 Cursor Rules 规范和最佳实践
🗂️ 核心模块说明
CLI 命令层
- cli.ts - 主入口，定义所有可用命令
- commands/ - 各个命令的具体实现逻辑
核心业务层
- detector/ - 智能检测项目类型、框架、依赖
- generator/ - 根据模板和配置生成规则文件
- validator/ - 验证生成的规则文件格式和完整性
- updater/ - 管理规则版本更新和同步
模板系统
- templates/ - 内置的各种技术栈规则模板
- 支持动态加载和自定义模板扩展
工具层
- utils/ - 配置管理、文件操作等通用工具
- types/ - 完整的 TypeScript 类型定义
🚀 快速开始
安装
# 使用 npm
npm install -g @qile-c/cursor-rules-cli
# 使用 yarn
yarn global add @qile-c/cursor-rules-cli
# 使用 pnpm
pnpm add -g @qile-c/cursor-rules-cli初始化项目规则
# 在项目根目录运行
cursor-rules initCLI 会自动：
- 检测你的项目类型（React、Vue、Node.js 等）
- 推荐合适的规则模板
- 交互式选择需要的规则
- 生成标准化的
.cursor/rules目录结构
📖 使用指南
基础命令
# 初始化项目规则
cursor-rules init
# 使用指定模板初始化
cursor-rules init --template=react
# 非交互模式（使用推荐模板）
cursor-rules init --no-interactive
# 强制覆盖已存在的规则
cursor-rules init --force管理规则
# 查看所有可用规则
cursor-rules list
# 添加特定规则
cursor-rules add typescript
cursor-rules add react
# 强制覆盖已存在的规则
cursor-rules add typescript --force配置管理
# 查看当前配置
cursor-rules config
# 设置配置项
cursor-rules config --set language=zh
cursor-rules config --set autoUpdate=false
# 获取配置项
cursor-rules config --get language
# 重置为默认配置
cursor-rules config --reset📁 生成的项目结构
.cursor/
└── rules/
├── basic/ # 基础规则（必须调用）
│ ├── general.mdc # 通用编程规范
│ └── typescript.mdc # TypeScript 规范
├── modules/ # 模块规则（按需调用）
│ ├── react.mdc # React 开发规范
│ └── testing.mdc # 测试规范
├── workflow/ # 流程规则（按需调用）
│ └── crud.mdc # CRUD 操作规范
└── ai.mdc # AI 协作执行规则🎯 支持的模板
基础模板
- basic - 通用编程基础规范
- typescript - TypeScript 开发规范
前端框架
- react - React 开发最佳实践
- vue - Vue.js 开发规范
- angular - Angular 开发指南
- next - Next.js 项目规范
- nuxt - Nuxt.js 项目规范
后端框架
- node - Node.js 开发规范
- express - Express.js 最佳实践
工具和测试
- testing - 测试框架规范
- eslint - ESLint 配置规范
- prettier - 代码格式化规范
⚙️ 配置选项
全局配置
{
"preferredTemplates": ["basic", "typescript"],
"autoUpdate": true,
"language": "zh",
"registryUrl": "https://api.cursor-rules.com",
"customTemplatePath": "/path/to/custom/templates"
}项目配置
在项目根目录创建 .cursor-rules.json:
{
"templates": ["basic", "react", "typescript"],
"customRules": {
"react": {
"strictMode": true,
"hooksLinting": true
}
}
}🛠️ 开发
本地开发
# 克隆项目
git clone https://github.com/Bourne115/busy-cursor-rules.git
cd busy-cursor-rules
# 安装依赖
pnpm install
# 设置Git钩子
pnpm run prepare
# 开发模式运行
pnpm run dev
# 构建
pnpm build
# 运行测试
pnpm test工程化功能
本项目配备了完整的工程化工具链：
代码规范
- ESLint - 代码质量检查
- Prettier - 代码格式化
- TypeScript - 类型检查
- simple-git-hooks - Git钩子管理
- lint-staged - 提交前检查
# 代码格式化
pnpm run format
# 代码质量检查
pnpm run lint
# 修复可修复的问题
pnpm run lint:fix
# 类型检查
pnpm run type-checkGit提交规范
项目使用 Conventional Commits 规范：
# 使用交互式提交工具
pnpm run commit
# 手动提交示例
git commit -m "feat: add new template support"
git commit -m "fix: resolve config parsing issue"
git commit -m "docs: update installation guide"自动化发版
# 补丁版本 (1.0.0 -> 1.0.1)
pnpm run release:patch
# 小版本 (1.0.0 -> 1.1.0)
pnpm run release:minor
# 大版本 (1.0.0 -> 2.0.0)
pnpm run release:majorCI/CD流程
- 持续集成 - 自动运行测试、代码检查、构建验证
- 持续部署 - 自动发布到npm、创建GitHub Release
- 多版本测试 - 支持Node.js 16.x、18.x、20.x
- 安全审计 - 依赖包安全检查
详细的工程化指南请查看 工程化指南。
贡献指南
我们欢迎所有形式的贡献！请查看 贡献指南 了解更多信息。
贡献流程
- Fork 项目
- 创建功能分支 (
git checkout -b feature/AmazingFeature) - 遵循代码规范和提交规范
- 提交更改 (
pnpm run commit或手动规范提交) - 推送到分支 (
git push origin feature/AmazingFeature) - 打开 Pull Request
开发规范
- 提交前会自动运行代码检查和格式化
- 所有新功能需要包含测试
- 提交信息必须遵循Conventional Commits规范
- Pull Request会自动触发CI检查
📝 更新日志
查看 CHANGELOG.md 了解详细的版本更新记录。
🤝 社区
- GitHub Discussions - 讨论和问答
- Issues - 报告 Bug 和功能请求
- Wiki - 详细文档和教程
📄 许可证
本项目采用 MIT 许可证 - 查看 LICENSE 文件了解详情。
🙏 致谢
- 感谢 Cursor 团队提供优秀的 AI 编程工具
- 感谢社区贡献者提供的规则模板和反馈
- 参考了 awesome-cursor-rules 项目