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). A ✅ means the feature is supported in at least one mode (project, global, or simulated) — for example, Codex CLI commands is global-only. For each tool's --targets value and full mode breakdown (project / global / simulated / MCP tool config), see the Supported Tools reference.

AI Coding Tools

Open Standards

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

Deprecation notes

• Google Antigravity (antigravity-ide / antigravity-cli) — Antigravity 2.0 splits into two products with separate global config trees: the desktop antigravity-ide and the antigravity-cli (agy). For project-scope rules, both antigravity-ide and antigravity-cli emit the root rule as a plain cross-tool AGENTS.md at the project root (the Gemini-lineage discovery order is AGENTS.md, CONTEXT.md, GEMINI.md; the IDE has read AGENTS.md since v1.20.3) and non-root rules under .agents/rules/.
• Kiro (kiro) — Kiro's IDE and CLI use diverging config formats (IDE: Markdown subagents .kiro/agents/*.md and structured JSON hooks .kiro/hooks/*.json; CLI: JSON agent-config subagents .kiro/agents/*.json and hooks in .kiro/agents/default.json), so kiro is split into kiro-cli and kiro-ide. The legacy kiro target remains as a deprecated alias with its current behavior unchanged. The two targets share every surface except subagents (Markdown vs JSON) and hooks; Kiro IDE hooks are emitted as a single .kiro/hooks/rulesync.json ({ "version": "v1", "hooks": [ ... ] }) in project (.kiro/hooks/) and global (~/.kiro/hooks/) scope, while the CLI uses .kiro/agents/default.json. Global skills (~/.kiro/skills/) and global Kiro IDE subagents (~/.kiro/agents/) are supported too, as are global Kiro CLI commands (~/.kiro/prompts/) and subagents (~/.kiro/agents/).

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