Adding and removing IBM Cloud CLI plug-ins (ibmcloud plugin)

IBM Cloud® supports a plug-in framework to extend its capability. Use the following commands to manage the IBM Cloud Command Line Interface plug-ins.

ibmcloud plugin repos

List all plug-in repositories that are registered in IBM Cloud CLI.

ibmcloud plugin repos

ibmcloud plugin repo-add

Add a new plug-in repository to IBM Cloud CLI.

ibmcloud plugin repo-add REPO_NAME REPO_URL

Command options:

REPO_NAME (required): The name of the repository to be added. You can define your own name for each repository.
REPO_URL (required): The URL of the repository to be added. The repository URL must contain the protocol (for example, https://plugins.cloud.ibm.com instead of plugins.cloud.ibm.com). https://plugins.cloud.ibm.com is the official plug-in repository of IBM Cloud CLI.

Examples:

Add the official plug-in repository of IBM Cloud CLI as ibmcloud-repo:

ibmcloud plugin repo-add ibmcloud-repo https://plugins.cloud.ibm.com

ibmcloud plugin repo-remove

Remove a plug-in repository from IBM Cloud CLI.

ibmcloud plugin repo-remove REPO_NAME

Command options:

REPO_NAME (required): The name of the repository to be removed.

Examples:

Remove ibmcloud-repo repository from IBM Cloud CLI:

ibmcloud plugin repo-remove ibmcloud-repo

ibmcloud plugin repo-plugins

List all available plug-ins in all added repositories or a specific repository.

ibmcloud plugin repo-plugins [-r REPO_NAME]

Command options:

-r REPO_NAME (optional): List only the plug-ins in the specified repository.

Examples:

List all plug-ins in all added repositories:

ibmcloud plugin repo-plugins

List all plug-ins in the ibmcloud-repo repository:

ibmcloud plugin repo-plugins -r ibmcloud-repo

ibmcloud plugin repo-plugin

Show the details of a plug-in in the repository.

ibmcloud plugin repo-plugin PLUGIN_NAME [-r REPO_NAME]

Command options:

-r REPO_NAME (optional): The name of the repository. If no repository is specified, the command uses the default plug-in repository.

Examples:

List details of plug-in "IBM-Containers" in repository "sample-repo":

ibmcloud plugin repo-plugin IBM-Containers -r sample-repo

List details of plug-in "IBM-Containers" in the default repository

ibmcloud plugin repo-plugin IBM-Containers -r sample-repo

ibmcloud plugin list

List all installed plug-ins in IBM Cloud CLI. Each plug-in returns the current version that is installed, whether there is a more recent version available for update, and if the version of the plug-in installed supports private endpoint use.

ibmcloud plugin list

ibmcloud plugin show

Show details of an installed plug-in.

ibmcloud plugin show PLUGIN-NAME

ibmcloud plugin install

Install a specific version of a plug-in to IBM Cloud CLI from the specified path or repository, or all latest available plug-ins in the repository.

ibmcloud plugin install PLUGIN_PATH|PLUGIN_NAME [-r REPO_NAME] [-v VERSION] [-f]

ibmcloud plugin install [-a, --all] [-r REPO_NAME] [-f]

ibmcloud plugin install LOCAL-PATH/TO/PLUGIN | URL [-f]

If no repository is specified, the command uses the default plug-in repository IBM Cloud. If you are installing a single plug-in, and no version is specified, the command selects the latest available version to install. If the '-a, --all' flag is specified, the command installs all latest available plug-ins in the repository.

Command options:

PLUGIN_PATH|PLUGIN_NAME: If -r REPO_NAME is not specified, the plug-in is installed from the specified local path or remote URL.
-a, --all (optional): Install all latest available plug-ins in the repository.
-r REPO_NAME (optional): The name of the repository where the plug-in binary is located. If no repository is specified, the command uses the default plug-in repository IBM Cloud.
-v VERSION (optional): The version of the plug-in to be installed. Accepts specific semantic version or constraint.
-f (optional): Force installs the plug-in without confirmation.

The IBM Cloud CLI has the official repository name of IBM Cloud.

Examples:

Install a plug-in from the local file:

ibmcloud plugin install /downloads/new_plugin

Install a plug-in from the remote URL:

ibmcloud plugin install http://example.com/downloads/my-plugin

Install the container-service plug-in of the latest version from the IBM Cloud repository:

ibmcloud plugin install container-service -r "IBM Cloud"

Or you can run:

ibmcloud plugin install container-service

Install the container-service plug-in with the version 0.1.425 from the official plug-in repository:

ibmcloud plugin install container-service -v 0.1.425

Install all latest available plug-ins from the official plug-in repository:

ibmcloud plugin install --all

Install all latest available plug-ins from the official plug-in repository without confirmation:

ibmcloud plugin install --all -f

Install multiple plug-ins at the same time:

ibmcloud plugin install container-service@1.0.506 secrets-manager@0.1.25

ibmcloud plugin download

Download a specific version of a plug-in to IBM Cloud CLI from the specified repository, or all latest available plug-ins in the repository.

ibmcloud plugin download PLUGIN_NAME [-r REPO_NAME] [-v VERSION] [-d, --dest DOWNLOAD_DIRECTORY] [-f]

ibmcloud plugin download [-a, --all] [-r REPO_NAME] [-f]

ibmcloud plugin download URL [-f] [-d DOWNLOAD_DIRECTORY]

If no repository is specified, the command uses the default plug-in repository IBM Cloud. If you are downloading a single plug-in, and no version is specified, the command selects the latest available version to download. If the '-a, --all' flag is specified, the command downloads all latest available plug-ins in the repository.

Command options:

-a, --all (optional): Downloads all latest available plug-ins in the repository.
-r REPO_NAME (optional): The name of the repository where the plug-in binary is located. If no repository is specified, the command uses the default plug-in repository IBM Cloud.
-v VERSION (optional): Version of the plug-in to be downloaded. Accepts specific semantic version or constraint.
-d, --dest DOWNLOAD_DIRECTORY (optional): The destination directory for the downloaded plug-in. If not specified, this is the working directory.
-f: Force downloads the plug-in without confirmation.

The IBM Cloud CLI has the official repository name of IBM Cloud.

Examples:

Download a plug-in from the remote URL:

ibmcloud plugin download http://example.com/downloads/my-plugin

Download the container-service plug-in of the latest version from the IBM Cloud repository:

ibmcloud plugin download container-service -r "IBM Cloud"

Or you can run:

ibmcloud plugin download container-service

Download the container-service plug-in with the version 0.1.425 from the official plug-in repository:

ibmcloud plugin download container-service -v 0.1.425

Download the container-service plug-in with the version 0.1.425 from the official plug-in repository, into the ~/my_downloads directory:

ibmcloud plugin download container-service -v 0.1.425 -d ~/my_downloads

Download all latest available plug-ins from the official plug-in repository:

ibmcloud plugin download --all

Download all latest available plug-ins from the official plug-in repository without confirmation:

ibmcloud plugin download --all -f

ibmcloud plugin update

Upgrade the plug-in from a repository.

ibmcloud plugin update [PLUGIN NAME] [-r REPO_NAME] [-v VERSION] [--all]

If no repository is specified, the command uses the default plug-in repository IBM Cloud. If no version is specified, the command selects the latest available version to install.

Command options:

PLUGIN NAME: Name of the plug-in to update. If not specified, the command checks upgrades for all plug-ins installed.
-r REPO_NAME: The name of the repository where the plug-in binary is located. If not specified, the command uses the default plug-in repository IBM Cloud.
-v VERSION (optional): The version of the plug-in to be updated to. If not provided, update the plug-in to the most recent version.
--all: Update all available plug-ins.

Examples:

Check for all available upgrades in the official plug-in repository IBM Cloud:

ibmcloud plugin update -r "IBM Cloud"

Or you can run:

ibmcloud plugin update

Upgrade the plug-in container-service in the official plug-in repository to the most recent:

ibmcloud plugin update container-service

Update the plug-in container-service in the official plug-in repository to version '0.1.440':

ibmcloud plugin update container-service -v 0.1.440

ibmcloud plugin uninstall

Uninstall the specified plug-in from IBM Cloud CLI.

ibmcloud plugin uninstall PLUGIN_NAME

Command options:

PLUGIN_NAME (required): The name of the plug-in to be uninstalled.

Examples:

Uninstall the 'container-service' plug-in that was previously installed:

ibmcloud plugin uninstall container-service