Quickstart: Getting started with Cloud SDK

This quickstart guides you through installing and initializing Cloud SDK as well as running a few core gcloud commands to get you started.

Installing the latest Cloud SDK version (337.0.0)

Linux

Cloud SDK requires Python; supported versions are Python 3 (preferred, 3.5 to 3.8) and Python 2 (2.7.9 or higher).
```
python --version
```
For more information on how to choose and configure your Python interpreter, refer to gcloud topic startup.
Download one of the following:
Note: To determine your OS version, run getconf LONG_BIT from your command line.

Platform	Package	Size	SHA256 Checksum
Linux 64-bit (x86_64)	google-cloud-sdk-337.0.0-linux-x86_64.tar.gz	84.6 MB	04835064bd1b015ad1f6797f2df5f7d8c47522b3d47d7c283d0b8b46c970309d
Linux 32-bit (x86)	google-cloud-sdk-337.0.0-linux-x86.tar.gz	82.0 MB	f65981cf48a9d0993454d00b455b9d36a93ef6c45ba32dc228cff0645cb62cca

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

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

For the 32-bit archive file, run:

curl -O https://dl.google.com/dl/cloudsdk/channels/rapid/downloads/google-cloud-sdk-337.0.0-linux-x86.tar.gz
Extract the contents of the file to any location on your file system (preferably your Home directory). If you would like to replace an existing installation, remove the existing google-cloud-sdk directory and extract the archive to the same location.
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 (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) 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.
Run gcloud init to initialize the SDK:

./google-cloud-sdk/bin/gcloud init

Optional. Install additional components using the component manager.

Debian/Ubuntu

Package contents

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.

Prerequisites

Before you install Cloud SDK, make sure that your operating system is one of the following:

Ubuntu release that has not reached end-of-life
Debian stable release from Wheezy forward

Installation

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

Make sure you have apt-transport-https installed:

sudo apt-get install apt-transport-https ca-certificates gnupg

Note: If your distribution does not support the signed-by option run this command instead:

echo "deb https://packages.cloud.google.com/apt cloud-sdk main" | sudo tee -a /etc/apt/sources.list.d/google-cloud-sdk.list

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 -
```
Note: If you are unable to get latest updates due to an expired key, obtain the latest apt-get.gpg key file.
Note: If your distribution's apt-key command does not support the --keyring argument run this command instead:
```
curl https://packages.cloud.google.com/apt/doc/apt-key.gpg | sudo apt-key add -
```

Update and install the Cloud SDK:

sudo apt-get update && sudo apt-get install google-cloud-sdk

For additional apt-get options, such as disabling prompts or dry runs, refer to the apt-get man pages.

Docker Tip: If installing the Cloud SDK 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-sdk -y

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
```
Run gcloud init to get started:
```
gcloud init
```

Downgrading Cloud SDK versions

If you'd like to revert to a specific version of Cloud SDK, where VERSION is of the form 123.0.0, run: sudo apt-get update && sudo apt-get install google-cloud-sdk=123.0.0-0 The most recent ten releases will always be available in the repo.

Red Hat/Fedora/CentOS

Package contents

Cloud SDK is available in package format for installation on Red Hat Enterprise Linux 7, Red Hat Enterprise Linux 8, Fedora 33, and CentOS 7 and 8 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 as described later in this section.

Installation

Update DNF 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=0
gpgkey=https://packages.cloud.google.com/yum/doc/yum-key.gpg
       https://packages.cloud.google.com/yum/doc/rpm-package-key.gpg
EOM

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

Install the Cloud SDK:
```
sudo dnf install google-cloud-sdk
```

Note: If you haven't moved to dnf on your system, you can run these commands using yum instead.

You can also use dnf/yum options, such as disabling prompts or dry runs, with the provided commands.

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 dnf install google-cloud-sdk-app-engine-java
```
Run gcloud init to get started:
```
gcloud init
```

Downgrading Cloud SDK versions

If you'd like to revert to a specific version of Cloud SDK, where VERSION is of the form 123.0.0, run: sudo dnf downgrade google-cloud-sdk-VERSION The most recent ten releases will always be available in the repo.

macOS

Cloud SDK requires Python; supported versions are Python 3 (preferred, 3.5 to 3.8) and Python 2 (2.7.9 or higher). Modern versions of macOS include the appropriate version of Python required for the Cloud SDK.
However, if you'd like to install Python 3 with Cloud SDK, you can choose the macOS 64-bit with bundled Python installation offering.
To check your current Python version, run:
```
  python -V
  
