Install Tanzu CLI

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

Accept the End User License Agreements

Before downloading and installing Tanzu Application Platform packages, you must accept the End User License Agreements (EULAs) as follows:

  1. Sign in to VMware Tanzu Network.

  2. Accept or confirm that you have accepted the EULAs for each of the following:

Example of accepting the Tanzu Application Platform EULA

To accept the Tanzu Application Platform EULA:

  1. Go to Tanzu Application Platform.

  2. Select the Click here to sign the EULA link in the yellow warning box under the release drop-down menu. If the yellow warning box is not visible, the EULA has already been accepted.

    Screenshot of a VMware Tanzu Network download page with notice stating user must sign EULA before downloading.

  3. Select Agree in the bottom-right of the dialog box as seen in the following screenshot.

    Screenshot of a dialog box inviting the reader to accept the EULA. The Agree button is framed.

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:

  1. 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
    
  2. 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 v1.0.0 distributed with Tanzu Application Platform is forward and backward compatible with all supported releases of Tanzu Application Platform.

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 Tanzu CLI Plug-ins.

Use a package manager to install Tanzu CLI on Windows, Mac, or Linux OS. Alternatively, download and install manually from Tanzu Network, VMware Customer Connect, 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:
  1. 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.3.0
      
    • 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.vmware.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.vmware.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.
      
  2. Check that the correct version of the CLI is properly installed.

    tanzu version
    version: v1.3.0
    ...
    
Install from a binary release
To install the Tanzu CLI from a binary release:
  1. Download the Tanzu CLI binary from one of the following locations:

    • VMware Tanzu Network

      1. Go to VMware Tanzu Network.
      2. Choose the 1.6.12 release from the Release dropdown menu.
      3. Click the tanzu-core-cli-binaries item from the result set.
      4. Download the Tanzu CLI binary for your operating system.
    • VMware Customer Connect

      1. Go to VMware Customer Connect.
      2. Download the Tanzu CLI binary for your operating system.
    • GitHub

      1. Go to Tanzu CLI release v1.3.0 on GitHub.
      2. Download the Tanzu CLI binary for your operating system, for example, tanzu-cli-windows-amd64.tar.gz.
  2. 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.

  3. Make the CLI available to the system:

    • cd to the directory containing the extracted CLI 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.
  4. Check that the correct version of the CLI is properly installed:

    tanzu version
    version: v1.3.0
    ...
    

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 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 specific plug-in group matching your target environment

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

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

tanzu plugin group get vmware-tap/default:v1.6.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.

check-circle-line exclamation-circle-line close-line
Scroll to top icon