Show HN: rulesync – CLI for bulk rule management across multiple AI coding tools

6 hours ago 2

CI npm version

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 | 日本語

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)
  • Roo Code Rules (.roo/rules/*.md + .roo/instructions.md)
  • Gemini CLI (GEMINI.md + .gemini/memories/*.md)
npm install -g rulesync # or pnpm add -g rulesync # or yarn global add rulesync
  1. Initialize your project:

  2. Edit the generated rule files in .rulesync/ directory to match your project needs

    Or add new rule files:

    npx rulesync add my-custom-rules
  3. Generate tool-specific configuration files:

  4. Optional: Add generated files to .gitignore:

Existing Project with AI Tool Configurations

If you already have AI tool configurations, you can import them into rulesync format:

  1. Import existing configurations:

    # Import from multiple tools at once npx rulesync import --claudecode --cursor --copilot # Or import from specific tools npx rulesync import --claudecode # From CLAUDE.md and .claude/memories/*.md npx rulesync import --cursor # From .cursorrules and .cursor/rules/*.mdc npx rulesync import --copilot # From .github/copilot-instructions.md npx rulesync import --cline # From .cline/instructions.md npx rulesync import --roo # From .roo/instructions.md npx rulesync import --geminicli # From GEMINI.md and .gemini/memories/*.md
  2. Review and edit the imported rules in .rulesync/ directory

  3. Generate unified configurations:

That's it! Your AI coding assistants will now use the generated configuration files automatically.

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.

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
  • Gemini CLI for intelligent code analysis

Avoid vendor lock-in completely. If you decide to stop using rulesync, you can continue using the generated rule files (.github/instructions/, .cursor/rules/, .clinerules/, CLAUDE.md, GEMINI.md, etc.) as-is.

🎯 Consistency Across Tools

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

Creating Custom Slash Commands

Instead of using Claude Code's built-in /init command, we recommend creating a custom slash command specifically for rulesync.

Refer to the Claude Code slash commands documentation and add the following custom command:

.claude/commands/init-rulesync.md

Review this project's content and update .rulesync/*.md files as needed. Steps: 1. Analyze project structure and codebase 2. Review existing .rulesync/ files 3. Consider project's tech stack, architecture, and coding conventions 4. Update .rulesync/*.md files if missing elements or improvements are found 5. Run rulesync generate if necessary Project characteristics to consider: - Technology stack - Architecture patterns - Coding conventions - Security requirements - Performance considerations
  • Project-Specific Initialization: Optimized rule configuration for each project
  • Automatic Rule Updates: Rules adapt to project changes automatically
  • Team Standardization: All members use the same rule set
  • Continuous Improvement: Rules evolve with project growth

This creates a .rulesync/ directory with sample rule files.

Define metadata in front matter for each Markdown file in the .rulesync/ directory. See the Example Files section below for detailed examples.

rulesync uses a two-level rule system:

  • root: true: Project-wide overview and policies
    • Only one root file is allowed per project
    • Contains high-level guidelines and project context
  • root: false: Specific implementation rules and detailed guidelines
    • Multiple non-root files are allowed
    • Contains specific coding rules, naming conventions, etc.

Each AI tool handles rule levels differently:

Tool Root Rules Non-Root Rules Special Behavior
Claude Code ./CLAUDE.md .claude/memories/*.md CLAUDE.md includes @filename references to detail files
Cursor ruletype: always ruletype: autoattached Detail rules without globs use ruletype: agentrequested
GitHub Copilot Standard format Standard format All rules use same format with frontmatter
Cline Standard format Standard format All rules use plain Markdown format
Roo Code Standard format Standard format All rules use plain Markdown format with description header
Gemini CLI GEMINI.md .gemini/memories/*.md GEMINI.md includes @filename references to memory files

3. Generate Configuration Files

# Generate for all tools npx rulesync generate # Generate for specific tools npx rulesync generate --copilot npx rulesync generate --cursor npx rulesync generate --cline npx rulesync generate --claudecode npx rulesync generate --roo npx rulesync generate --geminicli # Clean build (delete existing files first) npx rulesync generate --delete # Clean build for specific tools npx rulesync generate --copilot --cursor --delete # Verbose output npx rulesync generate --verbose npx rulesync generate --delete --verbose # Generate in specific base directories (monorepo support) npx rulesync generate --base-dir ./packages/frontend npx rulesync generate --base-dir ./packages/frontend,./packages/backend npx rulesync generate --base-dir ./apps/web,./apps/api,./packages/shared
  • --delete: Remove all existing generated files before creating new ones
  • --verbose: Show detailed output during generation process
  • --copilot, --cursor, --cline, --claudecode, --roo, --geminicli: Generate only for specified tools
  • --base-dir <paths>: Generate configuration files in specified base directories (comma-separated for multiple paths). Useful for monorepo setups where you want to generate tool-specific configurations in different project directories.

4. Import Existing Configurations

If you already have AI tool configurations in your project, you can import them to rulesync format:

# Import from existing AI tool configurations npx rulesync import --claudecode # Import from CLAUDE.md and .claude/memories/*.md npx rulesync import --cursor # Import from .cursorrules and .cursor/rules/*.md npx rulesync import --copilot # Import from .github/copilot-instructions.md and .github/instructions/*.instructions.md npx rulesync import --cline # Import from .cline/instructions.md npx rulesync import --roo # Import from .roo/instructions.md npx rulesync import --geminicli # Import from GEMINI.md and .gemini/memories/*.md # Import from multiple tools npx rulesync import --claudecode --cursor --copilot # Verbose output during import npx rulesync import --claudecode --verbose

The import command will:

  • Parse existing configuration files from each AI tool using custom parsers
  • Convert them to rulesync format with appropriate frontmatter metadata
  • Create new .rulesync/*.md files with imported content and proper rule categorization
  • Use tool-specific prefixes to avoid filename conflicts (e.g., claudecode-overview.md, cursor-custom-rules.md)
  • Generate unique filenames if conflicts occur
  • Support complex formats like Cursor's MDC files with YAML frontmatter
  • Handle multiple file imports (e.g., all files from .claude/memories/ directory)
# Initialize project with sample files npx rulesync init # Add a new rule file npx rulesync add <filename> npx rulesync add typescript-rules npx rulesync add security.md # .md extension is automatically handled # Validate rule files npx rulesync validate # Check current status npx rulesync status # Watch files and auto-generate npx rulesync watch # Add generated files to .gitignore npx rulesync gitignore

Configuration File Structure

.rulesync/ ├── overview.md # Project overview (root: true, only one) ├── coding-rules.md # Coding rules (root: false) ├── naming-conventions.md # Naming conventions (root: false) ├── architecture.md # Architecture guidelines (root: false) ├── security.md # Security rules (root: false) └── custom.md # Project-specific rules (root: false)

Each rule file must include frontmatter with the following fields:

--- root: true | false # Required: Rule level (true for overview, false for details) targets: ["*"] # Required: Target tools (* = all, or specific tools) description: "Brief description" # Required: Rule description globs: "**/*.ts,**/*.js" # Required: File patterns (comma-separated or empty string) ---

Root file (.rulesync/overview.md):

--- root: true targets: ["*"] description: "Project overview and development philosophy" globs: "src/**/*.ts" --- # Project Development Guidelines This project follows TypeScript-first development with clean architecture principles.

Non-root file (.rulesync/coding-rules.md):

--- root: false targets: ["copilot", "cursor", "roo"] description: "TypeScript coding standards" globs: "**/*.ts,**/*.tsx" --- # TypeScript Coding Rules - Use strict TypeScript configuration - Prefer interfaces over types for object shapes - Use meaningful variable names

Generated Configuration Files

Tool Output Path Format Rule Level Handling
GitHub Copilot .github/instructions/*.instructions.md Front Matter + Markdown Both levels use same format
Cursor .cursor/rules/*.mdc MDC (YAML header + Markdown) Root: ruletype: always
Non-root: ruletype: autoattached
Non-root without globs: ruletype: agentrequested
Cline .clinerules/*.md Plain Markdown Both levels use same format
Claude Code ./CLAUDE.md (root)
.claude/memories/*.md (non-root)
Plain Markdown Root goes to CLAUDE.md
Non-root go to separate memory files
CLAUDE.md includes @filename references
Roo Code .roo/rules/*.md Plain Markdown Both levels use same format with description header
Gemini CLI GEMINI.md (root)
.gemini/memories/*.md (non-root)
Plain Markdown Root goes to GEMINI.md
Non-root go to separate memory files
GEMINI.md includes @filename references

rulesync validates your rule files and provides helpful error messages:

Common validation rules:

  • Only one root file (root: true) is allowed per project
  • All frontmatter fields are required and properly formatted
  • File patterns (globs) use valid syntax
  • Target tools are recognized values

MIT License

Issues and Pull Requests are welcome!

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

Read Entire Article