```
For more information on how to choose and configure your Python interpreter, refer to gcloud topic startup.
Download one of the following:
Note: To determine your machine hardware name, run uname -m from your command line.

Platform	Package	Size	SHA256 Checksum
macOS 64-bit (x86_64)	google-cloud-sdk-337.0.0-darwin-x86_64.tar.gz	85.1 MB	f9828404af0f166afbaf4d9f00e8c1fab0d3a54b5a7f7cda0e0402712508e522
macOS 64-bit (arm64)	google-cloud-sdk-337.0.0-darwin-arm.tar.gz	85.0 MB	54bb70d2eca27ac550a431abc10e9030f2a748703cfca18f86510f9bc7849d0c
macOS 64-bit with bundled Python (x86_64)	google-cloud-sdk-337.0.0-darwin-x86_64-bundled-python.tar.gz	127.0 MB	e6c0c8c7f360be118c9416e7d990d0c92c73a2894cb75219e73bd703b73812d1
macOS 32-bit (x86)	google-cloud-sdk-337.0.0-darwin-x86.tar.gz	88.9 MB	ae70b48ed51c4a025f606842213e7aaa7f40ada9d17df5578f8a7cb2383806a2

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.
If you would like to replace an existing installation, remove the existing google-cloud-sdk directory and extract the archive to the same location.
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 (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) as well by providing preferences as flags. These are described in:
```
./google-cloud-sdk/install.sh --help
```
If you'd like 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.
Run gcloud init to initialize the SDK:

./google-cloud-sdk/bin/gcloud init

Optional. Install additional components using the component manager.

Windows

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

Launch the installer and follow the prompts. The installer is signed by Google LLC.

If you'd like to enable screen reader mode, select the Turn on screen reader mode option for a more streamlined screen reader experience. To read more about the Cloud SDK screen reader experience, refer to the Accessibility features guide.
Cloud SDK requires Python; supported versions are Python 3 (preferred, 3.5 to 3.8) and Python 2 (2.7.9 or higher).

The installer will install all necessary dependencies, including the needed Python version. While Cloud SDK currently uses Python 3 by default, you can use an existing Python installation if necessary by unchecking the option to Install Bundled Python.
After installation has completed, the installer presents several options:

Make sure that the following are selected:
- Start Google Cloud SDK Shell
- Run gcloud init
The installer starts a terminal window and runs the gcloud init command.
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.

Troubleshooting tips:

If the Cloud SDK fails to run after installing version 274.0.0, please refer to this tracking bug for the latest workarounds.
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 have just uninstalled Cloud SDK, you will need to reboot your system before installing Cloud SDK again.

Optional: Install the latest Google Cloud Client Libraries

You can download Cloud Client Libraries for supported languages.

Initializing the Cloud SDK

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

To initialize the Cloud SDK:

Run the following at a command prompt:
```
gcloud init
```
Note: To prevent the command from launching a web browser, use gcloud init --console-only instead. To authorize without a web browser and non-interactively, create a service account with the appropriate scopes using the Google Cloud Console and use gcloud auth activate-service-account with the corresponding JSON key file.

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

In your browser, log in to your Google user account when prompted and click Allow to grant permission to access Google Cloud resources.
At the command prompt, select a Google Cloud project from the list of those 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:
```
Note: If you choose to create a project, you'll also need to enable billing on your project to use Google Cloud services.

If you have the Google 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]

(Optional) If you'd like 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.

Running core commands

Run these gcloud commands to view information about your Cloud SDK installation:

To list accounts whose credentials are stored on the local system:

gcloud auth list

gcloud displays a list of credentialed accounts:

       Credentialed Accounts
ACTIVE             ACCOUNT
*                  example-user-1@gmail.com
                   example-user-2@gmail.com

To list the properties in your active Cloud SDK configuration:

gcloud config list

gcloud displays the list of properties:

[core]
account = example-user-1@gmail.com
disable_usage_reporting = False
project = example-project

To view information about your Cloud SDK installation and the active configuration:
```
gcloud info
```
gcloud displays a summary of information about your Cloud SDK installation. This includes information about your system, the installed components, the active user account and current project, and the properties in the active configuration.
To view information about gcloud commands and other topics from the command line:
```
gcloud help
```
For example, to view the help for gcloud compute instances create:
```
gcloud help compute instances create
```
gcloud displays a help topic that contains a description of the command, a list of command flags and arguments, and examples of how to use it.

What's next

Read the gcloud command-line tool guide for an overview of the gcloud command-line tool, including a quick introduction to key concepts, command conventions, and helpful tips.
Read the gcloud command-line tool reference guide for detailed pages on each gcloud command, including descriptions, flags, and examples, that you can use to perform a variety of tasks on Google Cloud.
Refer to the gcloud command-line tool 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 Cloud SDK component manager.

Try it for yourself

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.

Get started for free