CLI tools guide

Learn about the several command-line interface (CLI) tool options, including IBM Cloud Pak CLI (cloudctl).

If you are using the IBM Platform API operator service, which includes the IBM Cloud Pak CLI, as part of an IBM Cloud Pak®, see the documentation for that IBM Cloud Pak® to learn more about how to install and use the operator service. For more information about IBM Cloud Paks, see IBM Cloud Paks that use IBM Cloud Pak foundational services.

What's new for the CLI tools guide

CLI tools guide 3.22.0

Note: In foundational services version 3.22, the cloudctl case command is deprecated and replaced with ibm-pak plug-in. Support for the cloudctl case command will be removed in a future release.

CLI tools guide v3.5.0

The IBM Cloud Pak CLI is now available as part an operator-based service, ibm-platform-api-operator. The latest version for this operator service is 3.7.1.

CLI tools guide v3.2.4

The CLI tools guide is now available as a part of IBM Cloud Pak foundational services.

Available versions

How to check which service version you are using

You can check the installer version in the configmap by running the following command:

oc -n kube-public get ConfigMap ibmcloud-cluster-info -o jsonpath=’{.data.version}’
   3.6.0

You can check the Common service operator full version and deployed namespace by running the following command:

oc get csv --all-namespaces | grep common-service-
common-service        IBM Cloud Platform Common Services     3.6.3                   ibm-common-service-operator.v3.5.6             Succeeded
ibm-common-services  IBM Cloud Platform Common Services     3.6.3                   ibm-common-service-operator.v3.5.6             Succeeded

If no ibmcloud-cluster-info configmap is in your cluster, it means that the service was installed by installer version 1.1.0 and the service is version 3.3.0 or newer. You can check the Installed Operators tab in the Red Hat OpenShift Container Platform console to find the accurate version.