Rulesync

Documentation | npm

A Node.js CLI tool that automatically generates configuration files for various AI development tools from unified AI rule files. Features selective generation, comprehensive import/export capabilities, and supports major AI development tools with rules, commands, MCP, ignore files, subagents and skills.

Note

If you are interested in Rulesync latest news, please follow the maintainer's X(Twitter) account: @dyoshikawa1993

Installation

npm install -g rulesync
# or
brew install rulesync

Single Binary

curl -fsSL https://github.com/dyoshikawa/rulesync/releases/latest/download/install.sh | bash

See Installation docs for manual install and platform-specific instructions.

Getting Started

# Create necessary directories, sample rule files, and configuration file
rulesync init

# Install official skills (recommended)
rulesync fetch dyoshikawa/rulesync --features skills

# Generate unified configurations with all features
rulesync generate --targets "*" --features "*"

If you already have AI tool configurations:

# Import existing files (to .rulesync/**/*)
rulesync import --targets claudecode    # From CLAUDE.md
rulesync import --targets cursor        # From .cursorrules
rulesync import --targets copilot       # From .github/copilot-instructions.md

Want to convert configuration from one AI tool to another directly, without adopting the .rulesync/ source-of-truth workflow?

# Convert Cursor rules to Copilot and Claude Code in one shot (no .rulesync/ files written)
rulesync convert --from cursor --to copilot,claudecode

See Quick Start guide for more details.

Supported Tools and Features

The tables below show whether each tool supports a given feature (✅ = supported, blank = not supported). For each tool's --targets value and mode details (project / global / simulated), see the Supported Tools reference.

AI Coding Tools

Tool	rules	ignore	mcp	commands	subagents	skills	hooks	permissions
Amp			✅
Claude Code	✅	✅	✅	✅	✅	✅	✅	✅
Codex CLI	✅		✅	✅	✅	✅	✅	✅
Gemini CLI ⚠️	✅	✅	✅	✅	✅	✅	✅	✅
Goose	✅	✅
GitHub Copilot	✅		✅	✅	✅	✅	✅
GitHub Copilot CLI	✅		✅		✅		✅
Cursor	✅	✅	✅	✅	✅	✅	✅	✅
deepagents-cli	✅		✅		✅	✅	✅
Factory Droid	✅		✅	✅	✅	✅	✅
OpenCode	✅		✅	✅	✅	✅	✅	✅
Cline	✅	✅	✅	✅		✅		✅
Kilo Code	✅	✅	✅	✅	✅	✅	✅	✅
Roo Code	✅	✅	✅	✅	✅	✅
Rovodev (Atlassian)	✅		✅		✅	✅
Takt	✅			✅	✅	✅
Qwen Code	✅	✅						✅
Kiro	✅	✅	✅	✅	✅	✅	✅	✅
Google Antigravity IDE	✅		✅	✅		✅	✅
Google Antigravity CLI	✅		✅			✅	✅	✅
Google Antigravity ⚠️	✅			✅		✅
JetBrains Junie	✅	✅	✅	✅	✅	✅
AugmentCode	✅	✅						✅
Windsurf	✅	✅				✅
Warp	✅
Replit	✅					✅
Pi Coding Agent	✅			✅		✅
Zed	✅	✅	✅			✅

Open Standards

Standard	rules	ignore	mcp	commands	subagents	skills	hooks	permissions
AGENTS.md	✅			✅	✅	✅
Agent Skills						✅

• ⚠️: Deprecated — still supported, but see the note below

Deprecation notes

• Gemini CLI (geminicli) — Google is retiring Gemini CLI on June 18, 2026, when it stops serving requests for Google AI Pro/Ultra and free Gemini Code Assist for individuals (Enterprise plans are unaffected). The successor is the Antigravity CLI (antigravity-cli). geminicli is not removed from rulesync — Enterprise access continues and existing GEMINI.md/.gemini/ repositories still rely on it — but new projects should prefer antigravity-cli. See the Gemini CLI → Antigravity CLI migration guide.
• Google Antigravity (antigravity) — Antigravity 2.0 splits into two products with separate global config trees: the desktop antigravity-ide and the antigravity-cli (agy). The legacy antigravity target is now a deprecated alias for antigravity-ide that keeps its original .agent/ (singular) paths for backward compatibility. Migrate to antigravity-ide (desktop IDE) or antigravity-cli (CLI).

Some features accept per-feature options (e.g., Claude Code's ignore feature supports fileMode: "local" to write to settings.local.json instead of settings.json). See Configuration > Per-feature options for details.

Documentation

For full documentation including configuration, CLI reference, file formats, programmatic API, and more, visit the documentation site.

License

MIT License