Installing the IBM® Cloud Private CLI

You can install and use the IBM Cloud Private command line interface (CLI) to manage one or multiple clusters.

After you install IBM Cloud Private, you can install the CLI on Windows™, Linux®, or macOS.

To set up the IBM Cloud Private} CLI, complete the following steps:

1. From the IBM Cloud Private management console Getting started page, click Install CLI tools.

2. Expand Install IBM Cloud Private CLI. Read the text, then copy and run the curl command for your operating system. Continue the installation procedure in the product documentation.

   Choose the curl command for the applicable operating system. For example, you can run the following command for macOS:

   curl -kLo <install_file> https://<Cluster Master Host>:<Cluster Master API Port>/api/cli/cloudctl-darwin-amd64
   

3. After you run the curl command for your operating system, continue to install the IBM Cloud Private CLI.

   To install the IBM Cloud Private CLI, run the command that matches your client computer operating system, where <path_to_installer> is the path to the directory where you downloaded the CLI file, and <install_file> is the downloaded file name.

   • For example, for Linux and macOS, run the following commands to change and move the file. Remember that the curl command for your cluster is located in the management console:

     chmod 755 <path_to_installer>/<install_file>
     

     sudo mv <path_to_installer>/<install_file> /usr/local/bin/cloudctl
     

   • For Windows, rename the downloaded file to cloudctl and place the file on the PATH environment variable.

4. Confirm that the IBM Cloud Private CLI is installed:

   cloudctl --help
   

   The IBM Cloud Private CLI usage is displayed.

5. Set up the kubectl CLI. See Installing the Kubernetes CLI (kubectl) for installation instructions.

6. Log in to your cluster with the following command, where <Cluster Master Host> is the external host name or IP address for your master or leading master node.

   cloudctl login -a https://<Cluster Master Host>:<Cluster Master API Port> --skip-ssl-validation
   

You can now use the IBM Cloud Private CLI to view information about your cluster and manage your clusters.