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 (Experimental)

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

See Quick Start guide for more details.

Supported Tools and Features

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

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

Documentation

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

License

MIT License