plugin¶
Manage plugins.
Syntax¶
Arguments¶
plugin does not accept positional arguments; use subcommands.
Options¶
| Short | Long | Default | Description |
|---|---|---|---|
| - | --help |
- | Show help and exit |
Subcommands¶
plugin list¶
List registered plugins and their trust levels. The output includes a tip to run autoship plugin search to browse all available plugins in the registry.
plugin search¶
Search the official plugin registry index.
| Name | Required | Description |
|---|---|---|
keyword |
No | Keyword to search in plugin names or descriptions |
plugin info¶
Show detailed information about a plugin in the registry.
| Name | Required | Description |
|---|---|---|
name |
Yes | Plugin name |
plugin install¶
Install a plugin package and register it locally.
| Name | Required | Description |
|---|---|---|
source |
Yes | Package spec or plugin name from the registry |
| Short | Long | Default | Description |
|---|---|---|---|
| - | --name TEXT |
- | Plugin name to register |
| - | --version TEXT |
- | Plugin version |
| - | --trust LEVEL |
- | Initial trust level: builtin, verified, community, untrusted |
| - | --dry-run |
False |
Preview actions |
-y |
--yes |
False |
Skip confirmations |
| - | --skip-trust-check |
False |
Skip trust-level warnings |
| - | --no-sandbox |
False |
Run pip install without sandbox |
plugin uninstall¶
Uninstall a plugin package and remove it from the local registry.
| Name | Required | Description |
|---|---|---|
name |
Yes | Plugin name to uninstall |
| Short | Long | Default | Description |
|---|---|---|---|
| - | --dry-run |
False |
Preview actions |
-y |
--yes |
False |
Skip confirmations |
plugin rate¶
Rate a registered plugin.
| Name | Required | Description |
|---|---|---|
name |
Yes | Plugin name |
score |
Yes | Rating from 1 to 5 |
plugin stats¶
Show local plugin usage statistics.
plugin trust¶
Update the trust level of a registered plugin.
| Name | Required | Description |
|---|---|---|
name |
Yes | Plugin name |
level |
Yes | New trust level: builtin, verified, community, untrusted |
plugin update¶
Check for and install plugin updates.
| Name | Required | Description |
|---|---|---|
name |
No | Plugin name to update |
| Short | Long | Default | Description |
|---|---|---|---|
| - | --all |
False |
Update all registered plugins |
| - | --dry-run |
False |
Preview actions |
-y |
--yes |
False |
Skip confirmations |
| - | --skip-trust-check |
False |
Skip trust-level warnings |
| - | --no-sandbox |
False |
Run pip install without sandbox |
Examples¶
List registered plugins:
Search the registry:
Show plugin details:
Install a registry plugin:
Install a local plugin with a trust level:
Update trust level:
Uninstall a plugin:
Update all plugins:
Output Notes / Common Errors¶
- Trust levels:
builtin>verified>community>untrusted. - Installing an unverified plugin shows a trust warning; use
--skip-trust-checkto bypass. --no-sandboxdisables the pip install sandbox; only use it in trusted environments.