rulesync 3.6.0 → 3.8.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 +22 -17
- package/dist/index.cjs +303 -84
- package/dist/index.js +303 -84
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -77,8 +77,8 @@ Rulesync supports both **generation** and **import** for All of the major AI cod
|
|
|
77
77
|
| Warp | ✅ | | | | |
|
|
78
78
|
|
|
79
79
|
* ✅: Supports project mode
|
|
80
|
-
* 🌏: Supports global mode
|
|
81
|
-
* 🎮: Supports simulated commands/subagents (Project mode only
|
|
80
|
+
* 🌏: Supports global mode
|
|
81
|
+
* 🎮: Supports simulated commands/subagents (Project mode only)
|
|
82
82
|
|
|
83
83
|
## Why Rulesync?
|
|
84
84
|
|
|
@@ -98,10 +98,10 @@ Avoid lock-in completely. If you decide to stop using Rulesync, you can continue
|
|
|
98
98
|
Apply consistent rules across all AI tools, improving code quality and development experience for the entire team.
|
|
99
99
|
|
|
100
100
|
### 🌏 **Global Mode**
|
|
101
|
-
You can use global mode via Rulesync by enabling `--
|
|
101
|
+
You can use global mode via Rulesync by enabling `--global` option.
|
|
102
102
|
|
|
103
103
|
### 🎮 **Simulated Commands and Subagents**
|
|
104
|
-
Simulated commands and subagents
|
|
104
|
+
Simulated commands and subagents allow you to generate simulated commands and subagents for copilot, cursor and codexcli. This is useful for shortening your prompts.
|
|
105
105
|
|
|
106
106
|
## Quick Commands
|
|
107
107
|
|
|
@@ -122,8 +122,8 @@ npx rulesync generate --targets claudecode --features rules,subagents
|
|
|
122
122
|
# Generate only rules (no MCP, ignore files, commands, or subagents)
|
|
123
123
|
npx rulesync generate --targets "*" --features rules
|
|
124
124
|
|
|
125
|
-
# Generate simulated commands and subagents
|
|
126
|
-
npx rulesync generate --targets copilot,cursor,codexcli --features commands,subagents --
|
|
125
|
+
# Generate simulated commands and subagents
|
|
126
|
+
npx rulesync generate --targets copilot,cursor,codexcli --features commands,subagents --simulated-commands --simulated-subagents
|
|
127
127
|
|
|
128
128
|
# Add generated files to .gitignore
|
|
129
129
|
npx rulesync gitignore
|
|
@@ -155,10 +155,15 @@ Example:
|
|
|
155
155
|
// Verbose output
|
|
156
156
|
"verbose": false,
|
|
157
157
|
|
|
158
|
-
//
|
|
159
|
-
"
|
|
160
|
-
"
|
|
161
|
-
"
|
|
158
|
+
// Advanced options
|
|
159
|
+
"global": false, // Generate for global(user scope) configuration files
|
|
160
|
+
"simulatedCommands": false, // Generate simulated commands
|
|
161
|
+
"simulatedSubagents": false // Generate simulated subagents
|
|
162
|
+
|
|
163
|
+
// Deprecated experimental options (for backward compatibility)
|
|
164
|
+
// "experimentalGlobal": false,
|
|
165
|
+
// "experimentalSimulateCommands": false,
|
|
166
|
+
// "experimentalSimulateSubagents": false
|
|
162
167
|
}
|
|
163
168
|
```
|
|
164
169
|
|
|
@@ -281,9 +286,9 @@ tmp/
|
|
|
281
286
|
credentials/
|
|
282
287
|
```
|
|
283
288
|
|
|
284
|
-
## Global Mode
|
|
289
|
+
## Global Mode
|
|
285
290
|
|
|
286
|
-
You can use global mode via Rulesync by enabling `--
|
|
291
|
+
You can use global mode via Rulesync by enabling `--global` option. It can also be called as user scope mode.
|
|
287
292
|
|
|
288
293
|
Currently, supports rules and commands generation for Claude Code. Import for global files is supported for rules and commands.
|
|
289
294
|
|
|
@@ -299,7 +304,7 @@ Currently, supports rules and commands generation for Claude Code. Import for gl
|
|
|
299
304
|
3. Edit `~/.aiglobal/rulesync.jsonc` to enable global mode.
|
|
300
305
|
```jsonc
|
|
301
306
|
{
|
|
302
|
-
"
|
|
307
|
+
"global": true
|
|
303
308
|
}
|
|
304
309
|
```
|
|
305
310
|
4. Edit `~/.aiglobal/.rulesync/rules/overview.md` to your preferences.
|
|
@@ -322,9 +327,9 @@ Currently, supports rules and commands generation for Claude Code. Import for gl
|
|
|
322
327
|
> * `rules/*.md` only supports single file has `root: true`, and frontmatter parameters without `root` are ignored.
|
|
323
328
|
> * Only Claude Code is supported for global mode commands.
|
|
324
329
|
|
|
325
|
-
## Simulate Commands and Subagents
|
|
330
|
+
## Simulate Commands and Subagents
|
|
326
331
|
|
|
327
|
-
Simulated commands and subagents
|
|
332
|
+
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.
|
|
328
333
|
|
|
329
334
|
1. Prepare `.rulesync/commands/*.md` and `.rulesync/subagents/*.md` for your purposes.
|
|
330
335
|
2. Generate simulated commands and subagents for specific tools that are included in copilot, cursor, codexcli and etc.
|
|
@@ -332,8 +337,8 @@ Simulated commands and subagents are experimental features that allow you to gen
|
|
|
332
337
|
npx rulesync generate \
|
|
333
338
|
--targets copilot,cursor,codexcli \
|
|
334
339
|
--features commands,subagents \
|
|
335
|
-
--
|
|
336
|
-
--
|
|
340
|
+
--simulated-commands \
|
|
341
|
+
--simulated-subagents
|
|
337
342
|
```
|
|
338
343
|
3. Use simulated commands and subagents in your prompts.
|
|
339
344
|
- Prompt examples:
|