| name | rulesync |
| description | Generates and syncs AI rule configuration files (.cursorrules, CLAUDE.md, copilot-instructions.md) across 20+ coding tools from a single source. Use when syncing AI rules, running rulesync commands, importing or generating rule files, or managing shared AI coding configurations. |
| targets | ["*"] |
Rulesync
Rulesync generates and synchronizes AI rule configuration files across 20+ coding tools (Claude Code, Cursor, Copilot, Windsurf, Cline, Gemini CLI, and more) from a single set of unified rule files in .rulesync/.
Quick Start
npm install -g rulesync
rulesync init
rulesync import --targets claudecode
rulesync import --targets cursor
rulesync import --targets copilot
rulesync generate --targets "*" --features "*"
Core Workflow
- Init -
rulesync init creates rulesync.jsonc config and .rulesync/ directory with sample rules
- Write rules - Add shared AI rules in
.rulesync/rules/, MCP configs in .rulesync/mcp/, commands in .rulesync/commands/
- Generate -
rulesync generate produces tool-specific files (CLAUDE.md, .cursorrules, .github/copilot-instructions.md, etc.)
- Verify -
rulesync generate --dry-run previews changes; --check validates files are up to date (useful in CI)
Key Commands
| Command | Purpose |
|---|
rulesync init | Scaffold project with config and sample rules |
rulesync generate --targets "*" --features "*" | Generate all tool configs from unified rules |
rulesync import --targets <tool> | Import existing tool config into unified format |
rulesync fetch owner/repo --features skills | Fetch rules or skills from a remote repository |
rulesync install | Install skill sources declared in rulesync.jsonc |
rulesync generate --check | CI check that generated files are up to date |
rulesync generate --dry-run | Preview changes without writing files |
Detailed Reference
- Installation, Quick Start
- Why Rulesync?, Configuration, Global Mode, Separate Input Root, Simulated Features, Declarative Sources, Official Skills, Gemini CLI → Antigravity CLI, Dry Run, Case Studies
- Supported Tools, CLI Commands, File Formats, Command Syntax, MCP Server
- Programmatic API
- FAQ