Package Exports

rulesync
rulesync/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (rulesync) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

rulesync

A Node.js CLI tool that automatically generates configuration files for various AI development tools from unified AI rule files (.rulesync/*.md). Also imports existing AI tool configurations into the unified format.

English | 日本語

Installation

npm install -g rulesync
# or
pnpm add -g rulesync
# or  
yarn global add rulesync

Getting Started

New Project

Initialize your project:
```
npx rulesync init
```
Edit the generated rule files in .rulesync/ directory to match your project needs
Generate tool-specific configuration files:
```
npx rulesync generate
```

Existing Project

If you already have AI tool configurations:

# Import existing configurations
npx rulesync import --claudecode  # From CLAUDE.md
npx rulesync import --cursor      # From .cursorrules
npx rulesync import --copilot     # From .github/copilot-instructions.md

# Generate unified configurations
npx rulesync generate

Supported Tools

rulesync supports both generation and import for the following AI development tools:

GitHub Copilot Custom Instructions (.github/copilot-instructions.md + .github/instructions/*.instructions.md)
Cursor Project Rules (.cursor/rules/*.mdc + .cursorrules)
Cline Rules (.clinerules/*.md + .cline/instructions.md)
Claude Code Memory (./CLAUDE.md + .claude/memories/*.md + Custom Slash Commands .claude/commands/*.md)
OpenAI Codex CLI (codex.md + .codex/mcp-config.json + .codexignore)
AugmentCode Rules (.augment/rules/*.md)
Roo Code Rules (.roo/rules/*.md + .roo/instructions.md)
Gemini CLI (GEMINI.md + .gemini/memories/*.md + Custom Slash Commands .gemini/commands/*.md)
JetBrains Junie Guidelines (.junie/guidelines.md)
Kiro IDE Custom Steering Documents (.kiro/steering/*.md) + AI Ignore Files (.aiignore)
Windsurf AI Code Editor (.windsurf/rules/*.md + .windsurf/mcp.json + .codeiumignore)

Why rulesync?

🔧 Tool Flexibility

Team members can freely choose their preferred AI coding tools. Whether it's GitHub Copilot, Cursor, Cline, or Claude Code, each developer can use the tool that maximizes their productivity.

📈 Future-Proof Development

AI development tools evolve rapidly with new tools emerging frequently. With rulesync, switching between tools doesn't require redefining your rules from scratch.

🎯 Multi-Tool Workflow

Enable hybrid development workflows combining multiple AI tools:

GitHub Copilot for code completion
Cursor for refactoring
Claude Code for architecture design
Cline for debugging assistance
Windsurf for comprehensive AI-assisted editing

🔓 No Vendor Lock-in

Avoid vendor lock-in completely. If you decide to stop using rulesync, you can continue using the generated rule files as-is.

🎯 Consistency Across Tools

Apply consistent rules across all AI tools, improving code quality and development experience for the entire team.

Quick Commands

# Initialize new project
npx rulesync init

# Add new rule file
npx rulesync add typescript-rules

# Validate rules
npx rulesync validate

# Generate configurations
npx rulesync generate

# Import from existing tools
npx rulesync import --cursor

# Watch for changes
npx rulesync watch

# Show project status
npx rulesync status

# Add generated files to .gitignore
npx rulesync gitignore

Documentation

📖 Core Documentation

Commands Reference - Complete CLI commands guide
Configuration Guide - Rule files and configuration options

🛠️ Tool Integrations

Claude Code - Memory system and custom commands
Cursor - Rule types and MDC format
GitHub Copilot - Custom instructions
Cline - Plain Markdown rules
OpenAI Codex CLI - Hierarchical memory system
Gemini CLI - Memory and commands
Windsurf - Rules and Cascade AI
JetBrains Junie - Guidelines and IDE integration
Kiro IDE - Custom steering documents
AugmentCode - Rule types and configuration
Roo Code - Instructions and rules

⚡ Features

Custom Slash Commands - Create unified commands for Claude Code and Gemini CLI
MCP Integration - Model Context Protocol server configuration
Import System - Import existing AI tool configurations
Rule Validation - Validate rule files and configuration

📚 Guides

Getting Started - Comprehensive setup guide
Best Practices - Proven strategies and patterns
Migration Guide - Migrate from existing AI tool configurations
Troubleshooting - Common issues and solutions
Real-World Examples - Practical implementation examples

License

MIT License

Contributing

Issues and Pull Requests are welcome!

For development setup and contribution guidelines, see CONTRIBUTING.md.