Google Cloud SDK documentation

Google Cloud SDK is a set of tools that you can use to manage resources and applications hosted on Google Cloud Platform. These include the gcloud, gsutil, and bq command line tools. The gcloud command-line tool is downloaded along with the Cloud SDK; a comprehensive guide to the gcloud CLI can be found in gcloud command-line tool overview.

Additionally, the gcloud CLI reference documents all of the gcloud CLI's functionality. For a quicker introduction, refer to the gcloud command-line tool cheat sheet.

Install the latest Cloud SDK version (306.0.0)

Linux

  1. Cloud SDK requires Python. Supported versions are 3.5 to 3.7, and 2.7.9 or higher.

    python2 --version
  2. Download one of the following:

    3. Platform Package Size SHA256 Checksum
    Linux 64-bit

    (x86_64)

    		 google-cloud-sdk-306.0.0-linux-x86_64.tar.gz 85.0 MB 99eca0b1d6b8a906843b06e8af231e74a905cd21f0a69dd9b9daff76946b73e1
    Linux 32-bit

    (x86)

    		 google-cloud-sdk-306.0.0-linux-x86.tar.gz 83.2 MB bc50b922488ae09b242a47fa7ec6d99bfca4cf430b1e31f5213439978282b923

  3. Extract the contents of the file to any location on your file system. If you would like to replace an existing installation, remove the existing google-cloud-sdk directory and extract the archive to the same location.
  4. Optional. Use the install script to add Cloud SDK tools to your path. You'll also be able to opt-in to command-completion for your shell and usage statistics collection. Run the script using this command: 
    ./google-cloud-sdk/install.sh
    This can also be done non-interactively (for example, using a script) as well by providing preferences as flags. These are described in: 
    ./google-cloud-sdk/install.sh --help
    Open a new terminal so that the changes take effect.
  5. Run gcloud init to initialize the SDK:
    6. ./google-cloud-sdk/bin/gcloud init
  6. Optional. Install additional components using the component manager.
Debian/Ubuntu

Cloud SDK 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 does not 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 as described later in this section.

You can install the Cloud SDK from a Debian/Ubuntu package for all official Ubuntu releases that have not reached end of life, and Debian stable releases from Wheezy forward.

Note: If you are using an instance on Google Compute Engine, Cloud SDK is installed by default. You can still manually install Cloud SDK using the instructions below.

  1. Add the Cloud SDK 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
    Note: Make sure you have apt-transport-https installed: 
    sudo apt-get install apt-transport-https ca-certificates gnupg
  2. 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 -
  3. Update and install the Cloud SDK: 
    sudo apt-get update && sudo apt-get install google-cloud-sdk
    Note: For additional apt-get options, such as disabling prompts or dry runs, refer to the apt-get man pages.
  4. Optionally, install any of these additional components:
    • google-cloud-sdk-app-engine-python
    • google-cloud-sdk-app-engine-python-extras
    • google-cloud-sdk-app-engine-java
    • google-cloud-sdk-app-engine-go
    • google-cloud-sdk-bigtable-emulator
    • google-cloud-sdk-cbt
    • google-cloud-sdk-cloud-build-local
    • google-cloud-sdk-datalab
    • google-cloud-sdk-datastore-emulator
    • google-cloud-sdk-firestore-emulator
    • google-cloud-sdk-pubsub-emulator
    • kubectl

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

    sudo apt-get install google-cloud-sdk-app-engine-java
  5. Run gcloud init to get started: 
    gcloud init
Red Hat/Fedora/CentOS

Cloud SDK is available in package format for installation on Red Hat Enterprise Linux 7, Red Hat Enterprise Linux 8, Fedora 32, and CentOS 7 systems. This package contains the gcloud, gcloud alpha, gcloud beta, gsutil, and bq commands only. It does not include kubectl or the App Engine extensions required to deploy an application using gcloud commands, which can be installed separately.

Note: If you are using an instance on Google Compute Engine, Cloud SDK is installed by default.

  1. Update YUM with Cloud SDK repo information: 
    sudo tee -a /etc/yum.repos.d/google-cloud-sdk.repo << EOM
