You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+41-30Lines changed: 41 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,12 @@
1
-
# @weorbitant/cursor-rules
1
+
# @orbitant/cursor-rules
2
2
3
-
A Node.js package for generating and managing Cursor IDE rules from templates. This package allows you to easily copy predefined Cursor rules to your project's `.cursor/rules` directory.
3
+
A Node.js package for generating and managing Cursor IDE rules and commands from templates. This package allows you to easily copy predefined Cursor rules to your project's `.cursor/rules` directory and commands to your `.cursor/commands` directory.
4
4
5
5
## π Features
6
6
7
7
-**Template-based Rule Generation**: Copy Cursor rules from predefined templates
8
-
-**Selective File Management**: Only manages files from this package, preserving user's custom rules
8
+
-**Template-based Command Generation**: Copy Cursor commands from predefined templates
9
+
-**Selective File Management**: Only manages files from this package, preserving user's custom rules and commands
This package includes the following Cursor rule templates:
77
+
This package includes the following Cursor rule and command templates:
77
78
79
+
### Rules (.cursor/rules/)
78
80
1.**readme-async-messaging.mdc** - Auto-update README with async messaging architecture
79
81
2.**readme-config.mdc** - Auto-update README with configuration section
80
-
3.**readme-content.mdc** - Auto-update README with content management rules
81
-
4.**readme-data-model.mdc** - Auto-update README with data model documentation
82
+
3.**readme-data-model.mdc** - Auto-update README with data model documentation
83
+
4.**readme-summary.mdc** - Auto-update README with summary section
84
+
85
+
### Commands (.cursor/commands/)
86
+
1.**update-docs.md** - Command to update project documentation
82
87
83
88
## π§ How It Works
84
89
85
-
1.**Template Discovery**: Scans the `templates/rules/` directory for `.mdc` files
86
-
2.**Destination Management**: Creates `.cursor/rules/`directory if it doesn't exist
90
+
1.**Template Discovery**: Scans the `templates/rules/` directory for `.mdc` files and `templates/commands/` directory for `.md` files
91
+
2.**Destination Management**: Creates `.cursor/rules/`and `.cursor/commands/` directories if they don't exist
87
92
3.**File Copying**: Copies each template file, preserving directory structure
88
93
4.**Safe Cleanup**: Only removes files that were originally copied from this package
89
94
@@ -96,50 +101,56 @@ This package includes the following Cursor rule templates:
96
101
97
102
## π Example Output
98
103
99
-
### Copy Command
104
+
### Apply Command
100
105
```
101
106
π WeOrbitant Cursor Rules Generator
102
107
================================
103
108
β Created directory: .cursor/rules
104
-
π Found 4 template files:
109
+
β Created directory: .cursor/commands
110
+
π Found 4 rule template files:
105
111
β Copied: readme-data-model.mdc
106
-
β Copied: readme-content.mdc
112
+
β Copied: readme-summary.mdc
107
113
β Copied: readme-config.mdc
108
114
β Copied: readme-async-messaging.mdc
115
+
π Found 1 command template files:
116
+
β Copied: update-docs.md
109
117
110
118
π Successfully copied 4 rule files to .cursor/rules/
111
-
You can now use these rules in your Cursor IDE!
119
+
π Successfully copied 1 command file to .cursor/commands/
120
+
You can now use these rules and commands in your Cursor IDE!
112
121
```
113
122
114
123
### Clean Command
115
124
```
116
125
π§Ή Cleaning WeOrbitant Cursor Rules
117
126
================================
118
127
β Removed: readme-data-model.mdc
119
-
β Removed: readme-content.mdc
128
+
β Removed: readme-summary.mdc
120
129
β Removed: readme-config.mdc
121
130
β Removed: readme-async-messaging.mdc
131
+
β Removed: update-docs.md
122
132
π Directory .cursor/rules kept (contains other files)
133
+
π Directory .cursor/commands kept (contains other files)
123
134
124
135
π Cleanup complete!
125
-
β’ Removed: 4 files
136
+
β’ Removed: 5 files
126
137
β’ Not found: 0 files
127
138
```
128
139
129
140
## π Integration
130
141
131
142
### With Cursor IDE
132
143
133
-
After running the copy command, your Cursor IDE will automatically detect the rules in `.cursor/rules/` and apply them to your project.
144
+
After running the apply command, your Cursor IDE will automatically detect the rules in `.cursor/rules/` and commands in `.cursor/commands/`, making them available for use in your project.
134
145
135
146
### With CI/CD
136
147
137
-
Add to your CI/CD pipeline to ensure consistent rules across environments:
148
+
Add to your CI/CD pipeline to ensure consistent rules and commands across environments:
0 commit comments