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.
To follow step-by-step guidance for this task directly in the Google Cloud console, click Guide me:
Before you begin
- 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.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
When you finish the tasks that are described in this document, you can avoid continued billing by deleting the resources that you created. For more information, see Clean up.
Installing the latest gcloud CLI version (489.0.0)
- Confirm that you have a supported version of Python. The Google Cloud CLI requires
Python 3.8 to 3.12. Note that the x86_64 Linux package includes
a bundled Python interpreter that will be preferred by default. For
information on how to choose and configure your Python interpreter, see
gcloud topic startup
. - Download one of the following:
Platform Package name Size SHA256 Checksum Linux 64-bit (x86_64)
google-cloud-cli-linux-x86_64.tar.gz 130.3 MB b101e277bcb9027157983cb821aef40bf362fe05d9a707b5708977637c8151cd Linux 64-bit (Arm)
google-cloud-cli-linux-arm.tar.gz 52.8 MB 4757ac87f8e6ba7c5dc9187173c3ea74ca1ca3d17fc1164b1506d4ce8c52839c Linux 32-bit (x86)
google-cloud-cli-linux-x86.tar.gz 52.8 MB 11ac8d5b2b08f104675876c39500f87aa11626abf43c078b83eb8b122d0cddce To download the Linux archive file, run the following command:
curl -O https://dl.google.com/dl/cloudsdk/channels/rapid/downloads/google-cloud-cli-linux-x86_64.tar.gz
Refer to the table above and replace google-cloud-cli-linux-x86_64.tar.gz with the
*.tar.gz
package name that applies to your configuration. - To extract the contents of the file to your file system (preferably to
your home directory), run the following command:
Optional: To replace an existing installation, remove the existingtar -xf google-cloud-cli-linux-x86_64.tar.gz
google-cloud-sdk
directory and then extract the archive to the same location. - Add the gcloud CLI to your path. Run the installation script from the root of the
folder you extracted to using the following command:
This can also be done non-interactively (for example, using a script) and by providing preferences as flags. To view the available flags, run:./google-cloud-sdk/install.sh
Optional:./google-cloud-sdk/install.sh --help
- To send anonymous usage statistics
to help improve the gcloud CLI, answer
Y
when prompted. -
To add the gcloud CLI to your
PATH
and enable command completion, answerY
when prompted.
- To send anonymous usage statistics
to help improve the gcloud CLI, answer
- Open a new terminal so that the changes take effect.
- To initialize the gcloud CLI, run
gcloud init
: - Optional: Install additional components using the component manager.
./google-cloud-sdk/bin/gcloud init
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 install the gcloud CLI, make sure that your operating system meets the following requirements:
- It is an Ubuntu release that hasn't reached end-of-life or a Debian stable release that hasn't reached end-of-life
- It has recently updated its packages:
sudo apt-get update
- It has
apt-transport-https
andcurl
installed:sudo apt-get install apt-transport-https ca-certificates gnupg curl
- Import the Google Cloud public key.
For newer distributions (Debian 9+ or Ubuntu 18.04+) run the following command:
curl https://packages.cloud.google.com/apt/doc/apt-key.gpg | sudo gpg --dearmor -o /usr/share/keyrings/cloud.google.gpg
- For older distributions, 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 you can't get latest updates due to an expired key, obtain the latest apt-get.gpg key file.
- Add the gcloud CLI distribution URI as a package source.
- For newer distributions (Debian 9+ or Ubuntu 18.04+), 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
For older distributions that don'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
- For newer distributions (Debian 9+ or Ubuntu 18.04+), run the following command:
- Update and install the gcloud CLI:
For additionalsudo apt-get update && sudo apt-get install google-cloud-cli
apt-get
options, such as disabling prompts or dry runs, refer to theapt-get
man pages.Docker Tip: If installing the gcloud CLI inside a Docker image, use a single RUN step instead:
For older base images that do not support theRUN echo "deb [signed-by=/usr/share/keyrings/cloud.google.gpg] https://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 | sudo gpg --dearmor -o /usr/share/keyrings/cloud.google.gpg && apt-get update -y && apt-get install google-cloud-cli -y
gpg --dearmor
command:RUN echo "deb [signed-by=/usr/share/keyrings/cloud.google.gpg] https://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
- (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-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
- 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
Package contents
The gcloud CLI is available in package format for installation on
Red Hat Enterprise Linux 7, 8, and 9; Fedora 33 and 34; and CentOS 7 and 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.
- Update DNF with gcloud CLI repository information.
The following sample command is for a Red Hat Enterprise Linux 9-compatible
installation, but make sure that you update the settings as needed for your
configuration:
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-el9-x86_64 enabled=1 gpgcheck=1 repo_gpgcheck=0 gpgkey=https://packages.cloud.google.com/yum/doc/rpm-package-key.gpg EOM
-
If you're installing on Fedora 34 or 35, install
libxcrypt-compat.x86_64
.sudo dnf install libxcrypt-compat.x86_64
- Install the gcloud CLI:
sudo dnf install google-cloud-cli
- (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-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
- 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 repository.
NOTE: For releases prior to 371.0.0, the package name is google-cloud-sdk
-
Confirm that you have a supported version of Python:
-
To check your current Python version, run
python3 -V
orpython -V
. Supported versions are Python 3.8 to 3.12. - The main install script offers to install CPython's Python 3.11.
- Otherwise, to install a supported Python version, please visit the Python.org Python Releases for macOS.
- If you have multiple Python interpreters installed on your machine, set the CLOUDSDK_PYTHON environment variable within your shell to point to the path of your preferred interpreter.
-
For more information on how to choose and configure your Python interpreter, see
gcloud topic startup
.
-
To check your current Python version, run
- 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.To replace an existing installation, remove the existing
google-cloud-sdk
directory and then extract the archive to the same location. -
(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.11.Run the script (from the root of the folder you extracted in the last step) using this command:
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
To run the install script with screen reader mode on:./google-cloud-sdk/install.sh --help
Open a new terminal so that the changes take effect../google-cloud-sdk/install.sh --screen-reader=true
-
To initialize the gcloud CLI, run
gcloud init
: - Optional. Install additional components using the component manager.
Platform | Package | Size | SHA256 Checksum |
---|---|---|---|
macOS 64-bit
(x86_64) |
google-cloud-cli-darwin-x86_64.tar.gz | 52.9 MB | 50c4544cd386b653411031a4ef3be7d8e3e2851130585ed2beabc7bb068fb075 |
macOS 64-bit
(ARM64, Apple M1 silicon) |
google-cloud-cli-darwin-arm.tar.gz | 52.8 MB | 70295f98a25dec121a7d98df9635140b14cac9332f8accea346b8c04bb1ebed1 |
macOS 32-bit
(x86) |
google-cloud-cli-darwin-x86.tar.gz | 51.5 MB | 88fbcbcce5b07bf60ba09a4447ad5a538855073a782b61e49ee45408015afe27 |
./google-cloud-sdk/bin/gcloud init
-
The Google Cloud CLI works on Windows 8.1 and later and Windows Server 2012 and later.
-
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
-
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. -
Google Cloud CLI requires Python; supported versions are Python 3.8 to 3.12. By default, the Windows version of Google Cloud CLI comes bundled with Python 3. To use Google Cloud CLI your operating system must be able to run a supported version of Python.
The installer installs all necessary dependencies, including the needed Python version. While Google Cloud CLI 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. 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.- 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.
- 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 uninstalled the gcloud CLI, you must reboot your system before installing the gcloud CLI again.
- If unzipping fails, run the installer as an administrator.
- Enable the Linux feature on your Chromebook. Installing the Google Cloud CLI on Chromebook requires this feature.
- 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
- 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 gcloud CLI:
sudo apt-get update && sudo apt-get install google-cloud-cli
- (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-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
- 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.
Initialize the gcloud CLI:
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 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:
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:Run `gcloud help config` to learn how to change individual settings This gcloud configuration is called [default]. You can create additional configurations if you work with multiple accounts and/or projects. Run `gcloud topic configurations` to learn more. Some things to try next: * Run `gcloud --help` to see the Cloud Platform services you can interact with. And run `gcloud help COMMAND` to get help on any gcloud command. * Run `gcloud topic --help` to learn about advanced features of the SDK like arg files and output formatting * Run `gcloud cheat-sheet` to see a roster of go-to `gcloud` commands.
(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:
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
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
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.
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.
- In the Google Cloud console, go to the Manage resources page.
- In the project list, select the project that you want to delete, and then click Delete.
- 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.