@vibe-agent-toolkit/vat-development-agents 0.1.20 → 0.1.21-rc.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.
- package/dist/.claude/plugins/marketplaces/vat-skills/.claude-plugin/marketplace.json +2 -2
- package/dist/.claude/plugins/marketplaces/vat-skills/plugins/{vat-development-agents → vibe-agent-toolkit}/.claude-plugin/plugin.json +1 -1
- package/dist/{skills/vibe-agent-toolkit__audit → .claude/plugins/marketplaces/vat-skills/plugins/vibe-agent-toolkit/skills/audit}/SKILL.md +1 -1
- package/dist/{skills/vibe-agent-toolkit__agent-authoring → .claude/plugins/marketplaces/vat-skills/plugins/vibe-agent-toolkit/skills/authoring}/SKILL.md +1 -1
- package/dist/{skills/vibe-agent-toolkit__debugging → .claude/plugins/marketplaces/vat-skills/plugins/vibe-agent-toolkit/skills/debugging}/SKILL.md +1 -1
- package/dist/.claude/plugins/marketplaces/vat-skills/plugins/vibe-agent-toolkit/skills/distribution/SKILL.md +335 -0
- package/dist/.claude/plugins/marketplaces/vat-skills/plugins/vibe-agent-toolkit/skills/distribution/resources/vat-install-architecture.md +229 -0
- package/dist/.claude/plugins/marketplaces/vat-skills/plugins/vibe-agent-toolkit/skills/install/SKILL.md +229 -0
- package/dist/.claude/plugins/marketplaces/vat-skills/plugins/{vat-development-agents/skills/vibe-agent-toolkit__resources → vibe-agent-toolkit/skills/resources}/SKILL.md +1 -1
- package/dist/.claude/plugins/marketplaces/vat-skills/plugins/{vat-development-agents → vibe-agent-toolkit}/skills/vibe-agent-toolkit/SKILL.md +10 -9
- package/dist/generated/resources/skills/SKILL.js +5 -5
- package/dist/generated/resources/skills/vat-agent-authoring.js +1 -1
- package/dist/generated/resources/skills/vat-audit.js +1 -1
- package/dist/generated/resources/skills/vat-debugging.js +1 -1
- package/dist/generated/resources/skills/vat-install-architecture.d.ts +28 -0
- package/dist/generated/resources/skills/vat-install-architecture.js +48 -0
- package/dist/generated/resources/skills/vat-resources.js +1 -1
- package/dist/generated/resources/skills/vat-skills-distribution.d.ts +3 -0
- package/dist/generated/resources/skills/vat-skills-distribution.js +27 -12
- package/dist/{.claude/plugins/marketplaces/vat-skills/plugins/vat-development-agents/skills/vibe-agent-toolkit__audit → skills/audit}/SKILL.md +1 -1
- package/dist/{.claude/plugins/marketplaces/vat-skills/plugins/vat-development-agents/skills/vibe-agent-toolkit__agent-authoring → skills/authoring}/SKILL.md +1 -1
- package/dist/{.claude/plugins/marketplaces/vat-skills/plugins/vat-development-agents/skills/vibe-agent-toolkit__debugging → skills/debugging}/SKILL.md +1 -1
- package/dist/skills/distribution/SKILL.md +335 -0
- package/dist/skills/distribution/resources/vat-install-architecture.md +229 -0
- package/dist/skills/install/SKILL.md +229 -0
- package/dist/skills/{vibe-agent-toolkit__resources → resources}/SKILL.md +1 -1
- package/dist/skills/vibe-agent-toolkit/SKILL.md +10 -9
- package/package.json +19 -9
- package/dist/.claude/plugins/marketplaces/vat-skills/plugins/vat-development-agents/skills/vibe-agent-toolkit__skills-distribution/SKILL.md +0 -228
- package/dist/skills/vibe-agent-toolkit__skills-distribution/SKILL.md +0 -228
- /package/dist/.claude/plugins/marketplaces/vat-skills/plugins/{vat-development-agents/skills/vibe-agent-toolkit → vibe-agent-toolkit/skills/authoring}/resources/agent-authoring.md +0 -0
- /package/dist/.claude/plugins/marketplaces/vat-skills/plugins/{vat-development-agents/skills/vibe-agent-toolkit → vibe-agent-toolkit/skills/authoring}/resources/orchestration.md +0 -0
- /package/dist/.claude/plugins/marketplaces/vat-skills/plugins/{vat-development-agents/skills/vibe-agent-toolkit__debugging → vibe-agent-toolkit/skills/debugging}/resources/CLAUDE.md +0 -0
- /package/dist/.claude/plugins/marketplaces/vat-skills/plugins/{vat-development-agents/skills/vibe-agent-toolkit__debugging → vibe-agent-toolkit/skills/debugging}/resources/debug-and-test-vat-fixes.md +0 -0
- /package/dist/.claude/plugins/marketplaces/vat-skills/plugins/{vat-development-agents/skills/vibe-agent-toolkit__debugging → vibe-agent-toolkit/skills/debugging}/resources/writing-tests.md +0 -0
- /package/dist/.claude/plugins/marketplaces/vat-skills/plugins/{vat-development-agents → vibe-agent-toolkit}/skills/vibe-agent-toolkit/resources/adding-runtime-adapters.md +0 -0
- /package/dist/.claude/plugins/marketplaces/vat-skills/plugins/{vat-development-agents/skills/vibe-agent-toolkit__agent-authoring → vibe-agent-toolkit/skills/vibe-agent-toolkit}/resources/agent-authoring.md +0 -0
- /package/dist/.claude/plugins/marketplaces/vat-skills/plugins/{vat-development-agents → vibe-agent-toolkit}/skills/vibe-agent-toolkit/resources/compiling-markdown-to-typescript.md +0 -0
- /package/dist/.claude/plugins/marketplaces/vat-skills/plugins/{vat-development-agents → vibe-agent-toolkit}/skills/vibe-agent-toolkit/resources/getting-started.md +0 -0
- /package/dist/.claude/plugins/marketplaces/vat-skills/plugins/{vat-development-agents/skills/vibe-agent-toolkit__agent-authoring → vibe-agent-toolkit/skills/vibe-agent-toolkit}/resources/orchestration.md +0 -0
- /package/dist/.claude/plugins/marketplaces/vat-skills/plugins/{vat-development-agents → vibe-agent-toolkit}/skills/vibe-agent-toolkit/resources/rag-usage-guide.md +0 -0
- /package/dist/skills/{vibe-agent-toolkit__agent-authoring → authoring}/resources/agent-authoring.md +0 -0
- /package/dist/skills/{vibe-agent-toolkit__agent-authoring → authoring}/resources/orchestration.md +0 -0
- /package/dist/skills/{vibe-agent-toolkit__debugging → debugging}/resources/CLAUDE.md +0 -0
- /package/dist/skills/{vibe-agent-toolkit__debugging → debugging}/resources/debug-and-test-vat-fixes.md +0 -0
- /package/dist/skills/{vibe-agent-toolkit__debugging → debugging}/resources/writing-tests.md +0 -0
|
@@ -6,9 +6,9 @@
|
|
|
6
6
|
},
|
|
7
7
|
"plugins": [
|
|
8
8
|
{
|
|
9
|
-
"name": "
|
|
9
|
+
"name": "vibe-agent-toolkit",
|
|
10
10
|
"description": "Development agents and skills for building with vibe-agent-toolkit",
|
|
11
|
-
"source": "../plugins/
|
|
11
|
+
"source": "../plugins/vibe-agent-toolkit",
|
|
12
12
|
"author": {
|
|
13
13
|
"name": "vibe-agent-toolkit contributors"
|
|
14
14
|
}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
name:
|
|
2
|
+
name: audit
|
|
3
3
|
description: Use when running vat audit to validate Claude plugins, agent skills, or marketplaces. Covers the audit command, --compat flag for surface compatibility analysis, --exclude for noise filtering, and interpreting audit output.
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
name:
|
|
2
|
+
name: authoring
|
|
3
3
|
description: Use when authoring SKILL.md files, designing agent architectures, or configuring packaging options. Covers SKILL.md structure, agent archetypes, orchestration patterns, and validation override patterns.
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -0,0 +1,335 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: distribution
|
|
3
|
+
description: Use when setting up vat build, configuring plugin distribution for the Claude ecosystem (marketplace, plugins, managed settings), npm publishing with postinstall hooks, or vat verify orchestration. Covers the full pipeline from skill source to installed plugin.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# VAT Distribution: Build, Publish & Install
|
|
7
|
+
|
|
8
|
+
## Scope
|
|
9
|
+
|
|
10
|
+
This skill covers the **file-based install method for Claude Code CLI** (`~/.claude/plugins/`).
|
|
11
|
+
This is the only install method VAT currently supports.
|
|
12
|
+
|
|
13
|
+
For the full install landscape — Claude Desktop paths, enterprise CI deployment,
|
|
14
|
+
Anthropic Cloud org management, MDM integration, and the `vat plugins uninstall`
|
|
15
|
+
design — see [Install & Uninstall Architecture](resources/vat-install-architecture.md).
|
|
16
|
+
|
|
17
|
+
## Overview
|
|
18
|
+
|
|
19
|
+
VAT distributes skills as **Claude plugins** via npm packages. The pipeline:
|
|
20
|
+
|
|
21
|
+
1. `vat build` compiles SKILL.md sources into plugin artifacts
|
|
22
|
+
2. `npm publish` pushes the package to a registry
|
|
23
|
+
3. `npm install` triggers a postinstall hook that registers the plugin in Claude Code's plugin system
|
|
24
|
+
|
|
25
|
+
Skills installed this way appear in Claude Code as `/plugin-name:skill-name`.
|
|
26
|
+
|
|
27
|
+
## Project Structure
|
|
28
|
+
|
|
29
|
+
```
|
|
30
|
+
my-project/
|
|
31
|
+
├── package.json ← vat.skills + postinstall hook + publishConfig
|
|
32
|
+
├── vibe-agent-toolkit.config.yaml ← skills: + claude: config
|
|
33
|
+
├── resources/
|
|
34
|
+
│ └── skills/
|
|
35
|
+
│ └── SKILL.md
|
|
36
|
+
└── dist/ ← generated by vat build
|
|
37
|
+
├── skills/my-skill/ ← packaged skill
|
|
38
|
+
└── .claude/plugins/marketplaces/
|
|
39
|
+
└── my-marketplace/plugins/my-plugin/
|
|
40
|
+
├── .claude-plugin/plugin.json
|
|
41
|
+
└── skills/my-skill/SKILL.md
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
## Step 1: package.json Configuration
|
|
45
|
+
|
|
46
|
+
```json
|
|
47
|
+
{
|
|
48
|
+
"name": "@myorg/my-skills",
|
|
49
|
+
"version": "1.0.0",
|
|
50
|
+
"vat": {
|
|
51
|
+
"version": "1.0",
|
|
52
|
+
"skills": ["my-skill"]
|
|
53
|
+
},
|
|
54
|
+
"dependencies": {
|
|
55
|
+
"vibe-agent-toolkit": "latest"
|
|
56
|
+
},
|
|
57
|
+
"scripts": {
|
|
58
|
+
"build:vat": "vat build",
|
|
59
|
+
"postinstall": "node ./node_modules/vibe-agent-toolkit/dist/bin/vat.js claude plugin install --npm-postinstall 2>/dev/null || exit 0"
|
|
60
|
+
},
|
|
61
|
+
"files": ["dist", "README.md"],
|
|
62
|
+
"publishConfig": {
|
|
63
|
+
"registry": "https://registry.npmjs.org"
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
**`vibe-agent-toolkit` must be in `dependencies` (not `devDependencies`)** so it is present in `node_modules` when the postinstall hook runs on the user's machine. Never assume `vat` is available globally — your users may not be developers.
|
|
69
|
+
|
|
70
|
+
The `vat.skills` array contains skill name strings for npm discoverability. Skill source paths and packaging config live in `vibe-agent-toolkit.config.yaml` (see Step 2).
|
|
71
|
+
|
|
72
|
+
For private GitHub Packages registry:
|
|
73
|
+
```json
|
|
74
|
+
"publishConfig": {
|
|
75
|
+
"registry": "https://npm.pkg.github.com",
|
|
76
|
+
"access": "restricted"
|
|
77
|
+
}
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
Users (or IT) installing from GitHub Packages need `.npmrc` configured with the scope registry and a read-only token:
|
|
81
|
+
```
|
|
82
|
+
@myorg:registry=https://npm.pkg.github.com
|
|
83
|
+
//npm.pkg.github.com/:_authToken=${GITHUB_TOKEN}
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
IT deploying to managed machines should pre-configure `.npmrc` at the system or user level before running install commands. End users do not need to understand npm or the registry — IT handles it once.
|
|
87
|
+
|
|
88
|
+
## Handling Plugin Renames: vat.replaces
|
|
89
|
+
|
|
90
|
+
> **Use this only when renaming a plugin, merging plugins, or cleaning up legacy flat-skill installs. Normal upgrades (same plugin name, same skills) do NOT need `vat.replaces` — the installer already overwrites the plugin directory on every install.**
|
|
91
|
+
|
|
92
|
+
### The problem: silent stale skills
|
|
93
|
+
|
|
94
|
+
When you rename a plugin or reorganize skills across packages, the old registration remains in Claude Code. Claude Code **does not warn you** when two plugins provide conflicting skill names — the first-registered (stale) skill silently wins. Users continue loading old content from the renamed plugin unless the old registration is explicitly removed.
|
|
95
|
+
|
|
96
|
+
This is the scenario where `vat.replaces` is needed:
|
|
97
|
+
- Plugin renamed: `old-plugin-name` → `new-plugin-name`
|
|
98
|
+
- Two old plugins merged into one new plugin
|
|
99
|
+
- Skills previously installed to `~/.claude/skills/<name>` (legacy pre-0.1.20 flat install) now delivered via the plugin tree
|
|
100
|
+
|
|
101
|
+
### How it works
|
|
102
|
+
|
|
103
|
+
When a VAT package is installed (via postinstall hook or `--dev`), the installer reads `vat.replaces` from `package.json` and — **before** installing the new plugin:
|
|
104
|
+
|
|
105
|
+
1. For each name in `replaces.plugins`: uninstalls `<name>@<marketplace>` — removes plugin directory, cache entry, registry entry, and `settings.json` entry
|
|
106
|
+
2. For each name in `replaces.flatSkills`: deletes `~/.claude/skills/<name>` — removes legacy pre-0.1.20 flat installs
|
|
107
|
+
|
|
108
|
+
Both operations are idempotent — "not found" is handled gracefully.
|
|
109
|
+
|
|
110
|
+
### Schema
|
|
111
|
+
|
|
112
|
+
```json
|
|
113
|
+
"vat": {
|
|
114
|
+
"version": "1.0",
|
|
115
|
+
"skills": ["authoring", "audit"],
|
|
116
|
+
"replaces": {
|
|
117
|
+
"plugins": ["my-old-plugin-name"],
|
|
118
|
+
"flatSkills": ["my-old-skill", "another-old-skill"]
|
|
119
|
+
}
|
|
120
|
+
}
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
Both `plugins` and `flatSkills` are optional arrays. The entire `replaces` key is optional — omit it when there is nothing to clean up.
|
|
124
|
+
|
|
125
|
+
### Real example: vat-development-agents 0.1.21
|
|
126
|
+
|
|
127
|
+
This package (`vat-development-agents`) renamed its plugin from `vat-development-agents` to `vibe-agent-toolkit` in v0.1.21. Without `vat.replaces`, users who had already installed v0.1.20 would have both `vat-development-agents@vat-skills` and `vibe-agent-toolkit@vat-skills` registered — Claude Code would serve stale skill content from the old plugin.
|
|
128
|
+
|
|
129
|
+
The fix in `package.json`:
|
|
130
|
+
|
|
131
|
+
```json
|
|
132
|
+
"vat": {
|
|
133
|
+
"version": "1.0",
|
|
134
|
+
"skills": ["vibe-agent-toolkit", "resources", "distribution", "authoring", "audit", "debugging", "install"],
|
|
135
|
+
"replaces": {
|
|
136
|
+
"plugins": ["vat-development-agents"],
|
|
137
|
+
"flatSkills": ["vibe-agent-toolkit", "resources"]
|
|
138
|
+
}
|
|
139
|
+
}
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
- `plugins`: removes the old plugin registration (same marketplace, old plugin name)
|
|
143
|
+
- `flatSkills`: removes legacy `~/.claude/skills/vibe-agent-toolkit` and `~/.claude/skills/resources` entries from users who installed before 0.1.20 switched to the plugin tree
|
|
144
|
+
|
|
145
|
+
### Non-obvious gotchas
|
|
146
|
+
|
|
147
|
+
**1. Plugin names in `replaces.plugins` have NO `@marketplace`**
|
|
148
|
+
|
|
149
|
+
The format is just the plugin name — e.g. `"vat-development-agents"` — NOT `"vat-development-agents@vat-skills"`. The installer infers the marketplace from the current package's dist tree. Using `@marketplace` syntax here would be wrong.
|
|
150
|
+
|
|
151
|
+
**2. `replaces.plugins` is for old plugin registrations, not for skills that moved between plugins**
|
|
152
|
+
|
|
153
|
+
If a skill moved from `plugin-a` to `plugin-b` within the same marketplace, list `"plugin-a"` in `replaces.plugins` to clean up the entire old plugin. You do not manage individual skills — you manage plugins.
|
|
154
|
+
|
|
155
|
+
**3. `replaces.flatSkills` is ONLY for the legacy `~/.claude/skills/` location**
|
|
156
|
+
|
|
157
|
+
This is specifically for skills that were previously installed as flat files to `~/.claude/skills/<name>` (pre-plugin-tree, before v0.1.20). Skills within the plugin tree (under `~/.claude/plugins/`) are handled via `replaces.plugins`. Do not mix them up.
|
|
158
|
+
|
|
159
|
+
**4. Normal upgrades need nothing**
|
|
160
|
+
|
|
161
|
+
If you publish a new version of the same package with the same plugin name, the installer overwrites the plugin directory automatically. `vat.replaces` is only for the case where the old name is different from the new name.
|
|
162
|
+
|
|
163
|
+
**5. The symptom is subtle and delayed**
|
|
164
|
+
|
|
165
|
+
You will not see an error. Claude Code simply loads the first-registered skill with a given name. If the stale plugin is registered first (alphabetically or by install order), your new content is invisible until you remove the old registration.
|
|
166
|
+
|
|
167
|
+
## Step 2: vibe-agent-toolkit.config.yaml
|
|
168
|
+
|
|
169
|
+
```yaml
|
|
170
|
+
version: 1
|
|
171
|
+
|
|
172
|
+
skills:
|
|
173
|
+
include:
|
|
174
|
+
- "resources/skills/**/SKILL.md"
|
|
175
|
+
|
|
176
|
+
claude:
|
|
177
|
+
marketplaces:
|
|
178
|
+
my-marketplace: # org/publisher identity
|
|
179
|
+
owner:
|
|
180
|
+
name: My Organization
|
|
181
|
+
plugins:
|
|
182
|
+
- name: my-plugin # installable unit
|
|
183
|
+
description: My plugin description
|
|
184
|
+
skills: "*" # all discovered skills
|
|
185
|
+
```
|
|
186
|
+
|
|
187
|
+
The `skills:` section discovers SKILL.md files via include/exclude globs. The `claude:` section defines how skills are packaged into plugins. Each marketplace has `owner` and `plugins` fields (strict schema — no extra fields).
|
|
188
|
+
|
|
189
|
+
**Naming convention:** marketplace = org identity (e.g. `acme`), plugin = this package
|
|
190
|
+
(e.g. `acme-tools`). Registers as `my-plugin@my-marketplace` in Claude's plugin registry.
|
|
191
|
+
|
|
192
|
+
### Multiple skills in one package
|
|
193
|
+
|
|
194
|
+
List all skills in `vat.skills` for npm discoverability:
|
|
195
|
+
|
|
196
|
+
```json
|
|
197
|
+
"vat": {
|
|
198
|
+
"version": "1.0",
|
|
199
|
+
"skills": ["my-linting", "my-testing"]
|
|
200
|
+
}
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
Use a selector in the plugin config to include matching skills:
|
|
204
|
+
|
|
205
|
+
```yaml
|
|
206
|
+
plugins:
|
|
207
|
+
- name: my-plugin
|
|
208
|
+
description: Linting and testing skills
|
|
209
|
+
skills:
|
|
210
|
+
- "my-linting"
|
|
211
|
+
- "my-testing"
|
|
212
|
+
```
|
|
213
|
+
|
|
214
|
+
Or use `"*"` to include all discovered skills in the plugin.
|
|
215
|
+
|
|
216
|
+
## Step 3: Build
|
|
217
|
+
|
|
218
|
+
```bash
|
|
219
|
+
vat build # skills phase then claude phase
|
|
220
|
+
vat verify # validates resources + skills + claude artifacts
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
### What vat build does
|
|
224
|
+
|
|
225
|
+
Two phases, run in dependency order:
|
|
226
|
+
|
|
227
|
+
1. **`vat skills build`** — reads `vibe-agent-toolkit.config.yaml skills:` section, discovers SKILL.md files via include/exclude globs, compiles each into `dist/skills/<name>/`
|
|
228
|
+
2. **`vat claude plugin build`** — reads `vibe-agent-toolkit.config.yaml claude:` section, wraps built skills into `dist/.claude/plugins/marketplaces/<mp>/plugins/<plugin>/` structure with `.claude-plugin/plugin.json`. Cleans stale output before each build.
|
|
229
|
+
|
|
230
|
+
Individual commands still work:
|
|
231
|
+
```bash
|
|
232
|
+
vat skills build # skills phase only
|
|
233
|
+
vat claude plugin build # claude plugin phase only (requires skills already built)
|
|
234
|
+
```
|
|
235
|
+
|
|
236
|
+
## Step 4: Publish
|
|
237
|
+
|
|
238
|
+
```bash
|
|
239
|
+
npm publish --tag next # RC/pre-release
|
|
240
|
+
npm publish # stable release
|
|
241
|
+
```
|
|
242
|
+
|
|
243
|
+
## Step 5: User Install
|
|
244
|
+
|
|
245
|
+
### Recommended: npm global install (postinstall runs automatically)
|
|
246
|
+
|
|
247
|
+
```bash
|
|
248
|
+
npm install -g @myorg/my-skills
|
|
249
|
+
```
|
|
250
|
+
|
|
251
|
+
The postinstall hook fires automatically and registers the plugin in Claude. This is the correct path for IT-managed deployments — no other tools required on the user's machine.
|
|
252
|
+
|
|
253
|
+
### Developer/IT one-off install via npx
|
|
254
|
+
|
|
255
|
+
```bash
|
|
256
|
+
npx vibe-agent-toolkit claude plugin install npm:@myorg/my-skills
|
|
257
|
+
```
|
|
258
|
+
|
|
259
|
+
Downloads and runs VAT via npx to install a package without a global install. Useful for CI, scripting, or testing from a developer machine. Requires the npm scope registry to be configured (`.npmrc`) if installing from a private registry.
|
|
260
|
+
|
|
261
|
+
### How plugin installation works
|
|
262
|
+
|
|
263
|
+
When `npm install` runs the postinstall hook (`node ./node_modules/vibe-agent-toolkit/dist/bin/vat.js claude plugin install --npm-postinstall`):
|
|
264
|
+
|
|
265
|
+
- VAT detects `dist/.claude/plugins/marketplaces/` directory in the installed package
|
|
266
|
+
- Copies the plugin tree to Claude's plugin directory (dumb recursive copy)
|
|
267
|
+
- Writes to these locations:
|
|
268
|
+
1. `~/.claude/plugins/marketplaces/<marketplace>/plugins/<plugin>/` — plugin files
|
|
269
|
+
2. `~/.claude/plugins/known_marketplaces.json` — marketplace registry
|
|
270
|
+
3. `~/.claude/plugins/cache/<marketplace>/<plugin>/<version>/` — version cache
|
|
271
|
+
4. `~/.claude/plugins/installed_plugins.json` — installation record
|
|
272
|
+
5. `~/.claude/settings.json` `enabledPlugins` — activates the plugin
|
|
273
|
+
|
|
274
|
+
If no `dist/.claude/plugins/marketplaces/` directory exists (package wasn't built before publish): a guidance message is emitted and the hook exits 0. The publisher must run `vat build` and re-publish.
|
|
275
|
+
|
|
276
|
+
Skills are then available in Claude Code as `/plugin-name:skill-name`.
|
|
277
|
+
|
|
278
|
+
## managed-settings.json Validation (Enterprise)
|
|
279
|
+
|
|
280
|
+
```yaml
|
|
281
|
+
claude:
|
|
282
|
+
managedSettings: managed-settings.json
|
|
283
|
+
```
|
|
284
|
+
|
|
285
|
+
`vat verify` validates this file against the ManagedSettings schema. Catches typos and schema errors before deployment. Does NOT deploy the file — deployment is a separate concern.
|
|
286
|
+
|
|
287
|
+
## --target claude-web (ZIP Upload)
|
|
288
|
+
|
|
289
|
+
For uploading skills directly to `claude.ai/settings/capabilities`:
|
|
290
|
+
|
|
291
|
+
```bash
|
|
292
|
+
vat skills package ./SKILL.md -o ./dist/ --target claude-web
|
|
293
|
+
```
|
|
294
|
+
|
|
295
|
+
Produces a ZIP:
|
|
296
|
+
```
|
|
297
|
+
my-skill.zip
|
|
298
|
+
└── my-skill/
|
|
299
|
+
├── SKILL.md # skill definition (required)
|
|
300
|
+
├── scripts/ # executable code (.mjs, .py, .sh) — optional
|
|
301
|
+
├── references/ # markdown reference material — optional
|
|
302
|
+
└── assets/ # static data, templates, config — optional
|
|
303
|
+
```
|
|
304
|
+
|
|
305
|
+
Configure source path mappings in `vibe-agent-toolkit.config.yaml`:
|
|
306
|
+
```yaml
|
|
307
|
+
skills:
|
|
308
|
+
include:
|
|
309
|
+
- "skills/**/SKILL.md"
|
|
310
|
+
config:
|
|
311
|
+
my-skill:
|
|
312
|
+
claudeWebTarget:
|
|
313
|
+
scripts: ["./src/helpers/**/*.ts"]
|
|
314
|
+
assets: ["./assets/**"]
|
|
315
|
+
```
|
|
316
|
+
|
|
317
|
+
TypeScript files in `scripts` are tree-shaken and compiled to standalone `.mjs`.
|
|
318
|
+
|
|
319
|
+
## Quick Reference
|
|
320
|
+
|
|
321
|
+
| Task | Command |
|
|
322
|
+
|---|---|
|
|
323
|
+
| Build everything | `vat build` |
|
|
324
|
+
| Verify everything | `vat verify` |
|
|
325
|
+
| Build skills only | `vat skills build` |
|
|
326
|
+
| Build claude plugin artifacts only | `vat claude plugin build` |
|
|
327
|
+
| Install via npm (end user) | `npm install -g @org/pkg` |
|
|
328
|
+
| Install via npx (developer/IT) | `npx vibe-agent-toolkit claude plugin install npm:@org/pkg` |
|
|
329
|
+
| List installed plugins | `vat claude plugin list` |
|
|
330
|
+
| Uninstall a plugin | `vat claude plugin uninstall --all` |
|
|
331
|
+
| Package for claude.ai upload | `vat skills package ./SKILL.md -o ./dist/ --target claude-web` |
|
|
332
|
+
|
|
333
|
+
## Future: Zero-Dependency Postinstall (Option B)
|
|
334
|
+
|
|
335
|
+
A planned improvement: `vat build` would bundle the plugin install logic into `dist/postinstall.js` — a fully self-contained script with no npm dependencies. The postinstall script would become simply `node ./dist/postinstall.js`. This eliminates `vibe-agent-toolkit` as a runtime dependency entirely, reducing install footprint for end users. Until then, Option C (runtime `vibe-agent-toolkit` dep) is the correct approach.
|
|
@@ -0,0 +1,229 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: install
|
|
3
|
+
description: Architecture reference for VAT skill/plugin install and uninstall — what is currently supported, what is not, and the full design vision across install methods (file-based, cloud, MDM, enterprise CI). Read this before designing or advising on any install/uninstall feature.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# VAT Skill Install & Uninstall: Architecture and Vision
|
|
7
|
+
|
|
8
|
+
## The Problem Space
|
|
9
|
+
|
|
10
|
+
Skills and plugins need to reach users' Claude installations through several distinct
|
|
11
|
+
delivery channels. Each channel has different operators (developers, IT, Anthropic),
|
|
12
|
+
different trust levels, and different UX requirements. VAT today only covers one of
|
|
13
|
+
these channels.
|
|
14
|
+
|
|
15
|
+
This document defines the full landscape, what VAT currently supports, what it does
|
|
16
|
+
not, and the architectural direction for each gap.
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
## Install Method Landscape
|
|
21
|
+
|
|
22
|
+
| Method | Operator | Current State | Notes |
|
|
23
|
+
|--------|----------|---------------|-------|
|
|
24
|
+
| **File-based: Code CLI** | Developer / IT | ✅ Supported | `~/.claude/plugins/` — only supported method |
|
|
25
|
+
| **File-based: Claude Desktop** | Developer / IT | ❌ Not supported | Different config path; same file structure expected |
|
|
26
|
+
| **npm postinstall** | IT / end-user | ✅ Supported | Requires `vibe-agent-toolkit` as runtime dep |
|
|
27
|
+
| **Managed settings file** | IT / Enterprise | ✅ Partial | `vat verify` validates; deployment is out of scope |
|
|
28
|
+
| **MDM-driven npm install** | IT | ✅ Works (via postinstall) | Jamf/SCCM/Intune runs `npm install -g` |
|
|
29
|
+
| **Anthropic Cloud / claude.ai org** | Org admin | ❌ Not supported | No API available; future Anthropic feature |
|
|
30
|
+
| **GitHub CI enterprise push** | IT / DevOps | ❌ Not supported | VAT design vision — see below |
|
|
31
|
+
| **Shared network registry** | IT | ❌ Not supported | Internal npm registry approach |
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
## What VAT Currently Supports
|
|
36
|
+
|
|
37
|
+
### File-based install: Claude Code CLI only
|
|
38
|
+
|
|
39
|
+
`vat skills install` and `vat skills uninstall` operate exclusively on:
|
|
40
|
+
```
|
|
41
|
+
~/.claude/
|
|
42
|
+
├── plugins/
|
|
43
|
+
│ ├── marketplaces/<marketplace>/plugins/<plugin>/ ← plugin files
|
|
44
|
+
│ ├── cache/<marketplace>/<plugin>/<version>/ ← version cache
|
|
45
|
+
│ ├── known_marketplaces.json
|
|
46
|
+
│ └── installed_plugins.json
|
|
47
|
+
├── skills/ ← legacy skills (no plugin system)
|
|
48
|
+
└── settings.json ← enabledPlugins, permissions
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
This is the **Claude Code CLI** configuration directory. It is the only path VAT
|
|
52
|
+
resolves. Claude Desktop uses a different path (see below) and is out of scope.
|
|
53
|
+
|
|
54
|
+
### Install sources (all resolve to the file-based method above)
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
# npm package (downloads, extracts, copies plugin tree)
|
|
58
|
+
vat skills install npm:@myorg/my-skills
|
|
59
|
+
|
|
60
|
+
# Local directory (copies plugin tree from local path)
|
|
61
|
+
vat skills install ./path/to/package
|
|
62
|
+
|
|
63
|
+
# ZIP file
|
|
64
|
+
vat skills install ./my-skills.zip
|
|
65
|
+
|
|
66
|
+
# npm postinstall hook (triggered by npm install -g)
|
|
67
|
+
# package.json: "postinstall": "node ./node_modules/vibe-agent-toolkit/dist/bin/vat.js skills install --npm-postinstall"
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
### Uninstall (current state)
|
|
71
|
+
|
|
72
|
+
`vat skills uninstall` removes skills from `~/.claude/skills/` only. It does NOT
|
|
73
|
+
remove plugin-system installs (the `~/.claude/plugins/` tree).
|
|
74
|
+
|
|
75
|
+
**A full `vat plugins uninstall` command does not yet exist.** See design notes below.
|
|
76
|
+
|
|
77
|
+
---
|
|
78
|
+
|
|
79
|
+
## What VAT Does NOT Support (and Why)
|
|
80
|
+
|
|
81
|
+
### Claude Desktop file-based installs
|
|
82
|
+
|
|
83
|
+
Claude Desktop on macOS uses `~/Library/Application Support/Claude/` rather than
|
|
84
|
+
`~/.claude/`. On Windows it uses `%APPDATA%\Claude\`.
|
|
85
|
+
|
|
86
|
+
**Why not supported today**: VAT's `getClaudeUserPaths()` is hardcoded to `~/.claude/`.
|
|
87
|
+
Extending it requires detecting which applications are installed and resolving both
|
|
88
|
+
paths. This is well-understood work with no architectural unknowns.
|
|
89
|
+
|
|
90
|
+
**Architectural note**: When implemented, both paths should be handled by a single
|
|
91
|
+
`getClaudeInstallTargets()` function returning multiple targets. CLI commands gain a
|
|
92
|
+
`--target code-cli|desktop|all` flag. Default is `code-cli` until Desktop path
|
|
93
|
+
handling is verified stable.
|
|
94
|
+
|
|
95
|
+
### Anthropic Cloud / claude.ai organization-level skills
|
|
96
|
+
|
|
97
|
+
Anthropic operates a cloud-based skill system for claude.ai. Organization admins can
|
|
98
|
+
manage skills for all users through the admin console. VAT has no integration with
|
|
99
|
+
this system today because Anthropic has not published a public API for programmatic
|
|
100
|
+
management.
|
|
101
|
+
|
|
102
|
+
**Architectural note**: When Anthropic publishes an org management API, VAT should
|
|
103
|
+
add `vat skills publish --target claude-ai` as a first-class install method. The
|
|
104
|
+
`dist/` artifacts from `vat build` are format-compatible with this target. The gap
|
|
105
|
+
is authentication and the API itself.
|
|
106
|
+
|
|
107
|
+
### GitHub CI enterprise push (vision)
|
|
108
|
+
|
|
109
|
+
The goal: a GitHub Actions workflow in a skills repository automatically deploys
|
|
110
|
+
skills to all users in an enterprise whenever a new version is merged to main.
|
|
111
|
+
|
|
112
|
+
This is a multi-layer problem with several viable approaches:
|
|
113
|
+
|
|
114
|
+
#### Approach A: MDM-integrated npm publish (recommended near-term)
|
|
115
|
+
```
|
|
116
|
+
GitHub Actions on release →
|
|
117
|
+
npm publish @myorg/my-skills →
|
|
118
|
+
MDM policy (Jamf/SCCM/Intune) detects new package version →
|
|
119
|
+
Runs: npm install -g @myorg/my-skills
|
|
120
|
+
→ postinstall hook installs plugin to user's ~/.claude/
|
|
121
|
+
```
|
|
122
|
+
VAT already supports this end-to-end. The MDM layer is outside VAT's scope and is
|
|
123
|
+
configured by IT using standard MDM software management policies. The VAT piece is
|
|
124
|
+
complete; IT must configure the npm-to-MDM trigger.
|
|
125
|
+
|
|
126
|
+
#### Approach B: Managed settings deployment (near-term, no MDM required)
|
|
127
|
+
```
|
|
128
|
+
GitHub Actions on release →
|
|
129
|
+
vat build &&
|
|
130
|
+
Generates managed-settings.json with plugin enablement →
|
|
131
|
+
Deploys managed-settings.json to shared network path or cloud storage →
|
|
132
|
+
Claude Code reads managed-settings.json at startup
|
|
133
|
+
```
|
|
134
|
+
`vat verify` validates `managed-settings.json` today. The deployment step is IT's
|
|
135
|
+
responsibility. This approach requires no per-machine npm install; Claude Code reads
|
|
136
|
+
the settings file directly if it is placed at the expected path or if the path is
|
|
137
|
+
configured.
|
|
138
|
+
|
|
139
|
+
**Gap**: VAT does not yet have a `vat claude deploy` command that handles the push
|
|
140
|
+
step. Adding this would require IT to configure cloud storage credentials once.
|
|
141
|
+
|
|
142
|
+
#### Approach C: Anthropic org API (long-term, requires Anthropic)
|
|
143
|
+
```
|
|
144
|
+
GitHub Actions on release →
|
|
145
|
+
vat skills publish --target claude-ai --org myorg →
|
|
146
|
+
Anthropic API activates skills for all org users in claude.ai
|
|
147
|
+
```
|
|
148
|
+
Blocked on Anthropic publishing an org management API. VAT's `dist/` output format
|
|
149
|
+
is already designed for this target.
|
|
150
|
+
|
|
151
|
+
---
|
|
152
|
+
|
|
153
|
+
## `vat plugins uninstall` — Design Intent
|
|
154
|
+
|
|
155
|
+
A `vat plugins uninstall <plugin>@<marketplace>` command should exist but does not yet.
|
|
156
|
+
|
|
157
|
+
### What it must reverse
|
|
158
|
+
|
|
159
|
+
Uninstalling a plugin installed via the file-based method requires reversing 5 artifacts:
|
|
160
|
+
|
|
161
|
+
1. Delete `~/.claude/plugins/marketplaces/<marketplace>/plugins/<plugin>/`
|
|
162
|
+
2. Delete `~/.claude/plugins/cache/<marketplace>/<plugin>/<version>/`
|
|
163
|
+
3. Remove `<plugin>@<marketplace>` from `installed_plugins.json`
|
|
164
|
+
4. Remove `<marketplace>` from `known_marketplaces.json` if no plugins remain
|
|
165
|
+
5. Remove `enabledPlugins[<plugin>@<marketplace>]` from `settings.json`
|
|
166
|
+
|
|
167
|
+
### Design decisions
|
|
168
|
+
|
|
169
|
+
- **Idempotent**: exit 0 if plugin not found — safe for IT automation scripts
|
|
170
|
+
- **Not-VAT-installed case**: if plugin directory exists but no registry entries, delete
|
|
171
|
+
the directory and clean settings.json; emit a warning that the plugin was not
|
|
172
|
+
installed via VAT
|
|
173
|
+
- **`--dry-run`**: show what would be deleted without deleting (follow `vat skills uninstall` pattern)
|
|
174
|
+
- **`--target`**: code-cli | desktop | all (default: code-cli until Desktop is implemented)
|
|
175
|
+
- **`vat plugins list`**: companion command to show installed plugins — needed for
|
|
176
|
+
discoverability before uninstalling
|
|
177
|
+
|
|
178
|
+
### Implementation location
|
|
179
|
+
|
|
180
|
+
Per the CLI "dumb orchestration" principle:
|
|
181
|
+
- Logic: `packages/claude-marketplace/src/install/plugin-uninstall.ts` (new file alongside plugin-registry.ts)
|
|
182
|
+
- CLI: `packages/cli/src/commands/plugins/uninstall.ts` (thin wrapper)
|
|
183
|
+
- New command group: `vat plugins` with subcommands `list` and `uninstall`
|
|
184
|
+
|
|
185
|
+
---
|
|
186
|
+
|
|
187
|
+
## Guidance for Adopters
|
|
188
|
+
|
|
189
|
+
### For end-user / IT-managed deployments (recommended)
|
|
190
|
+
|
|
191
|
+
Add `vibe-agent-toolkit` as a **runtime dependency** (not devDependencies) and use
|
|
192
|
+
the local node_modules binary in postinstall. Never assume `vat` is globally installed.
|
|
193
|
+
|
|
194
|
+
```json
|
|
195
|
+
{
|
|
196
|
+
"dependencies": { "vibe-agent-toolkit": "latest" },
|
|
197
|
+
"scripts": {
|
|
198
|
+
"postinstall": "node ./node_modules/vibe-agent-toolkit/dist/bin/vat.js skills install --npm-postinstall || exit 0"
|
|
199
|
+
}
|
|
200
|
+
}
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
IT runs: `npm install -g @myorg/my-skills` — no other tools required on the user's machine.
|
|
204
|
+
|
|
205
|
+
For private GitHub Packages registries, IT pre-configures `.npmrc` with a read-only
|
|
206
|
+
token for the `@myorg` scope. End users do not need to know about registries or tokens.
|
|
207
|
+
|
|
208
|
+
### For developer self-install
|
|
209
|
+
|
|
210
|
+
```bash
|
|
211
|
+
npx vibe-agent-toolkit skills install npm:@myorg/my-skills
|
|
212
|
+
```
|
|
213
|
+
|
|
214
|
+
### For enterprise CI (near-term best option)
|
|
215
|
+
|
|
216
|
+
Use Approach A (MDM-integrated npm publish) or Approach B (managed-settings deployment).
|
|
217
|
+
Both work today with no additional VAT features.
|
|
218
|
+
|
|
219
|
+
---
|
|
220
|
+
|
|
221
|
+
## What Is Out of Scope for VAT
|
|
222
|
+
|
|
223
|
+
VAT is a **packaging and local install tool**. The following are permanently out of scope:
|
|
224
|
+
|
|
225
|
+
- MDM software management configuration (Jamf, SCCM, Intune policies)
|
|
226
|
+
- Internal npm registry setup and authentication management
|
|
227
|
+
- Anthropic cloud API authentication or org provisioning
|
|
228
|
+
- Per-user credential management for private registries
|
|
229
|
+
- Claude Desktop configuration (until Desktop and Code CLI paths converge)
|