sync-cursor-rules

sync-cursor-rules

CLI tool to copy rules from a configured repository to your local project.

Installation

npm install -g sync-cursor-rules

Configuration

Create a cursor-rules.json file in your project root with the following structure:

{
  "repoLink": "https://github.com/your-org/your-rules-repo.git",
  "rulesToImport": [
    "ciam-generic.mdc",
    "other-rule.mdc"
  ],
  "coderabbitRulesFileName": ".coderabbit.yaml"
}

Configuration Fields

• repoLink (required): Git repository URL containing the rules
• rulesToImport (required): Array of rule file names to copy from the repository
  • Use ["*"] to import all files from the rules directory
  • Or specify individual files: ["ciam-generic.mdc", "other-rule.mdc"]
• coderabbitRulesFileName (optional): Name of the coderabbit rules file to copy to project root

Defaults

The tool uses these defaults (you don't need to configure them):

• Rules directory in repository: rules (looks for rules in the rules/ folder)
• Local rules directory: .cursor/rules (copies rules to .cursor/rules/ in your project)

Usage

Quick Start

• Navigate to your project directory:

  cd /path/to/your-project
  

• Run the tool for the first time:

  sync-cursor-rules
  

  This will create cursor-rules.json with example placeholders in your project root.

• Edit the configuration file: Open cursor-rules.json and update it with your repository details:

  {
    "repoLink": "https://github.com/your-org/your-rules-repo.git",
    "rulesToImport": ["ciam-generic.mdc"],
    "coderabbitRulesFileName": ".coderabbit.yaml"
  }
  

  Tip: Use "rulesToImport": ["*"] to import all files from the rules directory automatically.

• Run the tool again to install the rules:

  sync-cursor-rules
  

The tool will:

• Clone or update the repository
• Copy specified rule files to your local rules directory
• Copy the coderabbit rules file (if specified) to project root
• Clean up temporary files

Complete Example

Here's a complete example of setting up rules in a new project:

# 1. Navigate to your project
cd ~/Projects/my-new-project

# 2. Run the tool - it creates the config file automatically
sync-cursor-rules

# Output:
# 📝 Config file not found: cursor-rules.json
#    Creating default config file...
# ✅ Created cursor-rules.json with example placeholders
#    Please update the configuration with your repository details.
#    Please edit cursor-rules.json and run the command again.

# 3. Edit the config file with your actual repository details
#    For example, if your rules are in: https://github.com/almamedia/sync-cursor-rules.git
#    Edit cursor-rules.json:
#    {
#      "repoLink": "https://github.com/almamedia/sync-cursor-rules.git",
#      "rulesToImport": ["ciam-generic.mdc"],
#      "coderabbitRulesFileName": ".coderabbit.yaml"
#    }
#    Or use ["*"] to import all files: "rulesToImport": ["*"]

# 4. Run the tool again to install the rules
sync-cursor-rules

# Output:
# 🧩 Setting up rules from repository...
# 📥 Cloning repository from https://github.com/almamedia/sync-cursor-rules.git...
# 📋 Copying rules files...
#    ✓ ciam-generic.mdc
#    ✓ .coderabbit.yaml
# ✅ Rules installed to: .cursor/rules

After running, your project will have:

• .cursor/rules/ciam-generic.mdc - Your cursor rules file
• .coderabbit.yaml - CodeRabbit configuration (if specified)
• cursor-rules.json - Configuration for future updates