tanzu plugin
System commands | Primarily used for: Tanzu CLI
The tanzu plugin command group manages Tanzu CLI plugins. This command group includes the following commands:
Usage
tanzu plugin [COMMAND]
Global Flags
-h, --help
Help text.
tanzu plugin clean
Removes existing plugins from any previous CLI installations.
Usage
tanzu plugin clean [FLAGS]
Example
To remove existing CLI plugins from your machine:
tanzu plugin clean
Flags
-h, --help
Help text.
tanzu plugin delete
Deletes the specified plugin.
Usage
tanzu plugin delete PLUGIN-NAME [FLAGS]
Example
To delete my-plugin:
tanzu plugin delete my-plugin
Flags
-h, --help
Help text.
-t, --target
The target with which the plugin that you are deleting is associated. Supported values are kubernetes, or k8s, and mission-control, or tmc.
-y, --yes
When --yes is specified, the command skips the confirmation step.
tanzu plugin describe
Describes the specified plugin.
Usage
tanzu plugin describe PLUGIN-NAME [FLAGS]
Example
To describe my-plugin:
tanzu plugin describe my-plugin
Flags
-h, --help
Help text.
-t, --target
The target with which the plugin is associated. Supported values are kubernetes, or k8s, and mission-control, or tmc.
tanzu plugin install
Installs the specified plugin. For more information, see Install New Plugins.
Usage
tanzu plugin install PLUGIN-NAME [FLAGS]
Example
To install my-plugin
tanzu plugin install my-plugin
Flags
-h, --help
Help text.
-l, --local
The path to the local plugin discovery source that you want to use. For more information, see Install Local Plugins.
-t, --target
The target with which the plugin is associated. Supported values are kubernetes, or k8s, and mission-control, or tmc.
-v, --version
The version of the plugin. Defaults to latest.
tanzu plugin list
Lists available Tanzu CLI plugins.
Usage
tanzu plugin list [FLAGS]
Example
To list available plugins:
tanzu plugin list
Flags
-h, --help
Help text.
-l, --local
The path to the local plugin discovery source that you want to use.
-o, --output
Output format. Supported values are yaml, json, and table.
tanzu plugin source
Manages plugin discovery sources. A discovery source provides metadata about available plugins, their supported versions, and how to download them.
Commands:
- tanzu plugin source add
- tanzu plugin source delete
- tanzu plugin source list
- tanzu plugin source update
tanzu plugin source add
Adds a discovery source.
Usage
tanzu plugin source add [FLAGS]
Examples
To add a local discovery source, for example, my-local:
tanzu plugin source add --name my-local --type local --uri path/to/local/discovery/source
To add an OCI discovery source, for example, my-oci:
tanzu plugin source add --name my-oci --type oci --uri projects.registry.vmware.com/tkg/tanzu-plugins/standalone:latest
The URI used above is an example.
Flags
-h, --help
Help text.
-n, --name
The name of the discovery source.
-t, --type
The type of the discovery source. Supported values are oci and local.
-u, --uri
The URI of the discovery source. For the oci type, the URI must be an OCI image.
tanzu plugin source delete
Deletes the specified discovery source.
Usage
tanzu plugin source delete SOURCE-NAME [FLAGS]
Example
To delete my-oci:
tanzu plugin discovery delete my-oci
Flags
-h, --help
Help text.
tanzu plugin source list
Lists available discovery sources.
Usage
tanzu plugin source list [FLAGS]
Example
To list available discovery sources:
tanzu plugin source list
Flags
-h, --help
Help text.
-o, --output
Output format. Supported values are yaml, json, and table.
tanzu plugin source update
Updates the specified discovery source.
Usage
tanzu plugin source update SOURCE-NAME [FLAGS]
Examples
To update a local discovery source, for example, my-local:
tanzu plugin source update my-local --type local --uri /tmp/path/to/local/discovery
To update an OCI discovery source, for example, my-oci:
tanzu plugin source update my-oci --type oci --uri projects.registry.vmware.com/tkg/tanzu-plugins/standalone:latest
The URI used above is an example.
Flags
-h, --help
Help text.
-t, --type
The type of the discovery source. Supported values are oci and local.
-u, --uri
The URI of the discovery source. For the oci type, the URI must be an OCI image.
tanzu plugin sync
Synchronizes Tanzu CLI plugins. For more information, see Sync New Plugins.
Usage
tanzu plugin sync [FLAGS]
Example
To synchronize Tanzu CLI plugins:
tanzu plugin sync
Flags
-h, --help
Help text.
tanzu plugin upgrade
Upgrades the specified Tanzu CLI plugin.
Usage
tanzu plugin upgrade PLUGIN-NAME [FLAGS]
Example
To upgrade my-plugin:
tanzu plugin upgrade my-plugin
Flags
-h, --help
Help text.
-t, --target
The target with which the plugin is associated. Supported values are kubernetes, or k8s, and mission-control, or tmc.
