Install the Google Cloud CLI

This quickstart guides you through installing and initializing the Google Cloud CLI and running a few core gcloud CLI commands.


For step-by-step guidance on this task directly in Cloud Shell, click Guide me:

Guide me


The following sections take you through the same steps as clicking Guide me.

Before you begin

  1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.
  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  3. Make sure that billing is enabled for your Cloud project. Learn how to check if billing is enabled on a project.

  4. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  5. Make sure that billing is enabled for your Cloud project. Learn how to check if billing is enabled on a project.

When you finish this tutorial, you can avoid continued billing by deleting the resources you created. For more information, see Clean up.

Installing the latest gcloud CLI version (392.0.0)

Linux
  1. Confirm that you have a supported version of Python. The Google Cloud CLI requires Python 3 (3.5 to 3.8, 3.7 recommended) and Python 2 (2.7.9 or higher). For information on how to choose and configure your Python interpreter, see gcloud topic startup.

    As of January 1, 2020 the Python community no longer updates, fixes bugs, patches, or security issues for Python 2. We recommend that you upgrade to Python 3 as soon as possible. For more information, see Python 2 support on Google Cloud.

  2. Download one of the following:
    Platform Package Size SHA256 Checksum
    Linux 64-bit

    (x86_64)

    google-cloud-cli-392.0.0-linux-x86_64.tar.gz 104.3 MB a7e88856a07ed75cf310ebe5415c922c9b516021a6c7e66b3eb8f2859b9351bc
    Linux 64-bit

    (arm)

    google-cloud-cli-392.0.0-linux-arm.tar.gz 101.2 MB 6585b33a56806f95378bdfbd3f5c78f90adca1b50730639e32d674404a7e6c07
    Linux 32-bit

    (x86)

    google-cloud-cli-392.0.0-linux-x86.tar.gz 102.2 MB 3b466c3cfb3ea3848fec45077c2fd8d926b15724f68709235dd7ade05e051121

    Alternatively, to download the Linux 64-bit archive file, at the command line, run:

    curl -O https://dl.google.com/dl/cloudsdk/channels/rapid/downloads/google-cloud-cli-392.0.0-linux-x86_64.tar.gz

    For the 64-bit arm archive file, run:

    curl -O https://dl.google.com/dl/cloudsdk/channels/rapid/downloads/google-cloud-cli-392.0.0-linux-arm.tar.gz

    For the 32-bit archive file, run:

    curl -O https://dl.google.com/dl/cloudsdk/channels/rapid/downloads/google-cloud-cli-392.0.0-linux-x86.tar.gz
  3. Extract the contents of the file to any location on your file system (preferably your Home directory). To replace an existing installation, remove the existing google-cloud-sdk directory and then extract the archive to the same location.
    tar -xf google-cloud-cli-392.0.0-linux-x86.tar.gz
  4. Optional. Use the install script to add the gcloud CLI tools to your PATH. You can also opt-in to command-completion for your shell and usage statistics collection.

    Run the script (from the root of the folder you extracted to) using the following command:

    ./google-cloud-sdk/install.sh
    
    This can also be done non-interactively (for example, using a script) and by providing preferences as flags. These are described in:
    ./google-cloud-sdk/install.sh --help
    
  5. If you want to send anonymous usage statistics to help improve the gcloud CLI, answer Y when prompted.
  6. To add the gcloud CLI to your PATH and enable command completion, answer Y when prompted.
  7. Open a new terminal so that the changes take effect.
  8. To initialize the gcloud CLI, run gcloud init:
  9. ./google-cloud-sdk/bin/gcloud init
    
  10. Optional. Install additional components using the component manager.
Debian/Ubuntu

Package contents

The gcloud CLI is available in package format for installation on Debian and Ubuntu systems. This package contains the gcloud, gcloud alpha, gcloud beta, gsutil, and bq commands only. It doesn't include kubectl or the App Engine extensions required to deploy an application using gcloud commands. If you want these components, you must install them separately.

Before you begin

Before you install the gcloud CLI, make sure that your operating system meets the following requirements:

  • An Ubuntu release that hasn't reached end-of-life or a Debian stable release that hasn't reached end-of-life
  • apt-transport-https is installed:
    sudo apt-get install apt-transport-https ca-certificates gnupg
