@esthernandez/vibe-doc 0.3.0 → 0.3.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/.claude-plugin/plugin.json +1 -1
- package/README.md +52 -8
- package/package.json +1 -1
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "vibe-doc",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.1",
|
|
4
4
|
"description": "AI-powered documentation gap analyzer. Scans your codebase, classifies your project, identifies missing technical documentation, and generates professional docs from your existing artifacts.",
|
|
5
5
|
"author": {
|
|
6
6
|
"name": "626Labs LLC"
|
package/README.md
CHANGED
|
@@ -21,21 +21,65 @@ The dual-layer design means you get intelligent recommendations in conversations
|
|
|
21
21
|
|
|
22
22
|
## Installation
|
|
23
23
|
|
|
24
|
-
|
|
24
|
+
Pick whichever matches how you're running Claude Code. All three lead to the same plugin working.
|
|
25
25
|
|
|
26
|
-
|
|
27
|
-
2. Search for "Vibe Doc"
|
|
28
|
-
3. Click Install
|
|
29
|
-
4. Navigate to your project directory and run `/scan` to begin
|
|
26
|
+
### Option 1: Claude Desktop — Add marketplace (recommended)
|
|
30
27
|
|
|
31
|
-
|
|
28
|
+
The cleanest install. Pulls straight from GitHub, no file download, supports `Sync` to update.
|
|
29
|
+
|
|
30
|
+
1. Open Claude Desktop → **Personal plugins** panel
|
|
31
|
+
2. Click the **+** button → **Add marketplace**
|
|
32
|
+
3. Enter: `estevanhernandez-stack-ed/Vibe-Doc`
|
|
33
|
+
4. Click **Sync**
|
|
34
|
+
|
|
35
|
+
Claude Desktop reads `.claude-plugin/marketplace.json` at the repo root and loads the `vibe-doc` plugin from inside `./packages/vibe-doc`. The slash commands (`/scan`, `/generate`, `/check`, `/status`) become available.
|
|
36
|
+
|
|
37
|
+
### Option 2: Claude Code CLI + terminal CLI — npm
|
|
38
|
+
|
|
39
|
+
The only path that gives you both the Claude Code plugin surface **and** a standalone `vibe-doc` binary you can run from any terminal.
|
|
32
40
|
|
|
33
41
|
```bash
|
|
34
42
|
npm install -g @esthernandez/vibe-doc
|
|
35
|
-
|
|
36
|
-
|
|
43
|
+
vibe-doc --version
|
|
44
|
+
# 0.3.0
|
|
37
45
|
```
|
|
38
46
|
|
|
47
|
+
Now you can run Vibe Doc either conversationally via Claude Code slash commands (install Option 1 alongside this), or deterministically from any shell:
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
cd ~/Projects/my-app
|
|
51
|
+
vibe-doc scan
|
|
52
|
+
vibe-doc generate adr
|
|
53
|
+
vibe-doc check --threshold 20
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
The dual-layer design means CI/CD pipelines use the CLI (reproducible, no conversational loop), and interactive sessions use the skills (agent-interviewed, conversational fill).
|
|
57
|
+
|
|
58
|
+
### Option 3: Claude Desktop — Upload plugin (for local iteration)
|
|
59
|
+
|
|
60
|
+
For testing plugin changes locally before pushing to GitHub.
|
|
61
|
+
|
|
62
|
+
1. Clone the repo: `git clone https://github.com/estevanhernandez-stack-ed/Vibe-Doc`
|
|
63
|
+
2. Build a `.plugin` bundle:
|
|
64
|
+
|
|
65
|
+
```bash
|
|
66
|
+
python scripts/build-plugin.py
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
This writes `bundles/vibe-doc-<version>.plugin` — a zip archive Cowork accepts directly. The script excludes `dist/`, `node_modules/`, and other runtime artifacts per Cowork's plugin spec.
|
|
70
|
+
3. In Claude Desktop → **Personal plugins** → **+** → **Upload plugin**, pick the `.plugin` file.
|
|
71
|
+
|
|
72
|
+
You can also download a pre-built `.plugin` file from the [GitHub releases page](https://github.com/estevanhernandez-stack-ed/Vibe-Doc/releases) — each tagged release ships a ready-to-upload asset.
|
|
73
|
+
|
|
74
|
+
### Which option should I use?
|
|
75
|
+
|
|
76
|
+
| Situation | Option |
|
|
77
|
+
| ------------------------------------------------------------ | ------------------------------------------------------------- |
|
|
78
|
+
| I want to use Vibe Doc conversationally in Claude Desktop | **Option 1** (Add marketplace) |
|
|
79
|
+
| I want the `vibe-doc` CLI available in my terminal / CI / IDE | **Option 2** (npm) — pair with Option 1 for full coverage |
|
|
80
|
+
| I'm developing or testing plugin changes locally | **Option 3** (Upload plugin) |
|
|
81
|
+
| I want to install without an internet connection | **Option 3** — download `.plugin` from releases ahead of time |
|
|
82
|
+
|
|
39
83
|
## Quick Start
|
|
40
84
|
|
|
41
85
|
### Step 1: Scan Your Project
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@esthernandez/vibe-doc",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.1",
|
|
4
4
|
"description": "AI-powered documentation gap analyzer and generator for modern codebases. Scans your project, classifies your architecture, and generates professional docs from your existing artifacts.",
|
|
5
5
|
"author": "626Labs LLC",
|
|
6
6
|
"license": "MIT",
|