plugins 1.1.0 → 1.1.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/README.md +97 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,13 +1,102 @@
|
|
|
1
1
|
# plugins
|
|
2
2
|
|
|
3
|
-
Install
|
|
3
|
+
Install plugins into agent tools. Works with [Claude Code](https://code.claude.com), [Cursor](https://cursor.com), and more.
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
npx plugins add owner/repo
|
|
7
|
+
```
|
|
4
8
|
|
|
5
9
|
## Usage
|
|
6
10
|
|
|
11
|
+
### Add plugins from a GitHub repo
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
# GitHub shorthand
|
|
15
|
+
npx plugins add anthropics/open-plugin
|
|
16
|
+
|
|
17
|
+
# Full HTTPS URL
|
|
18
|
+
npx plugins add https://github.com/anthropics/open-plugin
|
|
19
|
+
|
|
20
|
+
# SSH URL (auto-retries via HTTPS if SSH auth fails)
|
|
21
|
+
npx plugins add git@github.com:anthropics/open-plugin.git
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
### Add plugins from a local directory
|
|
25
|
+
|
|
7
26
|
```bash
|
|
8
|
-
npx plugins add
|
|
27
|
+
npx plugins add ./my-plugins
|
|
28
|
+
npx plugins add /absolute/path/to/plugins
|
|
9
29
|
```
|
|
10
30
|
|
|
31
|
+
### Discover plugins without installing
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
npx plugins discover owner/repo
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### List detected agent tools
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
npx plugins targets
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## Commands
|
|
44
|
+
|
|
45
|
+
| Command | Description |
|
|
46
|
+
|---|---|
|
|
47
|
+
| `plugins add <source>` | Discover and install plugins from a source |
|
|
48
|
+
| `plugins discover <source>` | Inspect plugins without installing (dry run) |
|
|
49
|
+
| `plugins targets` | List available agent tools and their detection status |
|
|
50
|
+
|
|
51
|
+
If no subcommand is given, `plugins <source>` defaults to `add`.
|
|
52
|
+
|
|
53
|
+
## Flags
|
|
54
|
+
|
|
55
|
+
| Flag | Short | Default | Description |
|
|
56
|
+
|---|---|---|---|
|
|
57
|
+
| `--target` | `-t` | auto-detect | Install to a specific agent tool (`claude-code`, `cursor`) |
|
|
58
|
+
| `--scope` | `-s` | `user` | Installation scope: `user`, `project`, or `local` |
|
|
59
|
+
| `--yes` | `-y` | `false` | Skip the confirmation prompt |
|
|
60
|
+
| `--help` | `-h` | | Show usage information |
|
|
61
|
+
|
|
62
|
+
## Supported targets
|
|
63
|
+
|
|
64
|
+
The CLI auto-detects which agent tools are installed and installs to all of them.
|
|
65
|
+
|
|
66
|
+
| Target | Detection |
|
|
67
|
+
|---|---|
|
|
68
|
+
| [Claude Code](https://code.claude.com) | `claude` binary on PATH |
|
|
69
|
+
| [Cursor](https://cursor.com) | `cursor` binary on PATH |
|
|
70
|
+
|
|
71
|
+
## How it works
|
|
72
|
+
|
|
73
|
+
### Source resolution
|
|
74
|
+
|
|
75
|
+
The CLI accepts GitHub shorthand (`owner/repo`), HTTPS URLs, SSH URLs, or local paths. Remote repos are shallow-cloned to `~/.cache/plugins/<slug>`. SSH URLs that fail automatically retry via HTTPS.
|
|
76
|
+
|
|
77
|
+
### Plugin discovery
|
|
78
|
+
|
|
79
|
+
Discovery follows a 3-step fallback:
|
|
80
|
+
|
|
81
|
+
1. **Marketplace index** — looks for a `marketplace.json` that indexes multiple plugins
|
|
82
|
+
2. **Root plugin** — checks if the repo root itself is a plugin
|
|
83
|
+
3. **Recursive scan** — scans subdirectories (up to 2 levels deep) for plugin directories
|
|
84
|
+
|
|
85
|
+
A plugin is any directory containing skills, commands, agents, rules, hooks, MCP servers, or LSP servers in the [open-plugin format](https://github.com/anthropics/open-plugin).
|
|
86
|
+
|
|
87
|
+
### Installation
|
|
88
|
+
|
|
89
|
+
The CLI translates the vendor-neutral `.plugin/` format into target-specific formats, then installs via the target's native plugin system. Plugin authors write once; the CLI handles the rest.
|
|
90
|
+
|
|
91
|
+
## Environment variables
|
|
92
|
+
|
|
93
|
+
| Variable | Purpose |
|
|
94
|
+
|---|---|
|
|
95
|
+
| `DISABLE_TELEMETRY` | Disable anonymous install telemetry |
|
|
96
|
+
| `DO_NOT_TRACK` | Disable anonymous install telemetry ([standard](https://consoledonottrack.com/)) |
|
|
97
|
+
| `NO_COLOR` | Disable color output |
|
|
98
|
+
| `FORCE_COLOR` | Force color output |
|
|
99
|
+
|
|
11
100
|
## Development
|
|
12
101
|
|
|
13
102
|
```bash
|
|
@@ -15,3 +104,9 @@ npm install
|
|
|
15
104
|
npm run build
|
|
16
105
|
node dist/index.js --help
|
|
17
106
|
```
|
|
107
|
+
|
|
108
|
+
Zero runtime dependencies. Built with [tsup](https://tsup.egoist.dev/) as a single bundled ESM file targeting Node.js 18+.
|
|
109
|
+
|
|
110
|
+
## License
|
|
111
|
+
|
|
112
|
+
[Apache 2.0](../../LICENSE)
|