Installation
  1. Add the gcloud CLI distribution URI as a package source. If your distribution supports the signed-by option, run the following command:
    echo "deb [signed-by=/usr/share/keyrings/cloud.google.gpg] https://packages.cloud.google.com/apt cloud-sdk main" | sudo tee -a /etc/apt/sources.list.d/google-cloud-sdk.list

    If your distribution doesn't support the signed-by option, run the following command:

    echo "deb https://packages.cloud.google.com/apt cloud-sdk main" | sudo tee -a /etc/apt/sources.list.d/google-cloud-sdk.list
  2. Import the Google Cloud public key. If your distribution's apt-key command supports the --keyring argument, run the following command:
    curl https://packages.cloud.google.com/apt/doc/apt-key.gpg | sudo apt-key --keyring /usr/share/keyrings/cloud.google.gpg add -

    If your distribution's apt-key command doesn't support the --keyring argument, run the following command:

    curl https://packages.cloud.google.com/apt/doc/apt-key.gpg | sudo apt-key add -

    If your distribution (Debian 11+ or Ubuntu 21.10+) doesn't support apt-key, run the following command:

    curl https://packages.cloud.google.com/apt/doc/apt-key.gpg | sudo tee /usr/share/keyrings/cloud.google.gpg

    If you can't get latest updates due to an expired key, obtain the latest apt-get.gpg key file.

  3. Update and install the gcloud CLI:
    sudo apt-get update && sudo apt-get install google-cloud-cli
    For additional apt-get options, such as disabling prompts or dry runs, refer to the apt-get man pages.

    Docker Tip: If installing the gcloud CLI inside a Docker image, use a single RUN step instead:

    RUN echo "deb [signed-by=/usr/share/keyrings/cloud.google.gpg] http://packages.cloud.google.com/apt cloud-sdk main" | tee -a /etc/apt/sources.list.d/google-cloud-sdk.list && curl https://packages.cloud.google.com/apt/doc/apt-key.gpg | apt-key --keyring /usr/share/keyrings/cloud.google.gpg  add - && apt-get update -y && apt-get install google-cloud-cli -y
          
    If apt-key command is not supported:
    RUN echo "deb [signed-by=/usr/share/keyrings/cloud.google.gpg] http://packages.cloud.google.com/apt cloud-sdk main" | tee -a /etc/apt/sources.list.d/google-cloud-sdk.list && curl https://packages.cloud.google.com/apt/doc/apt-key.gpg | tee /usr/share/keyrings/cloud.google.gpg && apt-get update -y && apt-get install google-cloud-sdk -y
          
  4. (Optional) Install any of the following additional components:
    • google-cloud-cli
    • google-cloud-cli-anthos-auth
    • google-cloud-cli-app-engine-go
    • google-cloud-cli-app-engine-grpc
    • google-cloud-cli-app-engine-java
    • google-cloud-cli-app-engine-python
    • google-cloud-cli-app-engine-python-extras
    • google-cloud-cli-bigtable-emulator
    • google-cloud-cli-cbt
    • google-cloud-cli-cloud-build-local
    • google-cloud-cli-cloud-run-proxy
    • google-cloud-cli-config-connector
    • google-cloud-cli-datalab
    • google-cloud-cli-datastore-emulator
    • google-cloud-cli-firestore-emulator
    • google-cloud-cli-gke-gcloud-auth-plugin
    • google-cloud-cli-kpt
    • google-cloud-cli-kubectl-oidc
    • google-cloud-cli-local-extract
    • google-cloud-cli-minikube
    • google-cloud-cli-nomos
    • google-cloud-cli-pubsub-emulator
    • google-cloud-cli-skaffold
    • google-cloud-cli-spanner-emulator
    • google-cloud-cli-terraform-validator
    • google-cloud-cli-tests
    • kubectl

    For example, the google-cloud-cli-app-engine-java component can be installed as follows:

    sudo apt-get install google-cloud-cli-app-engine-java
  5. Run gcloud init to get started:
    gcloud init

Downgrading gcloud CLI versions

To revert to a specific version of the gcloud CLI, where VERSION is of the form 123.0.0, run the following command:

sudo apt-get update && sudo apt-get install google-cloud-cli=123.0.0-0

The ten most recent releases are always available in the repo.

NOTE: For releases prior to 371.0.0, the package name is google-cloud-sdk

Red Hat/Fedora/CentOS

Package contents

The gcloud CLI is available in package format for installation on Red Hat Enterprise Linux 7, Red Hat Enterprise Linux 8, Fedora 33, Fedora 34, CentOS 7, and Centos 8 systems. This package contains the gcloud, gcloud alpha, gcloud beta, gsutil, and bq commands only. It doesn't include kubectl or the App Engine extensions required to deploy an application using gcloud commands, which can be installed separately as described later in this section.