[google-cloud-sdk]
name=Google Cloud SDK
baseurl=https://packages.cloud.google.com/yum/repos/cloud-sdk-el7-x86_64
enabled=1
gpgcheck=1
repo_gpgcheck=1
gpgkey=https://packages.cloud.google.com/yum/doc/yum-key.gpg
       https://packages.cloud.google.com/yum/doc/rpm-package-key.gpg
EOM

    Important: The second line of gpgkey must be indented as shown.

  2. Install the Cloud SDK: 
    yum install google-cloud-sdk
    Note: For additional yum options, such as disabling prompts or dry runs, refer to the yum man pages.
  3. Optionally, install any of these additional components:
    • google-cloud-sdk-app-engine-python
    • google-cloud-sdk-app-engine-python-extras
    • google-cloud-sdk-app-engine-java
    • google-cloud-sdk-app-engine-go
    • google-cloud-sdk-bigtable-emulator
    • google-cloud-sdk-cbt
    • google-cloud-sdk-cloud-build-local
    • google-cloud-sdk-datalab
    • google-cloud-sdk-datastore-emulator
    • google-cloud-sdk-firestore-emulator
    • google-cloud-sdk-pubsub-emulator
    • kubectl

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

    yum install google-cloud-sdk-app-engine-java
  4. Run gcloud init to get started: 
    gcloud init
macOS
  1. Cloud SDK requires Python. Supported versions are 3.5 to 3.7, and 2.7.9 or higher. Modern versions of macOS include the appropriate version of Python required for the Cloud SDK. 
    2. python -V
  2. Download one of the following:

    3. Platform Package Size SHA256 Checksum
    macOS 64-bit

    (x86_64)

    		 google-cloud-sdk-306.0.0-darwin-x86_64.tar.gz 85.3 MB 613e65c5596b8218ec827cf9ed78b87e9e445905f57991f3eb07c6efdf4d59d0
    macOS 32-bit

    (x86)

    		 google-cloud-sdk-306.0.0-darwin-x86.tar.gz 84.3 MB 3802093ff0fbd5538cb11ce271c37d8ac1a05ad0fc86cc9ca0cd624e28583c01

  3. Extract the contents of the file to any location on your file system. If you would like to replace an existing installation, remove the existing google-cloud-sdk directory and extract the archive to the same location.
  4. Optional. Use the install script to add Cloud SDK tools to your path. You'll also be able to opt-in to command-completion for your shell and usage statistics collection. Run the script using this command: 
    ./google-cloud-sdk/install.sh
    This can also be done non-interactively (for example, using a script) as well by providing preferences as flags. These are described in: 
    ./google-cloud-sdk/install.sh --help
    Open a new terminal so that the changes take effect.
  5. Run gcloud init to initialize the SDK:
    6. ./google-cloud-sdk/bin/gcloud init
  6. Optional. Install additional components using the component manager.
Windows

  1. Download the Cloud SDK 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.

    Cloud SDK requires Python. Supported versions are 3.5 to 3.7, and 2.7.9 or higher.

    The installer will install all necessary dependencies, including the needed Python version. While Cloud SDK currently uses Python 2 by default, you can use an existing Python installation if necessary by unchecking the option to 'Install Bundled Python'. .

  3. After installation has completed, accept the following options:

    • Start Cloud SDK Shell
    • Run gcloud init

    The installer starts a terminal window and runs the gcloud init command.

  4. The default installation does not include the App Engine extensions required to deploy an application using gcloud commands. These components can be installed using the Cloud SDK component manager.

Install the latest Google Cloud Client Libraries

You can download Cloud Client Libraries for supported languages.

Optional: Enable accessibility features

For a more streamlined screen reader experience, the gcloud command-line tool comes with an accessibility/screen_reader property.

To enable this property, run:

gcloud config set accessibility/screen_reader true

For more details about the accessibility features that come with the gcloud command-line tool, refer to the Enabling accessibility features guide.

More information

Quickstarts

Install and initialize Cloud SDK

How-to guides

Learn a task

APIs and reference

gcloud CLI reference

Concepts

Develop a deep understanding of Cloud SDK

Support

Get assistance with Cloud SDK issues

Resources

Pricing, quotas, and release notes

Solutions

Cross-product guides, best practices, and scenario-based examples