cursor-kit-cli 1.2.0-beta.4 → 1.2.0-beta.5
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 +32 -26
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,18 +1,22 @@
|
|
|
1
|
-
<h1 align="center">✦ Cursor Kit ✦</h1>
|
|
2
|
-
|
|
3
1
|
<p align="center">
|
|
4
|
-
<img src="
|
|
5
|
-
<img src="https://img.shields.io/npm/dm/cursor-kit-cli?style=flat-square&color=36E4DA" alt="npm downloads" />
|
|
6
|
-
<img src="https://img.shields.io/github/license/duongductrong/cursor-kit?style=flat-square&color=0047E1" alt="license" />
|
|
2
|
+
<img src="./thumbnail.png" alt="Cursor Kit" width="768" />
|
|
7
3
|
</p>
|
|
8
4
|
|
|
5
|
+
<h1 align="center">✦ Cursor Kit ✦</h1>
|
|
6
|
+
|
|
9
7
|
<p align="center">
|
|
10
8
|
<b>Supercharge your Cursor IDE with rules & commands</b><br/>
|
|
11
9
|
<sub>A CLI toolkit to manage, share, and sync Cursor IDE configurations</sub>
|
|
12
10
|
</p>
|
|
13
11
|
|
|
14
12
|
<p align="center">
|
|
15
|
-
<
|
|
13
|
+
<a style="text-decoration: none;" href="https://www.npmjs.com/package/cursor-kit-cli" target="_blank">
|
|
14
|
+
<img src="https://img.shields.io/npm/v/cursor-kit-cli?style=flat-square&color=000000" alt="npm version" />
|
|
15
|
+
</a>
|
|
16
|
+
<a style="text-decoration: none;" href="https://www.npmjs.com/package/cursor-kit-cli" target="_blank">
|
|
17
|
+
<img src="https://img.shields.io/npm/dm/cursor-kit-cli?style=flat-square&color=000000" alt="npm downloads" />
|
|
18
|
+
</a>
|
|
19
|
+
<!-- <img src="https://img.shields.io/github/license/duongductrong/cursor-kit?style=flat-square&color=0047E1" alt="license" /> -->
|
|
16
20
|
</p>
|
|
17
21
|
|
|
18
22
|
## 🚀 Quick Start
|
|
@@ -114,6 +118,7 @@ cursor-kit instance -a remove -n "Cursor Work" # Remove instance
|
|
|
114
118
|
```
|
|
115
119
|
|
|
116
120
|
**How it works:**
|
|
121
|
+
|
|
117
122
|
- Creates a copy of Cursor.app in `~/Applications/`
|
|
118
123
|
- Assigns a unique bundle identifier (e.g., `com.cursor.cursorwork`)
|
|
119
124
|
- Creates a separate data directory in `~/Library/Application Support/`
|
|
@@ -122,6 +127,7 @@ cursor-kit instance -a remove -n "Cursor Work" # Remove instance
|
|
|
122
127
|
- Reinstall refreshes the instance with the latest Cursor version while preserving your data
|
|
123
128
|
|
|
124
129
|
**Example workflow:**
|
|
130
|
+
|
|
125
131
|
```bash
|
|
126
132
|
# Create an instance for work projects
|
|
127
133
|
cursor-kit instance -a create -n "Cursor Enterprise"
|
|
@@ -170,29 +176,29 @@ your-project/
|
|
|
170
176
|
|
|
171
177
|
### Commands
|
|
172
178
|
|
|
173
|
-
| Command
|
|
174
|
-
|
|
175
|
-
| `docs`
|
|
176
|
-
| `explain`
|
|
177
|
-
| `fix`
|
|
178
|
-
| `implement` | Convert feature ideas into actionable plans
|
|
179
|
-
| `refactor`
|
|
180
|
-
| `review`
|
|
181
|
-
| `test`
|
|
179
|
+
| Command | Description |
|
|
180
|
+
| ----------- | ---------------------------------------------- |
|
|
181
|
+
| `docs` | Create or update documentation |
|
|
182
|
+
| `explain` | Clear technical explanations |
|
|
183
|
+
| `fix` | Diagnose and fix bugs with root cause analysis |
|
|
184
|
+
| `implement` | Convert feature ideas into actionable plans |
|
|
185
|
+
| `refactor` | Improve code quality without changing behavior |
|
|
186
|
+
| `review` | Comprehensive code review checklist |
|
|
187
|
+
| `test` | Generate comprehensive test suites |
|
|
182
188
|
|
|
183
189
|
### Rules
|
|
184
190
|
|
|
185
|
-
| Rule
|
|
186
|
-
|
|
187
|
-
| `coding-style`
|
|
188
|
-
| `frontend-design` | Typography, aesthetics, and UI guidelines
|
|
189
|
-
| `git`
|
|
190
|
-
| `performance`
|
|
191
|
-
| `react`
|
|
192
|
-
| `security`
|
|
193
|
-
| `testing`
|
|
194
|
-
| `toc`
|
|
195
|
-
| `typescript`
|
|
191
|
+
| Rule | Description |
|
|
192
|
+
| ----------------- | ------------------------------------------ |
|
|
193
|
+
| `coding-style` | Core coding conventions and best practices |
|
|
194
|
+
| `frontend-design` | Typography, aesthetics, and UI guidelines |
|
|
195
|
+
| `git` | Commit and branching conventions |
|
|
196
|
+
| `performance` | Performance optimization patterns |
|
|
197
|
+
| `react` | React component patterns |
|
|
198
|
+
| `security` | Security guidelines |
|
|
199
|
+
| `testing` | Testing standards |
|
|
200
|
+
| `toc` | Table of contents for rule selection |
|
|
201
|
+
| `typescript` | TypeScript best practices |
|
|
196
202
|
|
|
197
203
|
## 🛠️ Development
|
|
198
204
|
|