Installation
  1. Update DNF with gcloud CLI repo information. The following sample command is for a Red Hat Enterprise Linux 8-compatible installation. For a Red Hat Enterprise Linux 7-compatible installation, replace el8 with el7 in the value for baseUrl.
    sudo tee -a /etc/yum.repos.d/google-cloud-sdk.repo << EOM
    [google-cloud-cli]
    name=Google Cloud CLI
    baseurl=https://packages.cloud.google.com/yum/repos/cloud-sdk-el8-x86_64
    enabled=1
    gpgcheck=1
    repo_gpgcheck=0
    gpgkey=https://packages.cloud.google.com/yum/doc/yum-key.gpg
           https://packages.cloud.google.com/yum/doc/rpm-package-key.gpg
    EOM
    
  2. If you're installing on Fedora 34 or 35, install libcrypt-compat.x86_64.
    sudo dnf install libxcrypt-compat.x86_64
  3. Install the gcloud CLI:
    sudo dnf install google-cloud-cli
  4. (Optional) Install any of the following additional components:
    • google-cloud-cli
    • google-cloud-cli-anthos-auth
    • google-cloud-cli-app-engine-go
    • google-cloud-cli-app-engine-grpc
    • google-cloud-cli-app-engine-java
    • google-cloud-cli-app-engine-python
    • google-cloud-cli-app-engine-python-extras
    • google-cloud-cli-bigtable-emulator
    • google-cloud-cli-cbt
    • google-cloud-cli-cloud-build-local
    • google-cloud-cli-cloud-run-proxy
    • google-cloud-cli-config-connector
    • google-cloud-cli-datalab
    • google-cloud-cli-datastore-emulator
    • google-cloud-cli-firestore-emulator
    • google-cloud-cli-gke-gcloud-auth-plugin
    • google-cloud-cli-kpt
    • google-cloud-cli-kubectl-oidc
    • google-cloud-cli-local-extract
    • google-cloud-cli-minikube
    • google-cloud-cli-nomos
    • google-cloud-cli-pubsub-emulator
    • google-cloud-cli-skaffold
    • google-cloud-cli-spanner-emulator
    • google-cloud-cli-terraform-validator
    • google-cloud-cli-tests
    • kubectl

    For example, the google-cloud-cli-app-engine-java component can be installed as follows:

    sudo dnf install google-cloud-cli-app-engine-java
  5. Run gcloud init to get started:
    gcloud init

Downgrading gcloud CLI versions

If you'd like to revert to a specific version of the gcloud CLI, where VERSION is of the form 123.0.0, run: sudo dnf downgrade google-cloud-cli-VERSION The ten most recent releases will always be available in the repo. NOTE: For releases prior to 371.0.0, the package name is google-cloud-sdk

macOS
  1. Confirm that you have a supported version of Python:
    • To check your current Python version, run python3 -V or python -V. Modern versions of macOS include the appropriate version of Python required for the Cloud SDK. Supported versions are Python 3 (3.5 to 3.8, 3.7 recommended) and Python 2 (2.7.9 or higher).

      As of January 1, 2020 the Python community no longer updates, fixes bugs, patches, or security issues for Python 2. We recommend that you upgrade to Python 3 as soon as possible. For more information, see Python 2 support on Google Cloud.

    • For Cloud SDK release version 352.0.0 and above, the main install script offers to install CPython's Python 3.7 on Intel-based Macs.
    • For more information on how to choose and configure your Python interpreter, refer to gcloud topic startup.
  2. Download one of the following:
  3. Platform Package Size SHA256 Checksum
    macOS 64-bit

    (x86_64)

    google-cloud-cli-392.0.0-darwin-x86_64.tar.gz 104.6 MB 08917f5a269aad838615db8d873e1b2d828649d451753babcadaa8feccf8ebc9
    macOS 64-bit

    (arm64, Apple M1 silicon)

    google-cloud-cli-392.0.0-darwin-arm.tar.gz 103.3 MB 4a975e2320b87de80b40854e012f61493252f8b9011f11347517cd07558d6328
    macOS 32-bit

    (x86)

    google-cloud-cli-392.0.0-darwin-x86.tar.gz 107.9 MB 8de8154f4d5aea39cb3b9c2d969340bd0dc78a6c1c91bf5b9f91a4ab16a75010
    1. Extract the archive to any location on your file system (preferably your Home directory). On macOS, this can be achieved by opening the downloaded .tar.gz archive file in the preferred location.

      To replace an existing installation, remove the existing google-cloud-sdk directory and then extract the archive to the same location.

    2. (Optional) Use the install script to add gcloud CLI tools to your PATH.You can also opt-in to command-completion for your shell, usage statistics collection, and install Python 3.7.

      Run the script (from the root of the folder you extracted in the last step) using this command:

      ./google-cloud-sdk/install.sh
      
      This can also be done non-interactively (for example, using a script) by providing preferences as flags. To describe the available flags, run:
      ./google-cloud-sdk/install.sh --help
      
      To run the install script with screen reader mode on:
      ./google-cloud-sdk/install.sh --screen-reader=true
      
      Open a new terminal so that the changes take effect.
    3. To initialize the gcloud CLI, run gcloud init:
    4. ./google-cloud-sdk/bin/gcloud init
      
    5. Optional. Install additional components using the component manager.
