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: INSTALL_TEST.md
+30-17Lines changed: 30 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,33 +11,26 @@ Use this to run **P0-3** from [SPRINT_PLAN.md](./SPRINT_PLAN.md): confirm the pl
11
11
12
12
---
13
13
14
-
## Option A: Install from GitHub (recommended)
14
+
## Option A: Install from marketplace (only way `/add-plugin` works)
15
15
16
-
Use this if your plugin repo is on GitHub (e.g. `sonatype/sonatype-guide-cursor-plugin` or your fork).
16
+
**Why `/add-plugin` with a GitHub URL does nothing:** Cursor only installs plugins that are **on the Cursor Marketplace**. Typing `/add-plugin sonatype/sonatype-guide-cursor-plugin` or a GitHub URL gives **no response** because the plugin is not in the marketplace yet.
17
17
18
-
1.**Push the plugin to GitHub** (if not already):
19
-
- Create a repo and push this project.
20
-
- Repo root must contain `.cursor-plugin/plugin.json`, `skills/`, `rules/`, `agents/`, `mcp.json`, etc.
2. After approval, Cursor will list it on the marketplace (with a slug like `sonatype-guide`).
23
+
3.**Then** users can run `/add-plugin sonatype-guide` in chat or install via **Settings → Plugins → Browse Marketplace**.
31
24
32
-
3.**Confirm install:**The plugin should appear in your installed plugins. Enable it if there’s a toggle.
25
+
Until then, use **Option B**(local path) or **Option C** (clone into cache) below.
33
26
34
27
---
35
28
36
29
## Option B: Local install (for testing without publishing)
37
30
38
31
Use this to test the plugin from your machine without pushing to GitHub.
39
32
40
-
**Note:** Plugins added via the `local` section of `installed.json` may **not appear** in Settings → Plugins. Cursor’s UI typically lists plugins installed from the marketplace or by URL. If you need the plugin to show in the Installed list and have MCP/skills load, use **Option A (GitHub)** instead.
33
+
**Note:** Plugins added via the `local` section of `installed.json` may **not appear** in Settings → Plugins. If the plugin still doesn’t show or load, try **Option C** (clone into cache) or submit to the marketplace (Option A).
41
34
42
35
1.**Back up Cursor’s plugin list** (optional but recommended):
43
36
```bash
@@ -51,7 +44,7 @@ Use this to test the plugin from your machine without pushing to GitHub.
51
44
```
52
45
This script adds `sonatype-guide` to the `local` section of `~/.cursor/plugins/installed.json` (no copy to cache).
53
46
54
-
3.**Restart Cursor.** The plugin may still not appear under Installed; if so, install via GitHub (Option A).
47
+
3.**Restart Cursor.** The plugin may still not appear under Installed.
55
48
56
49
4.**Uninstall (revert) when done testing:**
57
50
```bash
@@ -60,6 +53,26 @@ Use this to test the plugin from your machine without pushing to GitHub.
60
53
61
54
---
62
55
56
+
## Option C: Clone into Cursor’s URL cache (experimental)
57
+
58
+
Cursor stores URL-installed plugins under `~/.cursor/plugins/cache/url/`. You can try copying this repo into that structure so Cursor might pick it up.
59
+
60
+
1.**Run the install-from-GitHub script** (clones into cache and adds to `user` list):
61
+
```bash
62
+
cd /Users/moliverio/projects/sonatype-guide-cursor
63
+
./scripts/install-from-github-to-cache.sh
64
+
```
65
+
2.**Restart Cursor** and check **Settings → Plugins** for Sonatype Guide.
66
+
3. If it doesn’t appear, the only reliable path is **Option A** (submit to marketplace).
**Important:**`/add-plugin` with a GitHub URL or `owner/repo`**does nothing** in Cursor (no response). Cursor only installs plugins that are on the **Cursor Marketplace**. So you must either submit this plugin at [cursor.com/marketplace/publish](https://cursor.com/marketplace/publish) first, or use a workaround below.
8
+
9
+
**After the plugin is on the marketplace**, in Cursor chat run:
10
+
11
+
```
8
12
/add-plugin sonatype-guide
9
13
```
10
14
15
+
**Workarounds before it’s published:**
16
+
17
+
-**Local / cache:** See [INSTALL_TEST.md](INSTALL_TEST.md) — Option B (local path in `installed.json`) or Option C (clone into Cursor’s plugin cache).
0 commit comments