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 (335.0.0)
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 togcloud topic startup
.- Download one of the following:
-
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-335.0.0-linux-x86_64.tar.gz
curl -O https://dl.google.com/dl/cloudsdk/channels/rapid/downloads/google-cloud-sdk-335.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:
- Optional. Install additional components using the component manager.
Platform | Package | Size | SHA256 Checksum |
---|---|---|---|
Linux 64-bit (x86_64) |
google-cloud-sdk-335.0.0-linux-x86_64.tar.gz | 84.4 MB | 9cc234763bc70dc383a84a1b74adacc2816be991002352423037f56150fc6b8b |
Linux 32-bit (x86) |
google-cloud-sdk-335.0.0-linux-x86.tar.gz | 81.8 MB | 3b694c9bd8b811a81043dcfc4b03f5483d9fa0a614fd5204c678c8e85d837037 |
./google-cloud-sdk/bin/gcloud init
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.
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
- 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
- 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 -
- Update and install the Cloud SDK:
sudo apt-get update && sudo apt-get install google-cloud-sdk
For additionalapt-get
options, such as disabling prompts or dry runs, refer to theapt-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.
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.
- 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
- Install the Cloud SDK:
sudo dnf install google-cloud-sdk
- 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.
- 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 togcloud topic startup
. - Download one of the following:
- 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:
- Optional. Install additional components using the component manager.
Platform | Package | Size | SHA256 Checksum |
---|---|---|---|
macOS 64-bit (x86_64) |
google-cloud-sdk-335.0.0-darwin-x86_64.tar.gz | 84.9 MB | 10c281ec93214058d04badec1832d57932c11a79e9cf5fa0da4bb0e7f92b1a6d |
macOS 64-bit (arm64) |
google-cloud-sdk-335.0.0-darwin-arm.tar.gz | 84.9 MB | e45a5e1d502f062cb9ddf919b7e86df9b1f775cdbb65717e8973b065cc3879fe |
macOS 64-bit with bundled Python (x86_64) |
google-cloud-sdk-335.0.0-darwin-x86_64-bundled-python.tar.gz | 126.9 MB | 7ab2b3efacbda5ba0616657f76e6b3280502ef8ace1ef331dfd4eb548fb66917 |
macOS 32-bit (x86) |
google-cloud-sdk-335.0.0-darwin-x86.tar.gz | 88.7 MB | e1d244cc85486d30eb79ffb06b9fde8c7c63c4d5ca16cae34805deb071475654 |
./google-cloud-sdk/bin/gcloud init
-
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.
- 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 yourPATH
environment variable is set to include the folder containingfind
. Usually, this isC:\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
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:
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