Windows
    The Google Cloud CLI works on Windows 8.1 and later and Windows Server 2012 and later.
  1. Download the Google Cloud CLI installer.

    Alternatively, open a PowerShell terminal and run the following PowerShell commands:

    (New-Object Net.WebClient).DownloadFile("https://dl.google.com/dl/cloudsdk/channels/rapid/GoogleCloudSDKInstaller.exe", "$env:Temp\GoogleCloudSDKInstaller.exe")
    
    & $env:Temp\GoogleCloudSDKInstaller.exe
        
  2. Launch the installer and follow the prompts. The installer is signed by Google LLC.

    If you're using a screen reader, check the Turn on screen reader mode checkbox. This option configures gcloud to use status trackers instead of unicode spinners, display progress as a percentage, and flatten tables. For more information, see the Accessibility features guide.

  3. Cloud SDK requires Python; supported versions are Python 3 (preferred, 3.5 to 3.8) and Python 2 (2.7.9 or later). By default, the Windows version of Cloud SDK comes bundled with Python 3 and Python 2. To use Cloud SDK, your operating system must be able to run a supported version of Python.

    As of January 1, 2020 the Python community no longer updates, fixes bugs, patches, or security issues for Python 2. We recommend that you upgrade to Python 3 as soon as possible. For more information, see Python 2 support on Google Cloud.

    The installer installs all necessary dependencies, including the needed Python version. While Cloud SDK installs and manages Python 3 by default, you can use an existing Python installation if necessary by unchecking the option to Install Bundled Python. See gcloud topic startup to learn how to use an existing Python installation.

  4. After installation is complete, the installer gives you the option to create Start Menu and Desktop shortcuts, start the Google Cloud CLI shell, and configure the gcloud CLI. Make sure that you leave the options to start the shell and configure your installation selected. The installer starts a terminal window and runs the gcloud init command.

  5. The default installation doesn't include the App Engine extensions required to deploy an application using gcloud commands. These components can be installed using the gcloud CLI component manager.
Troubleshooting tips:
  • If your installation is unsuccessful due to the find command not being recognized, ensure your PATH environment variable is set to include the folder containing find. Usually, this is C:\WINDOWS\system32;.
  • If you uninstalled the gcloud CLI, you must reboot your system before installing the gcloud CLI again.
  • If unzipping fails, run the installer as an administrator.
Chromebook
  1. Enable the Linux feature on your Chromebook. Installing the Google Cloud CLI on Chromebook requires this feature.
  2. Add the gcloud CLI distribution URI as a package source:
    echo "deb [signed-by=/usr/share/keyrings/cloud.google.gpg] https://packages.cloud.google.com/apt cloud-sdk main" | sudo tee -a /etc/apt/sources.list.d/google-cloud-sdk.list
  3. Import the Google Cloud public key:
    curl https://packages.cloud.google.com/apt/doc/apt-key.gpg | sudo apt-key --keyring /usr/share/keyrings/cloud.google.gpg add -
  4. Update and install the gcloud CLI:
    sudo apt-get update && sudo apt-get install google-cloud-cli
  5. (Optional) Install any of the following additional components:
    • google-cloud-cli
    • google-cloud-cli-anthos-auth
    • google-cloud-cli-app-engine-go
    • google-cloud-cli-app-engine-grpc
    • google-cloud-cli-app-engine-java
    • google-cloud-cli-app-engine-python
    • google-cloud-cli-app-engine-python-extras
    • google-cloud-cli-bigtable-emulator
    • google-cloud-cli-cbt
    • google-cloud-cli-cloud-build-local
    • google-cloud-cli-cloud-run-proxy
    • google-cloud-cli-config-connector
    • google-cloud-cli-datalab
    • google-cloud-cli-datastore-emulator
    • google-cloud-cli-firestore-emulator
    • google-cloud-cli-gke-gcloud-auth-plugin
    • google-cloud-cli-kpt
    • google-cloud-cli-kubectl-oidc
    • google-cloud-cli-local-extract
    • google-cloud-cli-minikube
    • google-cloud-cli-nomos
    • google-cloud-cli-pubsub-emulator
    • google-cloud-cli-skaffold
    • google-cloud-cli-spanner-emulator
    • google-cloud-cli-terraform-validator
    • google-cloud-cli-tests
    • kubectl

    For example, the google-cloud-cli-app-engine-java component can be installed as follows:

    sudo apt-get install google-cloud-cli-app-engine-java
  6. Run gcloud init to get started:
    gcloud init

