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

Tool	--targets	rules	ignore	mcp	commands	subagents	skills	hooks	permissions
AGENTS.md	agentsmd	✅			🎮	🎮	🎮
AgentsSkills	agentsskills						✅
Claude Code	claudecode	✅ 🌏	✅	✅ 🌏	✅ 🌏	✅ 🌏	✅ 🌏	✅ 🌏	✅ 🌏
Codex CLI	codexcli	✅ 🌏		✅ 🌏 🔧	🌏	✅ 🌏	✅ 🌏	✅ 🌏	✅ 🌏
Gemini CLI	geminicli	✅ 🌏	✅	✅ 🌏	✅ 🌏	✅	✅ 🌏	✅ 🌏	✅ 🌏
Goose	goose	✅ 🌏	✅
GitHub Copilot	copilot	✅ 🌏		✅	✅	✅	✅	✅
GitHub Copilot CLI	copilotcli	✅ 🌏		✅ 🌏		✅ 🌏		✅ 🌏
Cursor	cursor	✅	✅	✅ 🌏	✅ 🌏	✅ 🌏	✅ 🌏	✅ 🌏	✅ 🌏
deepagents-cli	deepagents	✅		✅ 🌏		✅	✅	🌏
Factory Droid	factorydroid	✅ 🌏		✅ 🌏	🎮	🎮	🎮	✅ 🌏
OpenCode	opencode	✅ 🌏		✅ 🌏 🔧	✅ 🌏	✅ 🌏	✅ 🌏	✅ 🌏	✅ 🌏
Cline	cline	✅	✅	✅	✅ 🌏		✅ 🌏		✅
Kilo Code	kilo	✅ 🌏	✅	✅	✅ 🌏		✅ 🌏		✅ 🌏
Roo Code	roo	✅	✅	✅	✅	🎮	✅ 🌏
Rovodev (Atlassian)	rovodev	✅ 🌏		🌏		✅ 🌏	✅ 🌏
Takt	takt	✅ 🌏			✅ 🌏	✅ 🌏	✅ 🌏
Qwen Code	qwencode	✅	✅						✅ 🌏
Kiro	kiro	✅	✅	✅	✅	✅	✅		✅
Google Antigravity	antigravity	✅			✅		✅ 🌏
JetBrains Junie	junie	✅	✅	✅	✅ 🌏	✅	✅
AugmentCode	augmentcode	✅	✅						✅ 🌏
Windsurf	windsurf	✅	✅				✅ 🌏
Warp	warp	✅
Replit	replit	✅					✅
Pi Coding Agent	pi	✅ 🌏			✅ 🌏		✅ 🌏
Zed	zed		✅

• ✅: Supports project mode
• 🌏: Supports global mode
• 🎮: Supports simulated commands/subagents/skills (Project mode only)
• 🔧: Supports MCP tool config (enabledTools/disabledTools)

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