rulesync
installs/mo · npmstarsforks
How to install rulesync?
dyoshikawa/rulesync
$git clone https://github.com/dyoshikawa/rulesync[Documentation](https://dyoshikawa.github.io/rulesync/) | [npm](https://www.npmjs.com/package/rulesync)
README.md
| 1 | <p align="center"> |
| 2 | <img src="images/logo.jpg" alt="Rulesync Logo" width="600"> |
| 3 | </p> |
| 4 | |
| 5 | # Rulesync |
| 6 | |
| 7 | [](https://github.com/dyoshikawa/rulesync/actions/workflows/ci.yml) |
| 8 | [](https://www.npmjs.com/package/rulesync) |
| 9 | [](https://www.npmjs.com/package/rulesync) |
| 10 | [](https://deepwiki.com/dyoshikawa/rulesync) |
| 11 | [](https://github.com/hesreallyhim/awesome-claude-code) |
| 12 | [](https://github.com/Piebald-AI/awesome-gemini-cli) |
| 13 | <a href="https://flatt.tech/oss/gmo/trampoline" target="_blank"><img src="https://flatt.tech/assets/images/badges/gmo-oss.svg" height="24px"/></a> |
| 14 | |
| 15 | **[Documentation](https://dyoshikawa.github.io/rulesync/)** | **[npm](https://www.npmjs.com/package/rulesync)** |
| 16 | |
| 17 | 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. |
| 18 | |
| 19 | > [!NOTE] |
| 20 | > If you are interested in Rulesync latest news, please follow the maintainer's X(Twitter) account: |
| 21 | > [@dyoshikawa1993](https://x.com/dyoshikawa1993) |
| 22 | |
| 23 | ## Installation |
| 24 | |
| 25 | ```bash |
| 26 | npm install -g rulesync |
| 27 | ``` |
| 28 | |
| 29 | Or install from our Homebrew tap (macOS and Linux): |
| 30 | |
| 31 | ```bash |
| 32 | brew tap dyoshikawa/rulesync https://github.com/dyoshikawa/rulesync |
| 33 | brew install rulesync |
| 34 | ``` |
| 35 | |
| 36 | The tap lives inside this repository, so it does not have a `homebrew-` prefix. |
| 37 | The two-argument `brew tap <name> <url>` form is therefore required — the |
| 38 | shorthand `brew install dyoshikawa/rulesync/rulesync` without tapping first does |
| 39 | not work. |
| 40 | |
| 41 | ### Single Binary |
| 42 | |
| 43 | ```bash |
| 44 | curl -fsSL https://github.com/dyoshikawa/rulesync/releases/latest/download/install.sh | bash |
| 45 | ``` |
| 46 | |
| 47 | See [Installation docs](https://dyoshikawa.github.io/rulesync/getting-started/installation) for manual install and platform-specific instructions. |
| 48 | |
| 49 | ## Getting Started |
| 50 | |
| 51 | ```bash |
| 52 | # Create necessary directories, sample rule files, and configuration file |
| 53 | rulesync init |
| 54 | |
| 55 | # Install official skills (recommended) |
| 56 | rulesync fetch dyoshikawa/rulesync --features skills |
| 57 | |
| 58 | # Generate unified configurations with all features |
| 59 | rulesync generate --targets "*" --features "*" |
| 60 | ``` |
| 61 | |
| 62 | If you already have AI tool configurations: |
| 63 | |
| 64 | ```bash |
| 65 | # Import existing files (to .rulesync/**/*) |
| 66 | rulesync import --targets claudecode # From CLAUDE.md |
| 67 | rulesync import --targets cursor # From .cursorrules |
| 68 | rulesync import --targets copilot # From .github/copilot-instructions.md |
| 69 | ``` |
| 70 | |
| 71 | Want to convert configuration from one AI tool to another directly, without |
| 72 | adopting the `.rulesync/` source-of-truth workflow? |
| 73 | |
| 74 | ```bash |
| 75 | # Convert Cursor rules to Copilot and Claude Code in one shot (no .rulesync/ files written) |
| 76 | rulesync convert --from cursor --to copilot,claudecode |
| 77 | ``` |
| 78 | |
| 79 | See [Quick Start guide](https://dyoshikawa.github.io/rulesync/getting-started/quick-start) for more details. |
| 80 | |
| 81 | ## Supported Tools and Features |
| 82 | |
| 83 | 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](https://dyoshikawa.github.io/rulesync/reference/supported-tools). |
| 84 | |
| 85 | ### AI Coding Tools |
| 86 | |
| 87 | <!-- SUPPORTED_TOOLS_AI:BEGIN --> |
| 88 | |
| 89 | | Tool | rules | ignore | mcp | commands | subagents | skills | hooks | permissions | checks | |
| 90 | | ---------------------- | :---: | :----: | :-: | :------: | :-------: | :----: | |
People who liked this also viewed
6 picksType
- fastapi_mcpExpose your FastAPI endpoints as Model Context Protocol (MCP) tools, with Auth!MCP ServersNov 2025
- lean-lsp-mcpLean Theorem Prover MCPMCP ServersJul 2026
- FunASROpen-source speech recognition toolkit for training, inference, streaming ASR, VAD, punctuation, speaker diarization pipelines, and OpenAI-compatible/MCP serving.MCP ServersJul 2026
- repomix📦 Repomix is a powerful tool that packs your entire repository into a single, AI-friendly file. Perfect for when you need to feed your codebase to Large Language Models (LLMs) or other AI tools like Claude, ChatGPT, DeepSeek, Perplexity, Gemini, Gemma, Llama, Grok, and more.MCP ServersJul 2026
- mcp-serverMCP server for AI-assisted development of CAP applicationsMCP ServersJul 2026
- antigravity-sdk-pythonA Python library for building AI agents that leverage the full power of Google Antigravity.MCP ServersJul 2026
