IBM Cloud CLI プラグインの追加および削除 (ibmcloud plugin)

IBM Cloud® は、機能を拡張するためにプラグイン・フレームワークをサポートしています。以下のコマンドを使用して、IBM Cloud コマンド・ライン・インターフェース・プラグインを管理します。

ibmcloud plugin repos

IBM Cloud CLI に登録されているすべてのプラグイン・リポジトリーをリストします。

ibmcloud plugin repos

ibmcloud plugin repo-add

新規プラグイン・リポジトリーを IBM Cloud CLI に追加します。

ibmcloud plugin repo-add REPO_NAME REPO_URL

コマンド・オプション：

REPO_NAME (必須): 追加するリポジトリーの名前。各リポジトリーに対して任意の名前を定義できます。
REPO_URL (必須): 追加するリポジトリーの URL。リポジトリー URL には、プロトコルが含まれている必要があります (例えば、 plugins.cloud.ibm.comの代わりに https://plugins.cloud.ibm.com )。 https://plugins.cloud.ibm.com は、 IBM Cloud CLI の公式プラグイン・リポジトリーです。

例:

IBM Cloud CLI の公式プラグイン・リポジトリーを ibmcloud-repo として追加します。

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

ibmcloud plugin repo-remove

IBM Cloud CLI からプラグイン・リポジトリーを削除します。

ibmcloud plugin repo-remove REPO_NAME

コマンド・オプション：

REPO_NAME (必須): 削除するリポジトリーの名前。

例:

IBM Cloud CLI から ibmcloud-repo リポジトリーを削除します。

ibmcloud plugin repo-remove ibmcloud-repo

ibmcloud plugin repo-plugins

追加されたすべてのリポジトリーまたは特定のリポジトリー内にある使用可能なプラグインをすべてリストします。

ibmcloud plugin repo-plugins [-r REPO_NAME]

コマンド・オプション：

-r REPO_NAME (オプション): 指定されたリポジトリー内のプラグインのみをリストします。

例:

追加されたすべてのリポジトリー内のすべてのプラグインをリストします。

ibmcloud plugin repo-plugins

ibmcloud-repo リポジトリー内のすべてのプラグインをリストします。

ibmcloud plugin repo-plugins -r ibmcloud-repo

ibmcloud plugin repo-plugin

リポジトリー内のプラグインの詳細を表示します。

ibmcloud plugin repo-plugin PLUGIN_NAME [-r REPO_NAME]

コマンド・オプション：

-r REPO_NAME (オプション): リポジトリーの名前。リポジトリーが指定されない場合、コマンドは、デフォルトのプラグイン・リポジトリーを使用します。

例:

リポジトリー「sample-repo」内のプラグイン「IBM-Containers」の詳細をリストします

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

デフォルトリポジトリのプラグイン "IBM-Containers" の詳細を一覧表示します

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

ibmcloud plugin list

IBM Cloud CLI 内のインストールされたプラグインをすべてリストします。各プラグインは、現在インストールされているバージョン、アップデート可能な最新バージョンがあるかどうか、インストールされているプラグインのバージョンがプライベートエンドポイントの使用をサポートしているかどうかを返します。

ibmcloud plugin list

ibmcloud plugin show

インストールされたプラグインの詳細を表示します。

ibmcloud plugin show PLUGIN-NAME

ibmcloud plugin install

IBM CloudCLIに、指定されたパスまたはリポジトリから特定のバージョンのプラグインをインストールします。

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]

リポジトリーが指定されない場合、コマンドは、デフォルトのプラグイン・リポジトリー IBM Cloud を使用します。単一のプラグインをインストールする場合で、バージョンを指定しない場合、コマンドは利用可能な最新のバージョンを選択してインストールします。 '-a, --all'フラグが指定された場合、リポジトリにある最新の利用可能なプラグインを全てインストールします。

コマンド・オプション：

PLUGIN_PATH | PLUGIN_NAME: -r REPO_NAME が指定されていない場合、プラグインは指定されたローカル・パスまたはリモート URL からインストールされます。
-a, -- all (オプション): リポジトリにある最新のプラグインをすべてインストールする。
-r REPO_NAME (オプション): プラグインのバイナリーが配置されているリポジトリーの名前。リポジトリーが指定されない場合、コマンドは、デフォルトのプラグイン・リポジトリー IBM Cloud を使用します。
-v VERSION (オプション): インストールするプラグインのバージョン。特定のセマンティック・バージョンまたは制約を受け入れます。
-f (オプション): 確認なしで強制的にプラグインがインストールされます。

IBM Cloud CLI の公式リポジトリー名は、IBM Cloud です。

例:

ローカル・ファイルからプラグインをインストールします。

