cursor-kit-cli 1.0.3 → 1.0.4-beta.2

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 CHANGED
@@ -25,6 +25,15 @@ npm install -g cursor-kit-cli
25
25
  npx cursor-kit-cli init
26
26
  ```
27
27
 
28
+ **CLI Aliases:** `cursor-kit`, `cursorkit`, or `ck`
29
+
30
+ ```bash
31
+ # All of these work
32
+ cursor-kit init
33
+ cursorkit init
34
+ ck init
35
+ ```
36
+
28
37
  ## ✨ Features
29
38
 
30
39
  - **📜 Commands** - Reusable prompt templates for common tasks
@@ -95,43 +104,53 @@ After running `cursor-kit init`, your project will have:
95
104
  ```
96
105
  your-project/
97
106
  └── .cursor/
98
- ├── commands/ # Prompt templates
107
+ ├── commands/ # Prompt templates (.md)
108
+ │ ├── debug.md
109
+ │ ├── docs.md
110
+ │ ├── explain.md
111
+ │ ├── fix.md
99
112
  │ ├── implementation.md
100
113
  │ ├── refactor.md
101
114
  │ ├── review.md
102
- │ ├── debug.md
103
- │ ├── explain.md
104
115
  │ └── test.md
105
- └── rules/ # AI behavior rules
106
- ├── typescript.mdc
107
- ├── react.mdc
108
- ├── testing.mdc
116
+ └── rules/ # AI behavior rules (.mdc)
117
+ ├── coding-style.mdc
118
+ ├── frontend-design-skills.mdc
109
119
  ├── git.mdc
120
+ ├── performance.mdc
121
+ ├── react.mdc
110
122
  ├── security.mdc
111
- └── performance.mdc
123
+ ├── testing.mdc
124
+ └── typescript.mdc
112
125
  ```
113
126
 
114
127
  ## 🎯 Included Templates
115
128
 
116
129
  ### Commands
130
+
117
131
  | Command | Description |
118
132
  |---------|-------------|
133
+ | `debug` | Systematic bug investigation |
134
+ | `docs` | Create or update documentation |
135
+ | `explain` | Clear technical explanations |
136
+ | `fix` | Diagnose and fix bugs with root cause analysis |
119
137
  | `implementation` | Convert feature ideas into actionable plans |
120
138
  | `refactor` | Improve code quality without changing behavior |
121
139
  | `review` | Comprehensive code review checklist |
122
- | `debug` | Systematic bug investigation |
123
- | `explain` | Clear technical explanations |
124
140
  | `test` | Generate comprehensive test suites |
125
141
 
126
142
  ### Rules
143
+
127
144
  | Rule | Description |
128
145
  |------|-------------|
129
- | `typescript` | TypeScript best practices |
130
- | `react` | React component patterns |
131
- | `testing` | Testing standards |
146
+ | `coding-style` | Core coding conventions and best practices |
147
+ | `frontend-design-skills` | Typography, aesthetics, and UI guidelines |
132
148
  | `git` | Commit and branching conventions |
149
+ | `performance` | Performance optimization patterns |
150
+ | `react` | React component patterns |
133
151
  | `security` | Security guidelines |
134
- | `performance` | Performance optimization |
152
+ | `testing` | Testing standards |
153
+ | `typescript` | TypeScript best practices |
135
154
 
136
155
  ## 🛠️ Development
137
156
 
@@ -141,15 +160,22 @@ git clone https://github.com/duongductrong/cursor-kit.git
141
160
  cd cursor-kit
142
161
 
143
162
  # Install dependencies
144
- npm install
163
+ pnpm install
145
164
 
146
165
  # Build
147
- npm run build
166
+ pnpm build
148
167
 
149
168
  # Run locally
150
- node dist/cli.mjs
169
+ node dist/cli.js
170
+
171
+ # Development mode (watch)
172
+ pnpm dev
151
173
  ```
152
174
 
175
+ ### Requirements
176
+
177
+ - Node.js >= 18.0.0
178
+
153
179
  ## 📄 License
154
180
 
155
181
  MIT © [duongductrong](https://github.com/duongductrong)
@@ -159,4 +185,3 @@ MIT © [duongductrong](https://github.com/duongductrong)
159
185
  <p align="center">
160
186
  Made with ♥ for the Cursor community
161
187
  </p>
162
-
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "cursor-kit-cli",
3
- "version": "1.0.3",
3
+ "version": "1.0.4-beta.2",
4
4
  "description": "CLI toolkit to manage Cursor IDE rules and commands",
5
5
  "type": "module",
6
6
  "exports": {
@@ -0,0 +1,42 @@
1
+ You are a technical writer. Create or update documentation that is clear, accurate, and synced with the codebase.
2
+
3
+ ## WORKFLOW
4
+
5
+ ### Creating New Docs
6
+ 1. Analyze the code/feature to document
7
+ 2. Determine the appropriate doc type
8
+ 3. Write with examples from actual code
9
+
10
+ ### Updating Existing Docs
11
+ 1. Read the existing documentation first
12
+ 2. Compare against current codebase state
13
+ 3. Identify outdated info (APIs, params, examples)
14
+ 4. Update in place - preserve structure, fix content
15
+
16
+ ## DOCUMENTATION TYPES
17
+
18
+ | Type | Purpose |
19
+ |------|---------|
20
+ | **README** | Project overview, quick start, installation |
21
+ | **API Docs** | Function signatures, parameters, return types, examples |
22
+ | **Guide** | Step-by-step tutorials, how-tos |
23
+ | **Reference** | Complete technical specifications |
24
+ | **Changelog** | Version history, breaking changes |
25
+
26
+ ## WRITING PRINCIPLES
27
+
28
+ - **Clarity** - Simple language, avoid jargon
29
+ - **Accuracy** - Must match actual code behavior
30
+ - **Examples** - Real, runnable code from the codebase
31
+ - **Structure** - Headings, lists, tables for scannability
32
+
33
+ ## RULES
34
+
35
+ - Always verify against current code before writing
36
+ - Keep concise - no fluff
37
+ - Update in place, don't duplicate
38
+ - Match existing documentation style
39
+ - Include type information for APIs
40
+
41
+ START: What would you like me to document?
42
+