rulesync 3.23.6 → 3.25.0

package/README.md

@@ -1,3 +1,7 @@
+<p align="center">
+  <img src="images/logo.jpg" alt="Rulesync Logo" width="600">
+</p>
+
 # Rulesync
 
 [![CI](https://github.com/dyoshikawa/rulesync/actions/workflows/ci.yml/badge.svg)](https://github.com/dyoshikawa/rulesync/actions/workflows/ci.yml)
@@ -7,7 +11,7 @@
 [![Mentioned in Awesome Claude Code](https://awesome.re/mentioned-badge.svg)](https://github.com/hesreallyhim/awesome-claude-code)
 [![Mentioned in Awesome Gemini CLI](https://awesome.re/mentioned-badge.svg)](https://github.com/Piebald-AI/awesome-gemini-cli)
 
-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, and subagents. Uses the recommended `.rulesync/rules/*.md` structure, with full backward compatibility for legacy `.rulesync/*.md` layouts.
+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:
@@ -130,28 +134,28 @@ npx rulesync generate --targets "*" --features "*"
 
 Rulesync supports both **generation** and **import** for All of the major AI coding tools:
 
-| Tool                  | rules | ignore | mcp   | commands | subagents |
-|------------------------|:-----:|:------:|:-----:|:--------:|:---------:|
-| AGENTS.md            |  ✅   |      |       |     🎮     |      🎮     |
-| Claude Code            |  ✅ 🌏   |  ✅   |  ✅ 🌏 📦   |    ✅ 🌏     |    ✅ 🌏     |
-| Codex CLI              |  ✅ 🌏   |      |   🌏   |     🌏    |    🎮      |
-| Gemini CLI             |  ✅ 🌏  |   ✅   |  ✅ 🌏  |     ✅ 🌏  |      🎮     |
-| GitHub Copilot         |  ✅    |       |  ✅    |     ✅     |    🎮      |
-| Cursor                 |  ✅   |   ✅  |   ✅   |     ✅ 🌏  |     🎮     |
-| OpenCode               |  ✅   |       |       |         |          |
-| Cline                  |  ✅    |   ✅    |  ✅    |          |          |
-| Roo Code               |  ✅   |   ✅   |  ✅    |   ✅     |     🎮     |
-| Qwen Code              |  ✅   |   ✅   |       |         |          |
-| Kiro IDE               |  ✅   |   ✅   |      |         |          |
-| Amazon Q Developer CLI |  ✅   |       |  ✅   |         |          |
-| JetBrains Junie        |  ✅   |   ✅   |      |         |          |
-| AugmentCode            |  ✅   |   ✅   |       |         |          |
-| Windsurf               |  ✅   |   ✅    |      |         |          |
-| Warp               |  ✅   |        |      |         |          |
+| Tool                  | rules | ignore | mcp   | commands | subagents | skills |
+|------------------------|:-----:|:------:|:-----:|:--------:|:---------:|:------:|
+| AGENTS.md            |  ✅   |      |       |     🎮     |      🎮     |    🎮   |
+| Claude Code            |  ✅ 🌏   |  ✅   |  ✅ 🌏 📦   |    ✅ 🌏     |    ✅ 🌏     |  ✅ 🌏   |
+| Codex CLI              |  ✅ 🌏   |      |   🌏   |     🌏    |    🎮      |    🎮   |
+| Gemini CLI             |  ✅ 🌏  |   ✅   |  ✅ 🌏  |     ✅ 🌏  |      🎮     |    🎮   |
+| GitHub Copilot         |  ✅    |       |  ✅    |     ✅     |    🎮      |    🎮   |
+| Cursor                 |  ✅   |   ✅  |   ✅   |     ✅ 🌏  |     🎮     |    🎮   |
+| OpenCode               |  ✅   |       |       |         |          |        |
+| Cline                  |  ✅    |   ✅    |  ✅    |          |          |        |
+| Roo Code               |  ✅   |   ✅   |  ✅    |   ✅     |     🎮     |        |
+| Qwen Code              |  ✅   |   ✅   |       |         |          |        |
+| Kiro IDE               |  ✅   |   ✅   |      |         |          |        |
+| Amazon Q Developer CLI |  ✅   |       |  ✅   |         |          |        |
+| JetBrains Junie        |  ✅   |   ✅   |      |         |          |        |
+| AugmentCode            |  ✅   |   ✅   |       |         |          |        |
+| Windsurf               |  ✅   |   ✅    |      |         |          |        |
+| Warp               |  ✅   |        |      |         |          |        |
 
 * ✅: Supports project mode
 * 🌏: Supports global mode
-* 🎮: Supports simulated commands/subagents (Project mode only)
+* 🎮: Supports simulated commands/subagents/skills (Project mode only)
 * 📦: Supports modular MCP (Experimental)
 
 ## Why Rulesync?
@@ -184,7 +188,7 @@ Simulated commands and subagents allow you to generate simulated commands and su
 npx rulesync init
 
 # Import existing configurations (to .rulesync/rules/ by default)
-npx rulesync import --targets claudecode --features rules,ignore,mcp,commands,subagents
+npx rulesync import --targets claudecode --features rules,ignore,mcp,commands,subagents,skills
 
 # Generate all features for all tools (new preferred syntax)
 npx rulesync generate --targets "*" --features "*"
@@ -231,8 +235,9 @@ Example:
 
   // Advanced options
   "global": false,  // Generate for global(user scope) configuration files
-  "simulatedCommands": false,  // Generate simulated commands
-  "simulatedSubagents": false,  // Generate simulated subagents
+  "simulateCommands": false,  // Generate simulated commands
+  "simulateSubagents": false,  // Generate simulated subagents
+  "simulateSkills": false,  // Generate simulated skills
   "modularMcp": false  // Enable modular-mcp for context compression (experimental, Claude Code only)
 
   // Deprecated experimental options (for backward compatibility)
@@ -254,13 +259,13 @@ root: true # true that is less than or equal to one file for overview such as `A
 targets: ["*"] # * = all, or specific tools
 description: "Rulesync project overview and development guidelines for unified AI rules management CLI tool"
 globs: ["**/*"] # file patterns to match (e.g., ["*.md", "*.txt"])
-agentsmd: # agentsmd and codexcli specific rules
+agentsmd: # agentsmd and codexcli specific parameters
   # Support for using nested AGENTS.md files for subprojects in a large monorepo.
   # This option is available only if root is false.
   # If subprojectPath is provided, the file is located in `${subprojectPath}/AGENTS.md`.
   # If subprojectPath is not provided and root is false, the file is located in `.agents/memories/*.md`.
   subprojectPath: "path/to/subproject"
-cursor: # cursor specific rules
+cursor: # cursor specific parameters
   alwaysApply: true
   description: "Rulesync project overview and development guidelines for unified AI rules management CLI tool"
   globs: ["*"]
@@ -304,7 +309,7 @@ description: >- # subagent description
   This is the general-purpose planner. The user asks the agent to plan to
   suggest a specification, implement a new feature, refactor the codebase, or
   fix a bug. This agent can be called by the user explicitly only.
-claudecode: # for claudecode-specific rules
+claudecode: # for claudecode-specific parameters
   model: inherit # opus, sonnet, haiku or inherit
 ---
 
@@ -315,6 +320,37 @@ Based on the user's instruction, create a plan while analyzing the related files
 Attention, again, you are just the planner, so though you can read any files and run any commands for analysis, please don't write any code.
 ```
 
+### `.rulesync/skills/*/SKILL.md`
+
+Example:
+
+```md
+---
+name: example-skill # skill name
+description: >- # skill description
+  A sample skill that demonstrates the skill format
+targets: ["*"] # * = all, or specific tools
+claudecode: # for claudecode-specific parameters
+  allowed-tools:
+    - "Bash"
+    - "Read"
+    - "Write"
+    - "Grep"
+---
+
+This is the skill body content.
+
+You can provide instructions, context, or any information that helps the AI agent understand and execute this skill effectively.
+
+The skill can include:
+- Step-by-step instructions
+- Code examples
+- Best practices
+- Any relevant context
+
+Skills are directory-based and can include additional files alongside SKILL.md.
+```
+
 ### `.rulesync/mcp.json`
 
 Example:
@@ -404,20 +440,21 @@ Currently, supports rules and commands generation for Claude Code. Import for gl
 > * `rules/*.md` only supports single file has `root: true`, and frontmatter parameters without `root` are ignored.
 > * Only Claude Code is supported for global mode commands.
 
-## Simulate Commands and Subagents
+## Simulate Commands, Subagents and Skills
 
-Simulated commands and subagents allow you to generate simulated commands and subagents for copilot, cursor, codexcli and etc. This is useful for shortening your prompts.
+Simulated commands, subagents and skills allow you to generate simulated features for copilot, cursor, codexcli and etc. This is useful for shortening your prompts.
 
-1. Prepare `.rulesync/commands/*.md` and `.rulesync/subagents/*.md` for your purposes.
-2. Generate simulated commands and subagents for specific tools that are included in copilot, cursor, codexcli and etc.
+1. Prepare `.rulesync/commands/*.md`, `.rulesync/subagents/*.md` and `.rulesync/skills/*/SKILL.md` for your purposes.
+2. Generate simulated commands, subagents and skills for specific tools that are included in copilot, cursor, codexcli and etc.
     ```bash
     npx rulesync generate \
       --targets copilot,cursor,codexcli \
-      --features commands,subagents \
+      --features commands,subagents,skills \
       --simulated-commands \
-      --simulated-subagents
+      --simulated-subagents \
+      --simulated-skills
     ```
-3. Use simulated commands and subagents in your prompts.
+3. Use simulated commands, subagents and skills in your prompts.
     - Prompt examples:
       ```txt
       # Execute simulated commands. By the way, `s/` stands for `simulate/`.
@@ -425,6 +462,9 @@ Simulated commands and subagents allow you to generate simulated commands and su
 
       # Execute simulated subagents
       Call your-subagent to achieve something.
+
+      # Use simulated skills
+      Use the skill your-skill to achieve something.
       ```
 
 ## Modular MCP (Experimental)
@@ -674,6 +714,22 @@ pnpm cicheck # Run code style check, type check, and tests
 # Manual test using current code
 pnpm dev generate -t claudecode -f "*"
 pnpm dev import -t claudecode -f "*"
+
+# Once you create .rulesync/rules/my-language.md and `pnpm dev generate`, you can use coding agents with your language.
+# Japanese setting example:
+cat << 'EOF' > .rulesync/rules/my-language.md
+---
+root: false
+targets: ['*']
+description: "It's a rule about language. If the rule file exists, you must always follow this."
+globs: ["**/*"]
+---
+
+I'm a Japanese developer. So you must always answer in Japanese. On the other hand, reasoning(thinking) should be in English to improve token efficiency.
+
+However, this project is for English speaking people. So when you write any code, comments, documentation, commit messages, PR title and PR descriptions, you must always use English.
+EOF
+pnpm dev generate
 ```
 
 ## FAQ