vskill 0.1.27 → 0.1.28

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 (2) hide show
  1. package/README.md +112 -24
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -3,21 +3,9 @@
3
3
  **Secure multi-platform AI skill installer.** Scan before you install.
4
4
 
5
5
  ```bash
6
- # npm
7
- npx vskill find remotion # search the registry
8
- npx vskill install remotion-dev/skills # install after security scan
9
-
10
- # bun
11
- bunx vskill find remotion
12
- bunx vskill install remotion-dev/skills
13
-
14
- # pnpm
15
- pnpx vskill find remotion
16
- pnpx vskill install remotion-dev/skills
17
-
18
- # yarn
19
- yarn dlx vskill find remotion
20
- yarn dlx vskill install remotion-dev/skills
6
+ npx vskill install remotion-dev/skills # all skills from a repo
7
+ npx vskill install remotion-dev/skills/remotion-best-practices # specific skill (3-part)
8
+ npx vskill install remotion-best-practices # registry lookup
21
9
  ```
22
10
 
23
11
  ## Why?
@@ -28,22 +16,122 @@ yarn dlx vskill install remotion-dev/skills
28
16
 
29
17
  vskill fixes this with **three-tier verification** and **version-pinned trust**.
30
18
 
31
- ## Commands
19
+ ## Install Formats
20
+
21
+ ### 1. All skills from a repo
22
+
23
+ ```bash
24
+ vskill install remotion-dev/skills
25
+ ```
26
+
27
+ Discovers all SKILL.md files in the repo via GitHub Trees API. You'll be prompted to select which skills to install.
28
+
29
+ ### 2. Specific skill (3-part format)
30
+
31
+ ```bash
32
+ vskill install remotion-dev/skills/remotion-best-practices
33
+ ```
34
+
35
+ Installs a single skill directly. The path maps to `owner/repo/skill-name`, where `skill-name` is the directory containing `SKILL.md`.
36
+
37
+ ### 3. Specific skill (flag format)
38
+
39
+ ```bash
40
+ vskill install remotion-dev/skills --skill remotion-best-practices
41
+ ```
42
+
43
+ Equivalent to the 3-part format above.
44
+
45
+ ### 4. Registry lookup
46
+
47
+ ```bash
48
+ vskill install remotion-best-practices
49
+ ```
50
+
51
+ Looks up the skill in the [verified-skill.com](https://verified-skill.com) registry and installs from the mapped source repo.
52
+
53
+ ### 5. Local plugin
54
+
55
+ ```bash
56
+ vskill install . --plugin-dir . --plugin sw-frontend
57
+ ```
58
+
59
+ Installs a plugin from a local directory containing `.claude-plugin/marketplace.json`. The `--plugin` flag selects which sub-plugin to install.
60
+
61
+ ### 6. Remote plugin
32
62
 
33
63
  ```bash
34
- vskill find <query> # Search the registry (alias: search)
35
- vskill install <source> # Install skill after security scan (alias: add, i)
36
- vskill scan <source> # Scan without installing
37
- vskill list # Show installed skills with status
38
- vskill submit <source> # Submit for verification (owner/repo or GitHub URL)
39
- vskill update # Update with diff scanning
64
+ vskill install . --repo specweave/specweave --plugin sw-frontend
40
65
  ```
41
66
 
67
+ Clones a GitHub repo and installs a plugin from it. Combines `--repo` with `--plugin` to target a specific sub-plugin.
68
+
42
69
  > Replace `vskill` with `npx vskill`, `bunx vskill`, `pnpx vskill`, or `yarn dlx vskill` if not installed globally.
43
70
 
44
- ## 39 Agent Platforms
71
+ ## Interactive Prompts
72
+
73
+ When run in a terminal, vskill prompts you interactively:
74
+
75
+ - **Agent selection** — checkboxes for detected AI agents (pre-checked). Supports 49 agents with scrolling viewport.
76
+ - **Scope** — Project (`./<agent>/commands/`) or Global (`~/.<agent>/commands/`)
77
+ - **Method** — Symlink (default, saves disk) or Copy (for agents that need it)
78
+ - **Skill selection** — when a repo has multiple skills, pick which ones to install
79
+ - **Claude Code native plugin** — when installing a plugin with Claude Code detected, choose native plugin install (recommended) or skill extraction
80
+
81
+ All prompts can be skipped with `--yes` (accept defaults) or controlled via flags (`--global`, `--copy`, `--agent`).
82
+
83
+ ## Commands
84
+
85
+ | Command | Description |
86
+ |---------|-------------|
87
+ | `install <source>` | Install skill after security scan (aliases: `add`, `i`) |
88
+ | `find <query>` | Search the registry (alias: `search`) |
89
+ | `scan <path>` | Scan without installing |
90
+ | `list` | Show installed skills with status |
91
+ | `remove <skill>` | Remove an installed skill |
92
+ | `update [skill]` | Update with diff scanning |
93
+ | `submit <source>` | Submit for verification |
94
+ | `audit [path]` | Security audit with LLM analysis |
95
+ | `info <skill>` | Show skill details |
96
+ | `blocklist` | Manage blocked skills |
97
+ | `init` | Initialize vskill in a project |
98
+
99
+ ### Install flags
100
+
101
+ | Flag | Description |
102
+ |------|-------------|
103
+ | `--yes` / `-y` | Accept all defaults, no prompts |
104
+ | `--global` / `-g` | Install to global scope |
105
+ | `--copy` | Copy files instead of symlinking |
106
+ | `--skill <name>` | Select a specific skill from a multi-skill repo |
107
+ | `--plugin <name>` | Select a sub-plugin from a plugin repo |
108
+ | `--plugin-dir <path>` | Use a local directory as plugin source |
109
+ | `--repo <owner/repo>` | Use a remote GitHub repo as plugin source |
110
+ | `--agent <id>` | Target a specific agent (e.g., `--agent cursor`) |
111
+ | `--force` | Install even if blocklisted |
112
+ | `--cwd <path>` | Override project root directory |
113
+
114
+ ## Skills vs Plugins
115
+
116
+ **Skills** are single SKILL.md files that work with any AI agent. They follow the [Agent Skills Standard](https://agentskills.io) — a SKILL.md file is placed in the agent's commands directory (e.g., `.claude/commands/`, `.cursor/commands/`).
117
+
118
+ **Plugins** are multi-component containers exclusive to Claude Code. A plugin repo has `.claude-plugin/marketplace.json` listing sub-plugins, each containing skills, hooks, commands, and agents. Plugins enable `plugin-name:skill-name` namespacing, enable/disable support, and marketplace integration.
119
+
120
+ ## Claude Code Native Plugin Install
121
+
122
+ When vskill detects a plugin repo and Claude Code is among your selected agents, it offers **native plugin install**:
123
+
124
+ 1. vskill runs its security scan first (always)
125
+ 2. Registers the plugin directory as a marketplace: `claude plugin marketplace add <path>`
126
+ 3. Installs the plugin natively: `claude plugin install <plugin>@<marketplace>`
127
+
128
+ **Benefits**: `marketplace:plugin-name` namespacing, `claude plugin enable/disable`, marketplace management.
129
+
130
+ Native install is available for local plugins (`--plugin-dir`) only. Remote plugins (`--repo`) fall back to skill extraction. Use `--copy` to skip native install and extract skills individually.
131
+
132
+ ## 49 Agent Platforms
45
133
 
46
- Works across Claude Code, Cursor, GitHub Copilot, Windsurf, Codex, Gemini CLI, Cline, Amp, Roo Code, and 30 more.
134
+ Works across Claude Code, Cursor, GitHub Copilot, Windsurf, Codex, Gemini CLI, Cline, Amp, Roo Code, and 40 more — including universal agents (VS Code, JetBrains, Zed, Neovim, Emacs, Sublime Text, Xcode).
47
135
 
48
136
  ## Three-Tier Verification
49
137
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "vskill",
3
- "version": "0.1.27",
3
+ "version": "0.1.28",
4
4
  "type": "module",
5
5
  "description": "Secure multi-platform AI skill installer — scan before you install",
6
6
  "bin": {