ibmcloud plugin install /downloads/new_plugin

リモート URL からプラグインをインストールします。

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

最新バージョンの container-service プラグインを IBM Cloud リポジトリーからインストールします。

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

あるいは、以下を実行することもできます。

ibmcloud plugin install container-service

バージョン container-service の 0.1.425 プラグインを公式プラグイン・リポジトリーからインストールします。

ibmcloud plugin install container-service -v 0.1.425

公式プラグインリポジトリから最新のプラグインをインストールしてください：

ibmcloud plugin install --all

公式プラグインリポジトリから最新のプラグインを確認なしでインストールする：

ibmcloud plugin install --all -f

複数のプラグインを同時にインストールします。

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

ibmcloud プラグインのダウンロード

IBM CloudCLIに、指定したリポジトリから特定のバージョンのプラグインをダウンロードするか、リポジトリ内の最新の利用可能なプラグインをすべてダウンロードします。

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]

リポジトリーが指定されない場合、コマンドは、デフォルトのプラグイン・リポジトリー IBM Cloud を使用します。単一のプラグインをダウンロードする場合で、バージョンが指定されていない場合、コマンドは利用可能な最新のバージョンを選択してダウンロードします。 '-a, --all'フラグが指定された場合、リポジトリにある最新の利用可能なプラグインを全てダウンロードします。

コマンド・オプション：

-a, -- all (オプション): リポジトリにある最新のプラグインをすべてダウンロードします。
-r REPO_NAME (オプション): プラグインのバイナリーが配置されているリポジトリーの名前。リポジトリーが指定されない場合、コマンドは、デフォルトのプラグイン・リポジトリー IBM Cloud を使用します。
-v VERSION (オプション): ダウンロードされるプラグインのバージョン。特定のセマンティック・バージョンまたは制約を受け入れます。
-d, --dest DOWNLOAD_DIRECTORY (オプション): ダウンロードされるプラグインの宛先ディレクトリー。指定しない場合、これは作業ディレクトリーです。
-f: 確認なしでプラグインを強制的にダウンロードします。

IBM Cloud CLI の公式リポジトリー名は、IBM Cloud です。

例:

リモートURLからプラグインをダウンロードする：

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

最新版の container-service プラグインを IBM Cloud リポジトリからダウンロードします：

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

あるいは、以下を実行することもできます。

ibmcloud plugin download container-service

公式プラグインリポジトリから container-service のプラグインと 0.1.425 のバージョンをダウンロードしてください：

ibmcloud plugin download container-service -v 0.1.425

バージョン 0.1.425 の container-service プラグインを公式プラグイン・リポジトリーから ~/my_downloads ディレクトリーにダウンロードします。

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

公式プラグインリポジトリから最新のプラグインをダウンロードしてください：

ibmcloud plugin download --all

公式プラグインリポジトリから最新のプラグインを確認なしでダウンロードできます：

ibmcloud plugin download --all -f

ibmcloud plugin update

リポジトリーからプラグインをアップグレードします。

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

リポジトリーが指定されない場合、コマンドは、デフォルトのプラグイン・リポジトリー IBM Cloud を使用します。バージョンが指定されない場合、コマンドは、インストール可能な最新バージョンを選択します。

コマンド・オプション：

PLUGIN NAME: 更新するプラグインの名前。指定されない場合、コマンドは、インストールされているすべてのプラグインのアップグレードを確認します。
-r REPO_NAME: プラグインのバイナリーが配置されているリポジトリーの名前。コマンドで指定しなかった場合、デフォルトのプラグイン・リポジトリー IBM Cloud が使用されます。
-v VERSION (オプション): 更新するプラグインのバージョン。指定しなかった場合、プラグインが最新バージョンに更新されます。
--all: 使用可能なすべてのプラグインを更新します。

例:

公式プラグイン・リポジトリー IBM Cloud 内のすべての使用可能アップグレードを確認するには、以下のように指定します。

ibmcloud plugin update -r "IBM Cloud"

あるいは、以下を実行することもできます。

ibmcloud plugin update

公式プラグインリポジトリのプラグイン container-service を最新のものにアップグレードしてください：

ibmcloud plugin update container-service

公式プラグインリポジトリのプラグイン container-service をバージョン '0.1.440' に更新してください：

ibmcloud plugin update container-service -v 0.1.440

ibmcloud plugin uninstall

指定されたプラグインを IBM Cloud CLI からアンインストールします。

ibmcloud plugin uninstall PLUGIN_NAME

コマンド・オプション：

PLUGIN_NAME (必須): アンインストールされるプラグインの名前。

例:

前にインストールされた「container-service」プラグインをアンインストールします。

ibmcloud plugin uninstall container-service