Cursor 规则同步

一键同步远程 Cursor AI 规则，让团队协作更高效。

✨ 核心功能

🔄 自动同步 - 启动时自动检查并更新规则
📁 智能检测 - 自动发现并初始化 .cursor/rules 目录
🔧 Git 集成 - 基于 Git 的可靠版本控制
⚙️ 灵活配置 - 支持自定义仓库、分支和子目录
🎯 状态栏 - 一键查看规则状态

🚀 快速开始

本地安装

cd packages/cursor-plugin
npm install && npm run package

在 VSCode 中安装生成的 .vsix 文件：

按 Ctrl+Shift+P (Mac: Cmd+Shift+P)
输入 "Extensions: Install from VSIX"
选择生成的 .vsix 文件

⚙️ 配置

{
  "cursor-rules-sync.remoteRepository": "git@code.devops.xiaohongshu.com:fe/data-products/ai-infra.git",
  "cursor-rules-sync.remoteBranch": "master", 
  "cursor-rules-sync.remoteSubPath": ".cursor",
  "cursor-rules-sync.autoUpdate": true,
  "cursor-rules-sync.checkInterval": 24
}

配置项	类型	默认值	说明
`remoteRepository`	string	内置仓库地址	远程规则仓库 URL
`remoteBranch`	string	`master`	同步分支
`remoteSubPath`	string	`.cursor`	子目录路径
`autoUpdate`	boolean	`true`	自动更新开关
`checkInterval`	number	`24`	检查间隔(小时)

📋 命令

更新规则 (cursor-rules-sync.updateRules) - 手动更新规则
检查状态 (cursor-rules-sync.checkRuleStatus) - 查看当前状态

通过命令面板 (Ctrl+Shift+P) 或状态栏访问。

🔧 工作原理

首次使用

插件激活时检查 .cursor/rules 目录
如不存在则自动克隆远程仓库并提取指定子目录
显示初始化状态

自动更新

每次启动时检查更新（可配置）
浅克隆远程仓库到临时目录
对比本地与远程内容差异
静默更新并清理临时文件

目录结构

工作区/
├── .cursor/              ← 同步目标
│   └── rules/
│       ├── basic/
│       ├── modules/
│       └── README.md
└── ...

🛠️ 开发

环境要求: Node.js ≥ 18, VSCode ≥ 1.77.0

# 开发模式
npm run watch

# 构建发布
npm run package

# 测试
npm test

🐛 常见问题

Q: 更新后规则目录为空？ A: 检查仓库 URL 配置是否正确

Q: 自动更新未生效？ A: 确认 autoUpdate 设置为 true

Q: Git 认证失败？ A: 检查本地 Git 凭据配置

开启开发者工具 (Help > Toggle Developer Tools) 查看详细日志。

📝 更新日志

1.0.0

🎉 首发版本
✅ 自动规则同步
✅ Git 集成支持
✅ 状态栏集成
✅ 灵活配置选项

基于 MIT 许可证开源

LittleRuleShu

jiangshuo08