@minimacli/minimacli 0.1.1 → 0.2.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/README.md +44 -0
- package/main.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -20,6 +20,50 @@ minimacli
|
|
|
20
20
|
The CLI connects to an already-running harness. It does not boot its own
|
|
21
21
|
harness profile.
|
|
22
22
|
|
|
23
|
+
## Plugins
|
|
24
|
+
|
|
25
|
+
`minimacli` supports optional plugins that can be installed and registered from
|
|
26
|
+
the CLI itself. Plugins are stored under the local minimacli plugin directory and
|
|
27
|
+
are automatically loaded when the app starts.
|
|
28
|
+
|
|
29
|
+
Recommended setup for the DSH harness:
|
|
30
|
+
|
|
31
|
+
```sh
|
|
32
|
+
npm i -g @minimacli/minimacli
|
|
33
|
+
minimacli --install @minimacli/dsh-plugin
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
This installs the DSH plugin and registers it for use with a local Harness at
|
|
37
|
+
`http://127.0.0.1:3080`.
|
|
38
|
+
|
|
39
|
+
### Plugin registry
|
|
40
|
+
|
|
41
|
+
The plugin registry is stored in a local file under the user's home directory:
|
|
42
|
+
|
|
43
|
+
- macOS/Linux: `~/.minimacli/plugins.json`
|
|
44
|
+
- Windows: `%USERPROFILE%\.minimacli\plugins.json`
|
|
45
|
+
|
|
46
|
+
This file stores the installed plugins and their default options.
|
|
47
|
+
|
|
48
|
+
Example:
|
|
49
|
+
|
|
50
|
+
```json
|
|
51
|
+
[
|
|
52
|
+
{
|
|
53
|
+
"id": "dsh",
|
|
54
|
+
"kind": "harness",
|
|
55
|
+
"packageName": "@minimacli/dsh-plugin",
|
|
56
|
+
"defaultOptions": {
|
|
57
|
+
"url": "http://127.0.0.1:3080"
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
]
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
You can edit the file manually if you need to add or change a plugin. After
|
|
64
|
+
updating it, restart `minimacli` so the app reloads the registry and picks up the
|
|
65
|
+
new configuration.
|
|
66
|
+
|
|
23
67
|
## Prerequisites
|
|
24
68
|
|
|
25
69
|
A **DSH harness must be running** for the CLI to work. The CLI assumes a
|