@esthernandez/vibe-doc 0.3.0 → 0.3.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.
Files changed (4) hide show
  1. package/.claude-plugin/plugin.json +1 -1
  2. package/README.md +52 -8
  3. package/dist/index.js +19 -1
  4. package/package.json +10 -8
package/.claude-plugin/plugin.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "vibe-doc",
3
- "version": "0.3.0",
3
+ "version": "0.3.2",
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
- ### As a Cowork/Claude Code Plugin
24
+ Pick whichever matches how you're running Claude Code. All three lead to the same plugin working.
25
25
 
26
- 1. In Cowork or Claude Code, open the Plugins menu
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
- ### As a CLI
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
- # or
36
- npx @esthernandez/vibe-doc scan
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/dist/index.js CHANGED
@@ -37,10 +37,14 @@ var __importStar = (this && this.__importStar) || (function () {
37
37
  return result;
38
38
  };
39
39
  })();
40
+ var __importDefault = (this && this.__importDefault) || function (mod) {
41
+ return (mod && mod.__esModule) ? mod : { "default": mod };
42
+ };
40
43
  Object.defineProperty(exports, "__esModule", { value: true });
41
44
  const path = __importStar(require("path"));
42
45
  const fs = __importStar(require("fs"));
43
46
  const commander_1 = require("commander");
47
+ const update_notifier_1 = __importDefault(require("update-notifier"));
44
48
  const logger_1 = require("./utils/logger");
45
49
  const scanner_1 = require("./scanner");
46
50
  const state_1 = require("./state");
@@ -51,7 +55,21 @@ const templates_1 = require("./templates");
51
55
  const extractor_1 = require("./generator/extractor");
52
56
  const program = new commander_1.Command();
53
57
  const pkgJsonPath = path.resolve(__dirname, '..', 'package.json');
54
- const pkgVersion = JSON.parse(fs.readFileSync(pkgJsonPath, 'utf-8')).version;
58
+ const pkgContents = JSON.parse(fs.readFileSync(pkgJsonPath, 'utf-8'));
59
+ const pkgVersion = pkgContents.version;
60
+ // Check npm registry for a newer version of vibe-doc once per day.
61
+ // Runs in the background, non-blocking. If a newer version is available,
62
+ // update-notifier prints a boxed message on the NEXT invocation.
63
+ // Respects the NO_UPDATE_NOTIFIER env var and CI environments.
64
+ try {
65
+ (0, update_notifier_1.default)({
66
+ pkg: { name: pkgContents.name, version: pkgVersion },
67
+ updateCheckInterval: 1000 * 60 * 60 * 24, // 24 hours
68
+ }).notify({ defer: true, isGlobal: true });
69
+ }
70
+ catch {
71
+ // update-notifier failures should never block CLI usage — silently ignore
72
+ }
55
73
  program
56
74
  .name('vibe-doc')
57
75
  .description('AI-powered documentation gap analyzer for any codebase')
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@esthernandez/vibe-doc",
3
- "version": "0.3.0",
3
+ "version": "0.3.2",
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",
@@ -39,17 +39,19 @@
39
39
  },
40
40
  "dependencies": {
41
41
  "commander": "^11.1.0",
42
- "simple-git": "^3.22.0",
43
- "fast-glob": "^3.3.2",
44
- "docx": "^8.5.0",
45
42
  "diff": "^5.1.0",
46
- "marked": "^11.1.1"
43
+ "docx": "^8.5.0",
44
+ "fast-glob": "^3.3.2",
45
+ "marked": "^11.1.1",
46
+ "simple-git": "^3.22.0",
47
+ "update-notifier": "^7.3.1"
47
48
  },
48
49
  "devDependencies": {
49
- "typescript": "^5.3.3",
50
- "tsx": "^4.7.0",
50
+ "@types/diff": "^5.0.9",
51
51
  "@types/node": "^20.10.6",
52
- "@types/diff": "^5.0.9"
52
+ "@types/update-notifier": "^6.0.8",
53
+ "tsx": "^4.7.0",
54
+ "typescript": "^5.3.3"
53
55
  },
54
56
  "engines": {
55
57
  "node": ">=18.0.0"