rulesync 3.23.6 → 3.24.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +53 -23
- package/dist/index.cjs +802 -112
- package/dist/index.js +802 -112
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
[](https://github.com/hesreallyhim/awesome-claude-code)
|
|
8
8
|
[](https://github.com/Piebald-AI/awesome-gemini-cli)
|
|
9
9
|
|
|
10
|
-
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,
|
|
10
|
+
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.
|
|
11
11
|
|
|
12
12
|
> [!NOTE]
|
|
13
13
|
> If you are interested in Rulesync latest news, please follow the maintainer's X(Twitter) account:
|
|
@@ -130,24 +130,24 @@ npx rulesync generate --targets "*" --features "*"
|
|
|
130
130
|
|
|
131
131
|
Rulesync supports both **generation** and **import** for All of the major AI coding tools:
|
|
132
132
|
|
|
133
|
-
| Tool | rules | ignore | mcp | commands | subagents |
|
|
134
|
-
|
|
135
|
-
| AGENTS.md | ✅ | | | 🎮 | 🎮 |
|
|
136
|
-
| Claude Code | ✅ 🌏 | ✅ | ✅ 🌏 📦 | ✅ 🌏 | ✅ 🌏 |
|
|
137
|
-
| Codex CLI | ✅ 🌏 | | 🌏 | 🌏 | 🎮 |
|
|
138
|
-
| Gemini CLI | ✅ 🌏 | ✅ | ✅ 🌏 | ✅ 🌏 | 🎮 |
|
|
139
|
-
| GitHub Copilot | ✅ | | ✅ | ✅ | 🎮 |
|
|
140
|
-
| Cursor | ✅ | ✅ | ✅ | ✅ 🌏 | 🎮 |
|
|
141
|
-
| OpenCode | ✅ | | | | |
|
|
142
|
-
| Cline | ✅ | ✅ | ✅ | | |
|
|
143
|
-
| Roo Code | ✅ | ✅ | ✅ | ✅ | 🎮 |
|
|
144
|
-
| Qwen Code | ✅ | ✅ | | | |
|
|
145
|
-
| Kiro IDE | ✅ | ✅ | | | |
|
|
146
|
-
| Amazon Q Developer CLI | ✅ | | ✅ | | |
|
|
147
|
-
| JetBrains Junie | ✅ | ✅ | | | |
|
|
148
|
-
| AugmentCode | ✅ | ✅ | | | |
|
|
149
|
-
| Windsurf | ✅ | ✅ | | | |
|
|
150
|
-
| Warp | ✅ | | | | |
|
|
133
|
+
| Tool | rules | ignore | mcp | commands | subagents | skills |
|
|
134
|
+
|------------------------|:-----:|:------:|:-----:|:--------:|:---------:|:------:|
|
|
135
|
+
| AGENTS.md | ✅ | | | 🎮 | 🎮 | |
|
|
136
|
+
| Claude Code | ✅ 🌏 | ✅ | ✅ 🌏 📦 | ✅ 🌏 | ✅ 🌏 | ✅ 🌏 |
|
|
137
|
+
| Codex CLI | ✅ 🌏 | | 🌏 | 🌏 | 🎮 | |
|
|
138
|
+
| Gemini CLI | ✅ 🌏 | ✅ | ✅ 🌏 | ✅ 🌏 | 🎮 | |
|
|
139
|
+
| GitHub Copilot | ✅ | | ✅ | ✅ | 🎮 | |
|
|
140
|
+
| Cursor | ✅ | ✅ | ✅ | ✅ 🌏 | 🎮 | |
|
|
141
|
+
| OpenCode | ✅ | | | | | |
|
|
142
|
+
| Cline | ✅ | ✅ | ✅ | | | |
|
|
143
|
+
| Roo Code | ✅ | ✅ | ✅ | ✅ | 🎮 | |
|
|
144
|
+
| Qwen Code | ✅ | ✅ | | | | |
|
|
145
|
+
| Kiro IDE | ✅ | ✅ | | | | |
|
|
146
|
+
| Amazon Q Developer CLI | ✅ | | ✅ | | | |
|
|
147
|
+
| JetBrains Junie | ✅ | ✅ | | | | |
|
|
148
|
+
| AugmentCode | ✅ | ✅ | | | | |
|
|
149
|
+
| Windsurf | ✅ | ✅ | | | | |
|
|
150
|
+
| Warp | ✅ | | | | | |
|
|
151
151
|
|
|
152
152
|
* ✅: Supports project mode
|
|
153
153
|
* 🌏: Supports global mode
|
|
@@ -184,7 +184,7 @@ Simulated commands and subagents allow you to generate simulated commands and su
|
|
|
184
184
|
npx rulesync init
|
|
185
185
|
|
|
186
186
|
# Import existing configurations (to .rulesync/rules/ by default)
|
|
187
|
-
npx rulesync import --targets claudecode --features rules,ignore,mcp,commands,subagents
|
|
187
|
+
npx rulesync import --targets claudecode --features rules,ignore,mcp,commands,subagents,skills
|
|
188
188
|
|
|
189
189
|
# Generate all features for all tools (new preferred syntax)
|
|
190
190
|
npx rulesync generate --targets "*" --features "*"
|
|
@@ -254,13 +254,13 @@ root: true # true that is less than or equal to one file for overview such as `A
|
|
|
254
254
|
targets: ["*"] # * = all, or specific tools
|
|
255
255
|
description: "Rulesync project overview and development guidelines for unified AI rules management CLI tool"
|
|
256
256
|
globs: ["**/*"] # file patterns to match (e.g., ["*.md", "*.txt"])
|
|
257
|
-
agentsmd: # agentsmd and codexcli specific
|
|
257
|
+
agentsmd: # agentsmd and codexcli specific parameters
|
|
258
258
|
# Support for using nested AGENTS.md files for subprojects in a large monorepo.
|
|
259
259
|
# This option is available only if root is false.
|
|
260
260
|
# If subprojectPath is provided, the file is located in `${subprojectPath}/AGENTS.md`.
|
|
261
261
|
# If subprojectPath is not provided and root is false, the file is located in `.agents/memories/*.md`.
|
|
262
262
|
subprojectPath: "path/to/subproject"
|
|
263
|
-
cursor: # cursor specific
|
|
263
|
+
cursor: # cursor specific parameters
|
|
264
264
|
alwaysApply: true
|
|
265
265
|
description: "Rulesync project overview and development guidelines for unified AI rules management CLI tool"
|
|
266
266
|
globs: ["*"]
|
|
@@ -304,7 +304,7 @@ description: >- # subagent description
|
|
|
304
304
|
This is the general-purpose planner. The user asks the agent to plan to
|
|
305
305
|
suggest a specification, implement a new feature, refactor the codebase, or
|
|
306
306
|
fix a bug. This agent can be called by the user explicitly only.
|
|
307
|
-
claudecode: # for claudecode-specific
|
|
307
|
+
claudecode: # for claudecode-specific parameters
|
|
308
308
|
model: inherit # opus, sonnet, haiku or inherit
|
|
309
309
|
---
|
|
310
310
|
|
|
@@ -315,6 +315,36 @@ Based on the user's instruction, create a plan while analyzing the related files
|
|
|
315
315
|
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.
|
|
316
316
|
```
|
|
317
317
|
|
|
318
|
+
### `.rulesync/skills/*/SKILL.md`
|
|
319
|
+
|
|
320
|
+
Example:
|
|
321
|
+
|
|
322
|
+
```md
|
|
323
|
+
---
|
|
324
|
+
name: example-skill # skill name
|
|
325
|
+
description: >- # skill description
|
|
326
|
+
A sample skill that demonstrates the skill format
|
|
327
|
+
claudecode: # for claudecode-specific parameters
|
|
328
|
+
allowed-tools:
|
|
329
|
+
- "Bash"
|
|
330
|
+
- "Read"
|
|
331
|
+
- "Write"
|
|
332
|
+
- "Grep"
|
|
333
|
+
---
|
|
334
|
+
|
|
335
|
+
This is the skill body content.
|
|
336
|
+
|
|
337
|
+
You can provide instructions, context, or any information that helps the AI agent understand and execute this skill effectively.
|
|
338
|
+
|
|
339
|
+
The skill can include:
|
|
340
|
+
- Step-by-step instructions
|
|
341
|
+
- Code examples
|
|
342
|
+
- Best practices
|
|
343
|
+
- Any relevant context
|
|
344
|
+
|
|
345
|
+
Skills are directory-based and can include additional files alongside SKILL.md.
|
|
346
|
+
```
|
|
347
|
+
|
|
318
348
|
### `.rulesync/mcp.json`
|
|
319
349
|
|
|
320
350
|
Example:
|