Stay organized with collectionsSave and categorize content based on your preferences.
This document describes how to install the Kf CLI.
You typically install the Kf CLI when you already
have access to a GKE cluster running Kf.
That means that you can get started using Kf commands without
having to first create your own GKE cluster.
After installing the Kf CLI and connecting to the
Kf cluster, you can run any of the Kf commands.
For a complete list of the available Kf commands, see theKf command reference.
Before you begin
Before you can use the Kf CLI, you must have
access to a GKE cluster running a full Kf installation.
That means that you have run the following command to connect to the cluster:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Install the Kf CLI\n\nThis document describes how to install the Kf CLI.\nYou typically install the Kf CLI when you already\nhave access to a GKE cluster running Kf.\nThat means that you can get started using Kf commands without\nhaving to first create your own GKE cluster.\n\nAfter installing the Kf CLI and connecting to the\nKf cluster, you can run any of the Kf commands.\nFor a complete list of the available Kf commands, see the\n[Kf command reference](/migrate/kf/docs/2.11/cli).\n\nBefore you begin\n----------------\n\nBefore you can use the Kf CLI, you must have\naccess to a GKE cluster running a full Kf installation.\nThat means that you have run the following command to connect to the cluster: \n\n```\ngcloud container clusters get-credentials CLUSTER_NAME \\\n --project=CLUSTER_PROJECT_ID \\\n --zone=CLUSTER_LOCATION\n```\n\nInstall the CLI\n---------------\n\n1. Install the Kf CLI:\n\n ### Linux\n\n This command installs the Kf CLI for all users on the system. Follow the\n instructions in the Cloud Shell tab to install it just for yourself. \n\n gcloud storage cp gs://kf-releases/v2.11.28/kf-linux /tmp/kf\n chmod a+x /tmp/kf\n sudo mv /tmp/kf /usr/local/bin/kf\n\n ### Mac\n\n This command installs `kf` for all users on the system. \n\n gcloud storage cp gs://kf-releases/v2.11.28/kf-darwin /tmp/kf\n chmod a+x /tmp/kf\n sudo mv /tmp/kf /usr/local/bin/kf\n\n ### Cloud Shell\n\n This command installs `kf` on your Cloud Shell instance if you use `bash`,\n the instructions may need to be modified for other shells. \n\n mkdir -p ~/bin\n gcloud storage cp gs://kf-releases/v2.11.28/kf-linux ~/bin/kf\n chmod a+x ~/bin/kf\n echo \"export PATH=$HOME/bin:$PATH\" \u003e\u003e ~/.bashrc\n source ~/.bashrc\n\n ### Windows\n\n This command downloads `kf` to current directory. Add it to the path if you\n want to call if from anywhere other than the current directory. \n\n gcloud storage cp gs://kf-releases/v2.11.28/kf-windows.exe kf.exe\n\nUpgrade the CLI\n---------------\n\nIf you have an existing installation of the Kf CLI,\nthen you can use the following procedure to upgrade it to the current version.\n\n1. Install the CLI:\n\n ### Linux\n\n This command installs the Kf CLI for all users on the system. Follow the\n instructions in the Cloud Shell tab to install it just for yourself. \n\n gcloud storage cp gs://kf-releases/v2.11.28/kf-linux /tmp/kf\n chmod a+x /tmp/kf\n sudo mv /tmp/kf /usr/local/bin/kf\n\n ### Mac\n\n This command installs `kf` for all users on the system. \n\n gcloud storage cp gs://kf-releases/v2.11.28/kf-darwin /tmp/kf\n chmod a+x /tmp/kf\n sudo mv /tmp/kf /usr/local/bin/kf\n\n ### Cloud Shell\n\n This command installs `kf` on your Cloud Shell instance if you use `bash`,\n the instructions may need to be modified for other shells. \n\n mkdir -p ~/bin\n gcloud storage cp gs://kf-releases/v2.11.28/kf-linux ~/bin/kf\n chmod a+x ~/bin/kf\n echo \"export PATH=$HOME/bin:$PATH\" \u003e\u003e ~/.bashrc\n source ~/.bashrc\n\n ### Windows\n\n This downloads `kf` to current directory. Add it to the path if you\n want to call if from anywhere other than the current directory. \n\n gcloud storage cp gs://kf-releases/v2.11.28/kf-windows.exe kf.exe\n\n2. Validate the Kf CLI and\n Kf server versions match:\n\n - The CLI version is listed under `Kf Client`.\n - The Kf server version is listed under `kf[\"app.kubernetes.io/version\"]`.\n\n $ kf debug\n ...\n Version:\n Kf Client: v2.11.28\n Server version: v1.31.1-gke.2105000\n kf\\[\"app.kubernetes.io/version\"\\]: v2.11.28\n ..."]]
