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.

You should read Set up the Google Cloud CLI for Trusted Cloud before following any instructions in this guide.

Before you begin

  1. In the Trusted Cloud console, on the project selector page, select or create a Trusted Cloud project.

    Go to project selector

  2. Make sure that billing is enabled for your Trusted 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 (529.0.0)

Linux
  1. Confirm that you have a supported version of Python. The Google Cloud CLI requires Python 3.8 to 3.13. 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.
  2. Download one of the following:
    Platform Package name Size SHA256 Checksum
    Linux 64-bit

    (x86_64)

    google-cloud-cli-linux-x86_64.tar.gz 149.7 MB 01d322b29107e57f13e1418c789b9c3c0e6db1eb8e182d41ab6de09e6e0ca805
    Linux 64-bit

    (Arm)

    google-cloud-cli-linux-arm.tar.gz 56.3 MB 009a1ca0b114e4049cadb517a81c2a4b697d180425da1d2fdb456952d7f070b5
    Linux 32-bit

    (x86)

    google-cloud-cli-linux-x86.tar.gz 56.3 MB 1fea8bf6373c49c435ab4089aa128f981da425408b28f88b6c4a91d18b19e3a3

    To download the Linux archive file, run the following command:

    curl -O https://storage.s3nsapis.fr/cloud-sdk-release/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.

  3. To extract the contents of the file to your file system (preferably to your home directory), run the following command:
    tar -xf google-cloud-cli-linux-x86_64.tar.gz
    Optional: To replace an existing installation, remove the existing google-cloud-sdk directory and then extract the archive to the same location.
  4. (Optional) Add the gcloud CLI to your PATH. You can also opt-in to command-completion for your shell and usage statistics collection. Run the installation script (from the root of the folder you extracted in the last step) 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. To view the available flags, run:
    ./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, answer Y when prompted.
  5. If you updated your PATH in the previous step, open a new terminal so that the changes take effect.
  6. To initialize the gcloud CLI, run gcloud init:
  7. ./google-cloud-sdk/bin/gcloud init
  8. Optional: Install additional components using the component manager.
macOS
  1. Confirm that you have a supported version of Python:
    • To check your current Python version, run python3 -V or python -V. Supported versions are Python 3.8 to 3.13.
    • The main install script offers to install CPython's Python 3.12.
      • Xcode command line tool is required to install Python.
      • Verify that Xcode is installed by running: xcode-select -p.
      • If Xcode is not installed, install it by running: sudo xcode-select --install.
    • 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.
  2. Download one of the following:
  3. Platform Package Size SHA256 Checksum
    macOS 64-bit

    (x86_64)

    google-cloud-cli-darwin-x86_64.tar.gz 56.3 MB 0887b51c608dd495ad2061ab014a3da38478fb181ab0fbec2332d8ec3533b976
    macOS 64-bit

    (ARM64, Apple silicon)

    google-cloud-cli-darwin-arm.tar.gz 56.3 MB 829354216486a573db79725e204f59dbfd1e6fdabcab151bff739a6aaacd7c6b
    macOS 32-bit

    (x86)

    google-cloud-cli-darwin-x86.tar.gz 54.8 MB 9525325623a4ef7e78562347099dc61330bf2159eb4748ad36570e9f283f5618
  4. 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. Or run the following command:
    tar -xf google-cloud-cli-darwin-arm.tar.gz

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

  5. Run the installation script (from the root of the folder you extracted in the last step) using the following command:
    ./google-cloud-sdk/install.sh

    The script will prompt to install Python 3.12 and certain recommended modules.

    The install 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
    Optional:
    • 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, answer Y when prompted.
  6. If you updated your PATH in the previous step, open a new terminal so that the changes take effect.
  7. To initialize the gcloud CLI, run gcloud init:
  8. ./google-cloud-sdk/bin/gcloud init
  9. 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://storage.s3nsapis.fr/cloud-sdk-release/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. Google Cloud CLI requires Python; supported versions are Python 3.8 to 3.13. 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.

  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.

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 Trusted Cloud using your user account credentials and setting up the default configuration.

  1. Initialize the gcloud CLI:

    gcloud init
    
  2. Accept the option to sign 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, sign in to your Google user account when prompted and click Allow to grant permission to access Trusted Cloud resources.

  4. At the command prompt, select a Trusted 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 lets 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.
    
  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 Trusted Cloud account for the resources used on this page, follow these steps.

  1. In the Trusted 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 Trusted 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.