4runr-cursor-setup 0.1.17 → 0.1.18

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.
Files changed (2) hide show
  1. package/README.md +109 -7
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,6 +1,34 @@
1
1
  # 4runr-cursor-setup
2
2
 
3
- **Full Git usage guide:** [docs/USAGE_GIT.md](docs/USAGE_GIT.md)
3
+ **Documentation:**
4
+ - [Command Reference](docs/COMMANDS.md) — Complete command and flag documentation
5
+ - [Git Usage Guide](docs/USAGE_GIT.md) — End-to-end Git repo usage guide
6
+
7
+ ## New Repo Quick Start
8
+
9
+ **PowerShell:**
10
+ ```powershell
11
+ # Step 1: Repair / normalize repo (safe)
12
+ npx -y 4runr-cursor-setup@latest doctor --fix --purge-orphans --strict
13
+
14
+ # Step 2: Install core commands
15
+ npx -y 4runr-cursor-setup@latest add core
16
+
17
+ # Step 3: Verify health
18
+ npx -y 4runr-cursor-setup@latest doctor --strict
19
+ ```
20
+
21
+ **Bash:**
22
+ ```bash
23
+ # Step 1: Repair / normalize repo (safe)
24
+ npx -y 4runr-cursor-setup@latest doctor --fix --purge-orphans --strict
25
+
26
+ # Step 2: Install core commands
27
+ npx -y 4runr-cursor-setup@latest add core
28
+
29
+ # Step 3: Verify health
30
+ npx -y 4runr-cursor-setup@latest doctor --strict
31
+ ```
4
32
 
5
33
  ## Golden Path
6
34
 
@@ -72,26 +100,100 @@ npx -y 4runr-cursor-setup@latest add core --dry-run
72
100
  - `governance`: Governance commands (decision, scope-change)
73
101
  - `debugging`: Debugging commands (repro, verify)
74
102
 
75
- ## Troubleshooting
103
+ ## Common Scenarios
76
104
 
77
- ### npx Cache Issues
105
+ ### "0 files written" When Adding a Group
78
106
 
79
- If `npx -y 4runr-cursor-setup@latest` fails with `ETARGET` but the version exists on npm:
107
+ **Reasons and exact next steps:**
80
108
 
81
- This is an npx cache desync. Clear the cache and retry:
109
+ 1. **Already installed and managed** (normal)
110
+ - Files exist, have marker, and are in manifest
111
+ - **Action:** Nothing to do. This is expected.
82
112
 
83
- **PowerShell:**
113
+ 2. **Orphan marker files**
114
+ - Files have marker but aren't in manifest
115
+ - **Fix:**
116
+ ```bash
117
+ npx -y 4runr-cursor-setup@latest doctor --purge-orphans
118
+ npx -y 4runr-cursor-setup@latest add planning
119
+ ```
120
+ (Replace `planning` with the actual group name)
121
+
122
+ 3. **Unmanaged collision**
123
+ - Files exist without marker (user-created)
124
+ - Tool will never overwrite these
125
+ - **Fix (manual):**
126
+ ```bash
127
+ # Rename or move the colliding file
128
+ mv .cursor/commands/4runr-start.md .cursor/commands/4runr-start.md.backup
129
+ # Then re-run add
130
+ npx -y 4runr-cursor-setup@latest add core
131
+ ```
132
+
133
+ ### Orphan Marker Files
134
+
135
+ **What they are:**
136
+ - Files in `.cursor/commands/` with the managed marker (`<!-- managed-by: 4runr-cursor-setup -->`) but not listed in the manifest
137
+
138
+ **Why they exist:**
139
+ - Manifest was deleted or reset
140
+ - Files were manually created with marker
141
+ - Manifest drift
142
+
143
+ **Fix:**
144
+ ```bash
145
+ npx -y 4runr-cursor-setup@latest doctor --purge-orphans
146
+ ```
147
+
148
+ **What it does:**
149
+ - Deletes only orphan marker files (safe)
150
+ - Never deletes managed files or unmarked files
151
+
152
+ ### Unmanaged Collision
153
+
154
+ **What it is:**
155
+ - A file exists at a path where the tool wants to install a template, but the file doesn't have the managed marker
156
+
157
+ **Why it happens:**
158
+ - User created a file manually
159
+ - File was created before tool installation
160
+
161
+ **Resolution (manual):**
162
+ 1. Rename or move the colliding file:
163
+ ```bash
164
+ mv .cursor/commands/4runr-start.md .cursor/commands/4runr-start.md.backup
165
+ ```
166
+ 2. Re-run add:
167
+ ```bash
168
+ npx -y 4runr-cursor-setup@latest add core
169
+ ```
170
+
171
+ **Important:** The tool will never overwrite unmanaged files, even with `--force`.
172
+
173
+ ### ETARGET / npx Cache Desync
174
+
175
+ **Symptom:**
176
+ - `npx -y 4runr-cursor-setup@latest` fails with `ETARGET` but the version exists on npm
177
+
178
+ **Cause:**
179
+ - npx cache is out of sync with npm registry
180
+
181
+ **Fix (PowerShell):**
84
182
  ```powershell
85
183
  npm cache clean --force
86
184
  Remove-Item -Recurse -Force "$env:LOCALAPPDATA\npm-cache\_npx" -ErrorAction SilentlyContinue
87
185
  ```
88
186
 
89
- **Bash:**
187
+ **Fix (Bash):**
90
188
  ```bash
91
189
  npm cache clean --force
92
190
  rm -rf ~/.npm/_npx
93
191
  ```
94
192
 
193
+ **Then retry your command.**
194
+
195
+ ## Troubleshooting
196
+
95
197
  ### PowerShell Error: The '<' operator is reserved for future use
96
198
 
97
199
  **Cause:** Copied placeholder like `GROUP` from documentation without replacing it.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "4runr-cursor-setup",
3
- "version": "0.1.17",
3
+ "version": "0.1.18",
4
4
  "description": "",
5
5
  "main": "index.js",
6
6
  "scripts": {