Install the Tanzu CLI

This topic tells you how to install the Tanzu CLI and plug-ins on Tanzu Application Platform (commonly known as TAP).

Set the Kubernetes cluster context

For information about the supported Kubernetes cluster providers and versions, see Kubernetes cluster requirements.

To set the Kubernetes cluster context:

List the existing contexts by running:

kubectl config get-contexts

For example:

$ kubectl config get-contexts
CURRENT   NAME                                CLUSTER           AUTHINFO                                NAMESPACE
        aks-repo-trial                      aks-repo-trial    clusterUser_aks-rg-01_aks-repo-trial
*       aks-tap-cluster                     aks-tap-cluster   clusterUser_aks-rg-01_aks-tap-cluster

If you are managing multiple cluster contexts, set the context to the cluster that you want to use for the Tanzu Application Platform packages installation by running:
```
kubectl config use-context CONTEXT
```
Where CONTEXT is the cluster that you want to use. For example, aks-tap-cluster.

For example:
```
$ kubectl config use-context aks-tap-cluster
Switched to context "aks-tap-cluster".
```

Install or update the Tanzu CLI and plug-ins

The Tanzu CLI and plug-ins enable you to install and use the Tanzu Application Platform functions and features.

Install the Tanzu CLI

The Tanzu CLI core 1.4 distributed with Tanzu Application Platform is forward and backward compatible with all supported Tanzu Application Platform versions. Run a single command to install the plug-in group version that matches the Tanzu Application Platform version on any target environment. For more information, see Install Plugins.

Use a package manager to install Tanzu CLI on Windows, Mac, or Linux OS. Alternatively, download and install manually from the Broadcom Support Portal or GitHub.

Basic installation instructions are provided below. For more information including how to install the Tanzu CLI and CLI plug-ins in Internet-restricted environments, see the VMware Tanzu CLI documentation.

Note
To retain an existing installation of the Tanzu CLI, move the CLI binary from /usr/local/bin/tanzu or C:\Program Files\tanzu on Windows to a different location before following the steps below.

Install using a package manager

To install the Tanzu CLI using a package manager:

Follow the instructions for your package manager below. This installs the latest version of the CLI available in the package registry.

Homebrew (MacOS):

brew update
brew install vmware-tanzu/tanzu/tanzu-cli

Chocolatey (Windows):
```
choco install tanzu-cli
```
The tanzu-cli package is part of the main Chocolatey Community Repository. When a new tanzu-cli version is released, it might not be available immediately. If the above command fails, run:
```
choco install tanzu-cli --version TANZU-CLI-VERSION
```
Where TANZU-CLI-VERSION is the Tanzu CLI version you want to install.

For example:
```
choco install tanzu-cli --version 1.4.1
```

APT (Debian or Ubuntu):

sudo mkdir -p /etc/apt/keyrings/
sudo apt-get update
sudo apt-get install -y ca-certificates curl gpg
curl -fsSL https://packages-prod.broadcom.com/tools/keys/VMWARE-PACKAGING-GPG-RSA-KEY.pub | sudo gpg --dearmor -o /etc/apt/keyrings/tanzu-archive-keyring.gpg
echo "deb [arch=amd64 signed-by=/etc/apt/keyrings/tanzu-archive-keyring.gpg] https://storage.googleapis.com/tanzu-cli-os-packages/apt tanzu-cli-jessie main" | sudo tee /etc/apt/sources.list.d/tanzu.list
sudo apt-get update
sudo apt-get install -y tanzu-cli

YUM or DNF (RHEL):

cat << EOF | sudo tee /etc/yum.repos.d/tanzu-cli.repo
[tanzu-cli]
name=Tanzu CLI
baseurl=https://storage.googleapis.com/tanzu-cli-os-packages/rpm/tanzu-cli
enabled=1
gpgcheck=1
repo_gpgcheck=1
gpgkey=https://packages-prod.broadcom.com/tools/keys/VMWARE-PACKAGING-GPG-RSA-KEY.pub
EOF