Downgrading gcloud CLI versions

To revert to a specific version of the gcloud CLI, where VERSION is of the form 123.0.0, run the following command:

sudo apt-get update && sudo apt-get install google-cloud-cli=123.0.0-0

The ten most recent releases are always available in the repo.

NOTE: For releases prior to 371.0.0, the package name is google-cloud-sdk

Optional: Install the latest Cloud Client Libraries

You can download Cloud Client Libraries for supported languages.

Initializing the gcloud CLI

Use the gcloud init command to perform several common gcloud CLI setup tasks. These include authorizing the gcloud CLI to access Google Cloud using your user account credentials and setting up the default configuration.

  1. Initialize the gcloud CLI:

    gcloud init
    
  2. Accept the option to log in using your Google user account:

    To continue, you must log in. Would you like to log in (Y/n)? Y
    
  3. In your browser, log in to your Google user account when prompted and click Allow to grant permission to access Google Cloud resources.

  4. At the command prompt, select a Google Cloud project from the list of projects where you have Owner, Editor or Viewer permissions:

    Pick cloud project to use:
     [1] [my-project-1]
     [2] [my-project-2]
     ...
     Please enter your numeric choice:
    

    If you only have one project, gcloud init selects it for you.

    If you have access to more than 200 projects, you will be prompted to enter a project id, create a new project, or list projects.

    This account has a lot of projects! Listing them all can take a while.
     [1] Enter a project ID
     [2] Create a new project
     [3] List projects
    Please enter your numeric choice:
    
  5. If you have the Compute Engine API enabled, gcloud init allows you to choose a default Compute Engine zone:

    Which compute zone would you like to use as project default?
     [1] [asia-east1-a]
     [2] [asia-east1-b]
     ...
     [14] Do not use default zone
     Please enter your numeric choice:
    

    gcloud init confirms that you have complete the setup steps successfully:

    gcloud has now been configured!
    You can use [gcloud config] to change more gcloud settings.
    
    Your active configuration is: [default]
    
  6. (Optional) To improve the screen reader experience, enable the accessibility/screen_reader property:

    gcloud config set accessibility/screen_reader true
    

    For more details about the accessibility features that come with the gcloud CLI, see Enabling accessibility features guide.

Running core commands

Run core commands to view information about your gcloud CLI installation:

  1. List accounts whose credentials are stored on the local system:

    gcloud auth list
    

    The gcloud CLI displays a list of credentialed accounts:

    Credentialed Accounts
    ACTIVE             ACCOUNT
    *                  example-user-1@gmail.com
                       example-user-2@gmail.com
    
  2. List the properties in your active gcloud CLI configuration:

    gcloud config list
    

    The gcloud CLI displays the list of properties:

    [core]
    account = example-user-1@gmail.com
    disable_usage_reporting = False
    project = example-project
    
  3. View information about your gcloud CLI installation and the active configuration:

    gcloud info
    

    The gcloud CLI displays a summary of information about your installation. This includes information about your system, the installed components, the active user account and current project, and the properties in the active configuration.

  4. View information about gcloud commands and other topics:

    gcloud help
    

    For example, to view the help for gcloud compute instances create:

    gcloud help compute instances create
    

    The gcloud CLI displays a help topic that contains a description of the command, a list of command flags and arguments, and examples of how to use the command.

Clean up

To avoid incurring charges to your Google Cloud account for the resources used on this page, follow these steps.

  1. In the Google Cloud console, go to the Manage resources page.

    Go to Manage resources

  2. In the project list, select the project that you want to delete, and then click Delete.
  3. In the dialog, type the project ID, and then click Shut down to delete the project.

What's next

  • Read the gcloud CLI guide for an overview of the gcloud CLI, including a quick introduction to key concepts, command conventions, and helpful tips.
  • Read the gcloud CLI reference guide for detailed pages on each The gcloud CLI command, including descriptions, flags, and examples, that you can use to perform a variety of tasks on Google Cloud.
  • Refer to the gcloud CLI cheat sheet for a list of commonly used commands and key concepts.
  • Install additional components such as the App Engine emulators or kubectl using the gcloud CLI component manager.