Skip to content

Commit dbea6bf

Browse files
Add note about plugin name conflicts and change example plugin name
Signed-off-by: Kate Goldenring <kate.goldenring@fermyon.com>
1 parent 76aa5da commit dbea6bf

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

docs/content/sips/006-spin-plugins.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,9 @@ SUBCOMMANDS:
3939

4040
**`spin plugin install`**
4141

42-
The `spin plugin install` subcommand installs a plugin named `$name`. By default, it will look for a plugin manifest named `$name.json` in the `spin-plugin` repository; however, it can be directed to use a local manifest or one at a different remote location using the `--file` or `--url` flag, respectively.
42+
The `spin plugin install` subcommand installs a plugin named `$name`. By default, it will look for a plugin manifest named `$name.json` in the `spin-plugin` repository; however, it can be directed to use a local manifest or one at a different remote location using the `--file` or `--url` flag, respectively.
43+
44+
> Note: the plugin `$name` must not match an existing internal Spin command name. For example, `spin plugin install up` would elicit an error.
4345
4446
```bash
4547
Install a Spin plugin using a plugin manifest file.
@@ -56,11 +58,11 @@ OPTIONS:
5658
-y, --yes Assume yes to all queries.
5759
```
5860

59-
If the manifest is found, Spin will check that the plugin is compatible with the current OS, platform, and version of Spin. If so, before installing the plugin, Spin will prompt the user as to whether to trust the source. For example, the following prompt would be displayed for a plugin named `deploy` with an Apache 2 license and hosted at [`https://github.com/fermyon/spin-plugin-deploy/releases/download/v0.1.0/spin-plugin-deploy-v0.1.0-macos-aarch64.tar.gz`](https://github.com/fermyon/spin-plugin-deploy/releases/download/v0.1.0/spin-plugin-deploy-v0.1.0-macos-aarch64.tar.gz):
61+
If the manifest is found, Spin will check that the plugin is compatible with the current OS, platform, and version of Spin. If so, before installing the plugin, Spin will prompt the user as to whether to trust the source. For example, the following prompt would be displayed for a plugin named `test` with an Apache 2 license and hosted at `https://github.com/fermyon/spin-plugin-test/releases/download/v0.1.0/spin-plugin-test-v0.1.0-macos-aarch64.tar.gz`:
6062

6163
```bash
62-
Installing plugin deploy with license Apache 2.0 from https://github.com/fermyon/spin-plugin-deploy/releases/download/v0.1.0/spin-plugin-deploy-v0.1.0-macos-aarch64.tar.gz
63-
For more information, reference the plugin metadata at `https://github.com/fermyon/spin-plugins/plugin-manifests/deploy.json`.
64+
Installing plugin `test` with license Apache 2.0 from https://github.com/fermyon/spin-plugin-test/releases/download/v0.1.0/spin-plugin-test-v0.1.0-macos-aarch64.tar.gz
65+
For more information, reference the plugin metadata at `https://github.com/fermyon/spin-plugins/plugin-manifests/test.json`.
6466
Are you sure you want to proceed? (y/N)
6567
```
6668

@@ -70,7 +72,6 @@ Spin will reference the plugin manifest in order to fetch the plugin binary and
7072

7173
After installing a plugin, it can be executed directly from the Spin CLI. For example, a plugin named `$name` would be executed by running `spin $name <args>`. Any additional arguments supplied will be passed when executing the associated binary.
7274

73-
7475

7576
**`spin plugin uninstall`**
7677

0 commit comments

Comments
 (0)