sudo yum install -y tanzu-cli # If you are using DNF, run sudo dnf install -y tanzu-cli.

Check that the correct version of the CLI is properly installed.
```
tanzu version
version: v1.4.1
...
```

Install from a binary release

Complete the following steps:

Download the Tanzu CLI binary from one of the following locations:
- Broadcom Support Portal:
  1. Go to the Broadcom Support Portal, expand the VMware Tanzu Application Platform dropdown, and click the 1.12.1 release.
  2. If you have not done so already, select the I agree to Terms and Conditions check box.
  3. Download the tanzu-core-cli binary. Choose from tanzu-core-cli-linux, tanzu-core-cli-mac, or tanzu-core-cli-windows.
  4. Download the Tanzu CLI binary for your operating system.
- GitHub:
  1. Go to Tanzu CLI release v1.4.1 on GitHub.
  2. Download the Tanzu CLI binary for your operating system, for example, tanzu-cli-windows-amd64.tar.gz.
Use an extraction tool to unpack the binary file:
- macOS:
```
tar -xvf tanzu-cli-darwin-amd64.tar.gz
```
- Linux:
```
tar -xvf tanzu-cli-linux-amd64.tar.gz
```
- Windows:
  
  Use the Windows extractor tool to unzip tanzu-cli-windows-amd64.zip.
Make the CLI available to the system. cd to the directory containing the extracted CLI binary then install the binary:
- macOS:
  
  Install the binary to /usr/local/bin:
```
install tanzu-cli-darwin_amd64 /usr/local/bin/tanzu
```
- Linux:
  
  Install the binary to /usr/local/bin:
```
sudo install tanzu-cli-linux_amd64 /usr/local/bin/tanzu
```
- Windows:
  1. Create a new Program Files\tanzu folder.
  2. Copy the tanzu-cli-windows_amd64.exe file into the new Program Files\tanzu folder.
  3. Rename tanzu-cli-windows_amd64.exe to tanzu.exe.
  4. Right-click the tanzu folder, select Properties > Security, and make sure that your user account has the Full Control permission.
  5. Use Windows Search to search for env.
  6. Select Edit the system environment variables and click the Environment Variables button.
  7. Select the Path row under System variables, and click Edit.
  8. Click New to add a new row and enter the path to the Tanzu CLI. The path value must not include the .exe extension. For example, C:\Program Files\tanzu.
Check that the correct version of the CLI is properly installed:
```
tanzu version
version: v1.4.1
...
```

Install Tanzu CLI plug-ins

There is a group of Tanzu CLI plug-ins which extend the Tanzu CLI Core with Tanzu Application Platform specific feature functionality. The plug-ins can be installed as a group with a single command. Versioned releases of the Tanzu Application Platform specific plug-in group align to each supported Tanzu Application Platform version. This makes it easy to switch between different versions of Tanzu Application Platforms environments.

Use the following commands to search for, install, and verify Tanzu CLI plug-in groups.

List the versions of each plug-in group available across Tanzu

tanzu plugin group search --show-details

List the versions of the Tanzu Application Platform specific plug-in group

tanzu plugin group search --name vmware-tap/default --show-details

Install the version of the Tanzu Application Platform plug-in group matching your target environment

tanzu plugin install --group vmware-tap/default:v1.12

Verify the plug-in group list against the plug-ins that were installed

tanzu plugin group get vmware-tap/default:v1.12

tanzu plugin list

For air-gapped installation, see the Installing the Tanzu CLI in Internet-Restricted Environments section of the Tanzu CLI documentation.

Next steps

For online installation:

For air-gapped installation:

For installation on AWS Cloud:

For installation on Azure Cloud:

For installation on OpenShift clusters:

For GitOps (beta) installation:

* When you use a VMware Tanzu Kubernetes Grid cluster, you do not need to install Cluster Essentials because the contents of Cluster Essentials are already installed on your cluster.