Installing the CLI
You can use the following tools to manage your Satellite locations and clusters. While you can install a subset of the tools, the following tools are recommended.
Understanding the CLI tools
CLI | Description |
---|---|
ibmcloud |
You can use the ibmcloud CLI for tasks such as to log in to your account, add users, and manage your catalog items. |
ks plug-in |
You can use the ks plug-in to create and manage clusters and to manage your Satellite resources. |
Run the installation command
The latest version of the IBM Cloud CLI is installed when you run the command. As the CLI installs, keep an eye on the command line to authenticate as needed.
-
For MacOS, run the following command:
curl -fsSL https://clis.cloud.ibm.com/install/osx | sh
-
For Linux™, run the following command:
curl -fsSL https://clis.cloud.ibm.com/install/linux | sh
-
For Windows™, run the following command in PowerShell as an administrator:
iex (New-Object Net.WebClient).DownloadString('https://clis.cloud.ibm.com/install/powershell')
To open PowerShell, right-click the Windows™ PowerShell icon, and select Run as administrator.
-
For WSL2 on Windows™, run the following command:
curl -fsSL https://clis.cloud.ibm.com/install/linux | sh
For more installation methods, see IBM Cloud CLI.
Verify the installation
To verify that the CLI was installed successfully, run the help
command:
ibmcloud help
The output lists the usage instructions, the current version, and the supported commands.
Install CLI plug-ins and tools
To manually install the CLI plug-ins and tools, see Extending IBM Cloud CLI with plug-ins.
To install the container-service
or ks
plugin, which includes all ibmcloud sat
commands, run the following command.
ibmcloud plugin install ks