@esthernandez/vibe-cartographer 1.0.0 → 1.0.1
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/CHANGELOG.md +11 -0
- package/INSTALL.md +47 -20
- package/README.md +28 -18
- package/package.json +1 -1
- package/plugins/vibe-cartographer/.claude-plugin/plugin.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -9,6 +9,17 @@ All notable changes to this project are documented here. The format follows [Kee
|
|
|
9
9
|
|
|
10
10
|
- Nothing yet.
|
|
11
11
|
|
|
12
|
+
## [1.0.1] — 2026-04-15 — Install docs
|
|
13
|
+
|
|
14
|
+
### Changed
|
|
15
|
+
|
|
16
|
+
- **README and INSTALL rewritten** to document all three Claude Desktop install paths: **Add marketplace** (recommended — pulls from GitHub via `.claude-plugin/marketplace.json`), **npm install -g** (for Claude Code CLI / VS Code / JetBrains), and **Upload plugin** (for local iteration via `python scripts/build-plugin.py`).
|
|
17
|
+
- Added a **"Which option should I use?"** decision table mapping situation → recommended install path.
|
|
18
|
+
- Added a reproducible `scripts/build-plugin.py` build script that produces a `.plugin` bundle in `bundles/` for the upload-plugin path. Excludes `dist/`, `node_modules/`, `src/`, and other runtime/build artifacts per Cowork's plugin spec.
|
|
19
|
+
- GitHub releases now ship a pre-built `.plugin` file as a release asset for one-click downloads.
|
|
20
|
+
|
|
21
|
+
No behavior changes — this release exists so the npm-published README on `npmjs.com/package/@esthernandez/vibe-cartographer` reflects the marketplace install path.
|
|
22
|
+
|
|
12
23
|
## [1.0.0] — 2026-04-15 — Rebrand to Vibe Cartographer
|
|
13
24
|
|
|
14
25
|
The plugin formerly known as `@esthernandez/app-project-readiness` is now **Vibe Cartographer**. Same 8-command spec-driven workflow, same personas, same session memory — new name that actually says what the plugin does: *plot your course from idea to shipped app*.
|
package/INSTALL.md
CHANGED
|
@@ -8,42 +8,69 @@
|
|
|
8
8
|
|
|
9
9
|
## Install paths
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
Pick whichever matches how you're running Claude Code. All three lead to the same plugin working.
|
|
12
12
|
|
|
13
|
-
### Option 1:
|
|
13
|
+
### Option 1: Claude Desktop — Add marketplace (recommended)
|
|
14
|
+
|
|
15
|
+
The cleanest path. Pulls from GitHub directly, supports `Sync` to update, no file downloads.
|
|
16
|
+
|
|
17
|
+
1. Open Claude Desktop → **Personal plugins** panel (left sidebar)
|
|
18
|
+
2. Click the **+** button → **Add marketplace**
|
|
19
|
+
3. Enter: `estevanhernandez-stack-ed/vibe-cartographer`
|
|
20
|
+
4. Click **Sync**
|
|
21
|
+
|
|
22
|
+
Claude Desktop reads `.claude-plugin/marketplace.json` at the repo root, discovers the `vibe-cartographer` plugin inside `./plugins/vibe-cartographer`, and registers its slash commands. Updates propagate by clicking **Sync** again on the marketplace entry.
|
|
23
|
+
|
|
24
|
+
### Option 2: Claude Code CLI — npm
|
|
25
|
+
|
|
26
|
+
For users running Claude Code in a terminal, VS Code, or JetBrains.
|
|
14
27
|
|
|
15
28
|
```bash
|
|
16
29
|
npm install -g @esthernandez/vibe-cartographer
|
|
17
30
|
```
|
|
18
31
|
|
|
19
|
-
This drops the plugin files
|
|
32
|
+
This drops the plugin files at:
|
|
20
33
|
|
|
21
|
-
|
|
34
|
+
- **macOS/Linux:** `~/.npm-global/lib/node_modules/@esthernandez/vibe-cartographer/plugins/vibe-cartographer/`
|
|
35
|
+
- **Windows:** `%APPDATA%\npm\node_modules\@esthernandez\vibe-cartographer\plugins\vibe-cartographer\`
|
|
22
36
|
|
|
23
|
-
If
|
|
37
|
+
If your Claude Code CLI has a `plugin add <path>` command, point it at that path. Otherwise, use Option 1 (Add marketplace) — it works for CLI clients too because Claude Code reads marketplace entries from the global plugin config.
|
|
24
38
|
|
|
25
|
-
|
|
26
|
-
2. Click the **+** button → **Create plugin**.
|
|
27
|
-
3. Point it at a local clone of this repo (see Option 3 for the clone step).
|
|
28
|
-
4. The plugin's slash commands become available immediately — no restart required.
|
|
39
|
+
### Option 3: Claude Desktop — Upload plugin (for local iteration)
|
|
29
40
|
|
|
30
|
-
|
|
41
|
+
For testing changes locally before pushing them to GitHub.
|
|
31
42
|
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
```
|
|
43
|
+
1. Clone the repo:
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
git clone https://github.com/estevanhernandez-stack-ed/vibe-cartographer
|
|
47
|
+
cd vibe-cartographer
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
2. Build a `.plugin` bundle:
|
|
51
|
+
|
|
52
|
+
```bash
|
|
53
|
+
python scripts/build-plugin.py
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
This writes `bundles/vibe-cartographer-<version>.plugin` — a zip archive Cowork accepts directly. The script excludes `dist/`, `node_modules/`, `src/`, and other runtime/build artifacts per Cowork's plugin spec.
|
|
57
|
+
|
|
58
|
+
3. In Claude Desktop → **Personal plugins** → **+** → **Upload plugin**, pick the `.plugin` file.
|
|
35
59
|
|
|
36
|
-
|
|
60
|
+
You can also download a pre-built `.plugin` file from the [GitHub releases page](https://github.com/estevanhernandez-stack-ed/vibe-cartographer/releases) — each tagged release ships a ready-to-upload asset.
|
|
37
61
|
|
|
38
|
-
##
|
|
62
|
+
## Which option should I use?
|
|
39
63
|
|
|
40
|
-
|
|
64
|
+
| Situation | Option |
|
|
65
|
+
| ---------------------------------------------------- | --------------------------------------------------------------------------------- |
|
|
66
|
+
| I use Claude Desktop and want the simplest install | **Option 1** (Add marketplace) |
|
|
67
|
+
| I use Claude Code CLI / VS Code / JetBrains | **Option 2** (npm) — then use Option 1 in Claude Desktop if you also use it there |
|
|
68
|
+
| I'm developing or testing plugin changes locally | **Option 3** (Upload plugin) |
|
|
69
|
+
| I want to install without an internet connection | **Option 3** — download the `.plugin` from releases ahead of time |
|
|
41
70
|
|
|
42
|
-
|
|
43
|
-
- **Claude Code CLI** — if your version has a plugin-add command, point it at the install path. Otherwise clone the repo and rely on Claude Code's plugin discovery for folders in its known marketplace list.
|
|
44
|
-
- **VS Code / JetBrains** — Claude Code in your IDE reads from the same global plugin config as Claude Desktop. Install via Option 2 on Claude Desktop first and the IDE will pick it up on next launch.
|
|
71
|
+
## Verifying the install
|
|
45
72
|
|
|
46
|
-
**
|
|
73
|
+
**The plugin root is the folder that contains `.claude-plugin/plugin.json`.** In this repo that's `plugins/vibe-cartographer/`, not the repo root. Most install paths handle this automatically (marketplace manifest tells Claude Desktop where to look), but if you're troubleshooting, that's the folder to point at.
|
|
47
74
|
|
|
48
75
|
## Verification
|
|
49
76
|
|
package/README.md
CHANGED
|
@@ -54,40 +54,50 @@ See [`plugins/vibe-cartographer/architecture/`](plugins/vibe-cartographer/archit
|
|
|
54
54
|
|
|
55
55
|
## Install
|
|
56
56
|
|
|
57
|
-
Requires [Claude Code](https://claude.ai/code) or Claude Desktop with plugin support.
|
|
57
|
+
Requires [Claude Code](https://claude.ai/code) CLI or Claude Desktop with plugin support. Pick whichever path matches how you're running Claude Code — all three lead to the same plugin working inside a fresh project folder.
|
|
58
58
|
|
|
59
|
-
### Option 1:
|
|
59
|
+
### Option 1: Claude Desktop — Add marketplace (recommended)
|
|
60
|
+
|
|
61
|
+
The cleanest install. Pulls straight from GitHub, no file download, supports `Sync` to update.
|
|
62
|
+
|
|
63
|
+
1. Open Claude Desktop → **Personal plugins** panel
|
|
64
|
+
2. Click the **+** button → **Add marketplace**
|
|
65
|
+
3. Enter: `estevanhernandez-stack-ed/vibe-cartographer`
|
|
66
|
+
4. Click **Sync**
|
|
67
|
+
|
|
68
|
+
Claude Desktop reads `.claude-plugin/marketplace.json` at the repo root, loads the `vibe-cartographer` plugin from inside `./plugins/vibe-cartographer`, and the slash commands (`/onboard`, `/scope`, `/prd`, etc.) become available.
|
|
69
|
+
|
|
70
|
+
### Option 2: Claude Code CLI — npm
|
|
60
71
|
|
|
61
72
|
```bash
|
|
62
73
|
npm install -g @esthernandez/vibe-cartographer
|
|
63
74
|
```
|
|
64
75
|
|
|
65
|
-
|
|
76
|
+
The package ships the plugin files at `<npm-global>/node_modules/@esthernandez/vibe-cartographer/plugins/vibe-cartographer/`. If your Claude Code CLI has a plugin-add command, point it at that path; otherwise use Option 1 (Add marketplace) and the marketplace manifest will do the discovery for you.
|
|
66
77
|
|
|
67
|
-
|
|
68
|
-
- Windows: `%APPDATA%\npm\node_modules\@esthernandez\vibe-cartographer\plugins\vibe-cartographer`
|
|
78
|
+
### Option 3: Claude Desktop — Upload plugin
|
|
69
79
|
|
|
70
|
-
|
|
80
|
+
For local iteration before you push changes to GitHub.
|
|
71
81
|
|
|
72
|
-
1.
|
|
73
|
-
2.
|
|
74
|
-
3. Point it to the `plugins/vibe-cartographer` folder from this repo (cloned or downloaded).
|
|
75
|
-
4. The slash commands (`/onboard`, `/scope`, `/prd`, etc.) become available.
|
|
82
|
+
1. Clone the repo: `git clone https://github.com/estevanhernandez-stack-ed/vibe-cartographer`
|
|
83
|
+
2. Build a `.plugin` bundle:
|
|
76
84
|
|
|
77
|
-
|
|
85
|
+
```bash
|
|
86
|
+
python scripts/build-plugin.py
|
|
87
|
+
```
|
|
78
88
|
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
```
|
|
89
|
+
This writes `bundles/vibe-cartographer-<version>.plugin` — a zip archive Cowork accepts directly.
|
|
90
|
+
3. In Claude Desktop → **Personal plugins** → **+** → **Upload plugin**, pick the `.plugin` file.
|
|
82
91
|
|
|
83
|
-
|
|
92
|
+
Also available as a one-click download from the [GitHub releases page](https://github.com/estevanhernandez-stack-ed/vibe-cartographer/releases) — each release ships a pre-built `.plugin` file as a release asset.
|
|
84
93
|
|
|
85
94
|
### Migrating from `@esthernandez/app-project-readiness`
|
|
86
95
|
|
|
87
|
-
Vibe Cartographer is the rename of what was previously `@esthernandez/app-project-readiness` (v0.5.0 and earlier).
|
|
96
|
+
Vibe Cartographer is the rename of what was previously `@esthernandez/app-project-readiness` (v0.5.0 and earlier). Migration is automatic on first `/onboard` run:
|
|
88
97
|
|
|
89
|
-
- Your unified builder profile at `~/.claude/profiles/builder.json` gets its `plugins.app-project-readiness` block copied to `plugins.vibe-cartographer`
|
|
90
|
-
-
|
|
98
|
+
- Your unified builder profile at `~/.claude/profiles/builder.json` gets its `plugins.app-project-readiness` block copied to `plugins.vibe-cartographer` (old key preserved for one release as a safety net).
|
|
99
|
+
- Deep-legacy markdown profiles at `~/.claude/plugins/data/app-project-readiness/user-profile.md` also migrate.
|
|
100
|
+
- The old `@esthernandez/app-project-readiness` npm package is deprecated with a pointer. Run `npm install -g @esthernandez/vibe-cartographer` and uninstall the old one when you're ready.
|
|
91
101
|
- Legacy session logs at `~/.claude/plugins/data/app-project-readiness/sessions/` are left in place — append-only history isn't touched.
|
|
92
102
|
|
|
93
103
|
### Start the workflow
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@esthernandez/vibe-cartographer",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"description": "Vibe Cartographer — plot your course from idea to shipped app. Spec-driven development workflow as a Claude Code plugin, delivered as eight slash commands (onboard, scope, prd, spec, checklist, build, iterate, reflect).",
|
|
5
5
|
"author": "626Labs LLC",
|
|
6
6
|
"license": "MIT",
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "vibe-cartographer",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"description": "Vibe Cartographer — plot your course from idea to shipped app. Spec-driven development delivered as eight slash commands: onboard, scope, prd, spec, checklist, build, iterate, reflect.",
|
|
5
5
|
"author": {"name": "626Labs LLC"}
|
|
6
6
|
}
|