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 install from our Homebrew tap (macOS and Linux):

brew tap dyoshikawa/rulesync https://github.com/dyoshikawa/rulesync
brew install rulesync

The tap lives inside this repository, so it does not have a homebrew- prefix. The two-argument brew tap <name> <url> form is therefore required — the shorthand brew install dyoshikawa/rulesync/rulesync without tapping first does not work.

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

# 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

Tool	rules	ignore	mcp	commands	subagents	skills	hooks	permissions	checks
Amp	✅		✅			✅	✅	✅	✅
IBM Bob	✅	✅	✅	✅	✅	✅	✅	✅
Claude Code	✅	✅	✅	✅	✅	✅	✅	✅
Claude Code plugin			✅	✅	✅	✅	✅
CodeBuddy Code	✅		✅	✅	✅	✅	✅	✅
Codewhale	✅		✅	✅	✅	✅	✅	✅
Codex CLI	✅		✅	✅	✅	✅	✅	✅

Open Standards

Tool	rules	ignore	mcp	commands	subagents	skills	hooks	permissions	checks
AGENTS.md	✅			✅	✅	✅
AgentsSkills						✅

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

Target and deprecation notes

• Ignore feature — The ignore feature is deprecated in favor of the more expressive permissions feature. Existing ignore configurations remain supported throughout Rulesync 14.x; removal, if any, will be decided separately and will not occur before a future major release. New rulesync init projects scaffold permissions without enabling or creating ignore files. See the migration guide.
• 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/. In --global mode, both targets write the root rule to ~/.gemini/GEMINI.md and each non-root rule to its own file in the shared ~/.gemini/config/rules/ (with trigger frontmatter, identical for the two targets), so each rule gets Antigravity's 24,000-byte per-file limit to itself; generate --delete never removes files from that shared directory.
• Plugin packaging (claudecode-plugin / antigravity-plugin / augmentcode-plugin / zcode-plugin / vibe-plugin / devin-plugin / kimi-code-plugin) — These project-only targets generate and import Rulesync-managed components inside an existing plugin directory selected with --output-roots (generate) or --output-root (import). They are excluded from --targets "*" to avoid writing package-level skills/, rules/, or commands/ directories into ordinary projects. Rulesync preserves plugin manifests, marketplace metadata, scripts, and other non-component assets; the only manifest it writes is a missing Antigravity plugin.json, which Antigravity needs to load the plugin at all. See the .

Some features accept per-feature options. 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