Install gsutil

gsutil is a tool that lets you access Cloud Storage from the command line by using HTTPS. This page describes how to install and set up gsutil as a standalone tool.

Once you install gsutil, you can read or write data in Cloud Storage as permitted, including reading public data. However, most tasks require specific permissions:

This page also contains instructions on installing gsutil as part of the Google Cloud CLI, which is discouraged due to the eventual unbundling of gsutil from the Google Cloud CLI installation package.

System requirements

  • The gsutil tool runs on Linux/Unix, Mac OS, and Windows (versions 8.1 or 10 and later).

  • gsutil versions 5.36 or later require Python 3.9 to 3.14, which you can obtain by using your Python version manager or by installing an appropriate version.

Manage Python versions

The following instructions show you how to manage Python versions so you can use a version that supports gsutil.

Linux

Prerequisites: Install a Python version manager (pyenv) and install a suitable Python version.

  1. Set the Global Python Version:

    • To set Python 3.14 as the global version:

      pyenv global 3.14
    • To set the Python version locally for a specific project folder:

      pyenv local 3.14
  2. Confirm that the correct Python version is in use:

    python --version

    You should see the following response:

    Python 3.14

macOS

Manage Python versions by using Homebrew (brew)

Prerequisites: Install Homebrew and install a suitable Python version through Homebrew.

  1. Set a specific Python version as the default by adding the version you want to your $PATH. For example, to use Python 3.14:

    export PATH="$(brew --prefix)/opt/python@3.14/bin:$PATH"

    • To make this change permanent, add the path to your shell configuration file (~/.bash_profile, ~/.zshrc, or ~/.bashrc).
  2. Confirm that the correct Python version is in use:

    python --version

    You should see the following response:

    Python 3.14

Manage Python versions by using pyenv

Prerequisites: Install a Python version manager (pyenv) and install a suitable Python version through pyenv.

  1. Set the global Python version:

    • To set the Python version globally (for all terminals):

      pyenv global 3.14
    • To set the Python version locally for a specific project folder:

      pyenv local 3.14
  2. Confirm that the correct Python version is in use:

    python --version

    You should see the following response:

    Python 3.14

Windows

Prerequisites: Install a Python version manager (pyenv-win) and install a suitable Python version through pyenv.

  1. Set the Global Python Version:

    • To set Python 3.14 as the global version:

      pyenv global 3.14
    • To set the Python version locally for a specific project folder:

      pyenv local 3.14
  2. Confirm that the correct Python version is in use:

    python --version

    You should see the following response:

    Python 3.14

If you plan to use composite objects, you need to install compiled crcmod. On Windows, this is only available for 32-bit Python. For more information on crcmod, install gsutil and see the help topic by using the command gsutil help crc32c.

Install gsutil by using the Python package index (PyPI)

Follow the instructions for your operating system to install gsutil by using PyPI:

CentOS, RHEL, and Fedora

  1. Install required system packages.

    Several packages are required to successfully install gsutil from PyPI. You can install them with the following command:

    sudo yum install gcc openssl-devel python-devel \
      python-setuptools libffi-devel
  2. Install pip with the pip installer by running the following command:

    sudo yum install python-pip

    If you are using CentOS or RHEL and yum can't find the package python-pip, it's likely because you don't have the Extra Packages for Enterprise Linux (EPEL) repository source enabled. To enable it, follow these instructions.

  3. Install gsutil from PyPI by running the following command:

    sudo pipx install gsutil

Debian and Ubuntu

  1. Install required system packages.

    Several packages are required to successfully install gsutil from PyPI. You can install them with the following command:

    sudo apt-get install gcc python-dev python-setuptools
      libffi-dev
  2. Install pip with the pip installer by running the following command:

    sudo apt-get install python3-pip
  3. Install gsutil from PyPI by running the following command:

    sudo pip install gsutil

macOS

  1. Install pip with the pip installer by running the following commands:

    python3 -m ensurepip --default-pip
    python3 -m pip install --upgrade pip
  2. Install gsutil from PyPI by running the following command:

    sudo pip install gsutil

Windows

  1. Install pip by running the following command:

    python -m ensurepip
  2. Install gsutil from PyPI by running the following command:

    pip install gsutil

You're ready to start using gsutil. To see a listing of gsutil commands, type gsutil at the command prompt.

The gsutil update command is not available when installing gsutil using PyPI. To update gsutil, use the pip installer by running either of the following commands:

pipx upgrade gsutil
sudo pip install -U gsutil

Remove gsutil as a Google Cloud CLI component

After March 2027, gsutil will no longer be available as a component in the Google Cloud CLI. If you have gsutil installed as part of the Google Cloud CLI and would like to continue using gsutil, we recommend that you remove gsutil from your Google Cloud CLI installation and install gsutil as a standalone tool so you can continue running your scripts and getting updates for the tool.

To check whether you have gsutil installed as part of the Google Cloud CLI, run the command gsutil version -l and check the value for using cloud sdk. If False, your system is using the standalone version of gsutil when you run commands. If True, your system is using gsutil as a bundled component of the Google Cloud CLI.

To remove gsutil as a component from the Google Cloud CLI, run the following command:

gcloud components remove gsutil

The previous command works if you've installed the Google Cloud CLI by using the interactive archive script or the Windows installer. If the command doesn't work, or you used a different installation method, you can still use standalone gsutil by updating your system shell's PATH variable so that the directory of your standalone gsutil is listed before the google-cloud-sdk/bin directory. For example, add the following code to your ~/.bashrc or equivalent profile file:

if [ -d "/path/to/standalone/gsutil/directory" ]; then
    PATH="/path/to/standalone/gsutil/directory:$PATH"
fi

Install gsutil as part of the Google Cloud CLI

After March 2027, gsutil will no longer be available as part of the Google Cloud CLI installation package. We recommend migrating to the Google Cloud CLI and using gcloud storage commands instead of gsutil. However, if you want to continue using gsutil, you should install gsutil as a standalone tool by using PyPI to support your existing scripts and continue getting updates for the tool.

Although it's not recommended, you can use the following instructions to install gsutil as a part of the Google Cloud CLI. These instructions will work until March 2027, when gsutil will become unbundled from the Google Cloud CLI.

Linux
  1. Confirm that you have a supported version of Python. The Google Cloud CLI requires Python 3.10 to 3.14. 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 the gcloud topic startup documentation.
  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 88.3 MB a9561d76ee0fcbceff4caa8dc84376a5b1586d1bd25cc7f89f29fdb2a4e92ed4
    Linux 64-bit

    (Arm)

    google-cloud-cli-linux-arm.tar.gz 61.1 MB 8bf879c65b2ca542150943e17b74ea41a006e900cb23283831476eeb4ced4544
    Linux 32-bit

    (x86)

    google-cloud-cli-linux-x86.tar.gz 61.2 MB 1f0f69ad802e3e945745fa2976e3753d5055bebc71cc8d100efd12d5e10af977

    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.

  3. To extract the contents of the file to your file system, run the following command:
    tar -xf google-cloud-cli-linux-x86_64.tar.gz
    To replace an existing installation, delete the existing google-cloud-sdk directory and then extract the archive to the same location.
  4. Run the installation script from the root of the folder you extracted:
    ./google-cloud-sdk/install.sh
    The script prompts you to perform the following setup actions. To accept, answer Y when prompted.
    • Add the gcloud CLI to your PATH.
    • Enable command completion.
    • Opt in to send anonymous usage statistics to help improve the gcloud CLI.
    You can also perform the installation non-interactively by providing flags. To view available flags, run:
    ./google-cloud-sdk/install.sh --help
  5. Optional: If you updated your PATH in the previous step, open a new terminal so that the changes take effect.
  6. Run gcloud init to initialize, authorize, and configure the gcloud CLI.
  7. Optional: Install additional components using the component manager.
Debian/Ubuntu

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 command-line tools 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 begin

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. To do this now, run the following command:
    sudo apt-get update
  • It has ca-certificates, gnupg, and curl installed. To install these packages, run the following command:
    sudo apt-get install ca-certificates gnupg curl

Installation

  1. 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.

  2. 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
  3. Update and install the gcloud CLI:
    sudo apt-get update && sudo apt-get install google-cloud-cli
    For additional apt-get options, such as disabling prompts or dry runs, refer to the apt-get man pages.

    Docker Tip: If installing the gcloud CLI inside a Docker image, use a single RUN step instead:

    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 | gpg --dearmor -o /usr/share/keyrings/cloud.google.gpg && apt-get update -y && apt-get install google-cloud-cli -y
        
    For older base images that do not support the 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
          
  4. Optional: Install any of the following additional components:
    • 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-tools
    • 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
  5. Run gcloud init to initialize, authorize, and configure the gcloud CLI.

Downgrade 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. For releases prior to 371.0.0, the package name is google-cloud-sdk

Red Hat/Fedora/CentOS

Package contents

The gcloud CLI is available in package format for installation on Red Hat Enterprise Linux 7, 8, 9, and 10; Fedora 41 and 42; 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.

Installation

  1. Update DNF with gcloud CLI repository information.
    • The following sample command is for a Red Hat Enterprise Linux 7, 8, or 9-compatible installations, 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
    • For RHEL 10-compatible installations, use the following command with the updated gpgkey:

      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-el10-x86_64
      enabled=1
      gpgcheck=1
      repo_gpgcheck=0
      gpgkey=https://packages.cloud.google.com/yum/doc/rpm-package-key-v10.gpg
      EOM
    • For ARM64 (aarch64) installations, use https://packages.cloud.google.com/yum/repos/cloud-sdk-el9-aarch64 (RHEL 7, 8, or 9-compatible) or https://packages.cloud.google.com/yum/repos/cloud-sdk-el10-aarch64 (RHEL 10-compatible) as the baseurl value.

  2. Install libxcrypt-compat.x86_64.
    sudo dnf install libxcrypt-compat.x86_64
  3. Install the gcloud CLI:
    sudo dnf install google-cloud-cli
  4. Optional: Install any of the following additional components:
    • 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, to install the google-cloud-cli-app-engine-java component, run the following command:

    sudo dnf install google-cloud-cli-app-engine-java
  5. Run gcloud init to initialize, authorize, and configure the gcloud CLI.

Downgrade gcloud CLI versions

To revert to a specific version of gcloud CLI, run the following command. Replace 123.0.0 with the version that you want to install:

sudo dnf downgrade google-cloud-cli-123.0.0

The ten most recent releases are available in the repository. For releases prior to 371.0.0, use google-cloud-sdk as the package name.

macOS
  1. Confirm that you have a supported version of Python. The Google Cloud CLI requires Python 3.10 to 3.14.

    To check your Python version, run python3 -V or python -V.

    The gcloud installer will install Python v3.14 and required extension modules by default.

    For more information about configuring your Python interpreter, see the gcloud topic startup documentation.

  2. Download one of the following:
    Platform Package Size SHA256 Checksum
    macOS 64-bit

    (x86_64)

    google-cloud-cli-darwin-x86_64.tar.gz 61.3 MB ad36a0750439eeaf15d8c2fb16720d4874a1713539de08271a3d1db9df6c1634
    macOS 64-bit

    (ARM64, Apple silicon)

    google-cloud-cli-darwin-arm.tar.gz 61.2 MB dd88182311d3936c2b6fc7cf315db82d56e2a98c7f4b2d89a12c74b897eb6ff0
    macOS 32-bit

    (x86)

    google-cloud-cli-darwin-x86.tar.gz 59.6 MB 33a8cc483ecbbb87697ae6b6094763229697dc356d67cd06dec45b6cc58e417d

    Alternatively, you can download the archive from the command line. Replace FILE_NAME with the package name for your platform from the table above.

    curl -O https://dl.google.com/dl/cloudsdk/channels/rapid/downloads/FILE_NAME
  3. Extract the contents of the file to your preferred location on your file system. A common practice is to extract it to your home directory.

    On macOS, you can do this by opening the downloaded .tar.gz file in your preferred location. Alternatively, from the command line, run:

    tar -xf FILE_NAME

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

  4. Run the installation script from the root of the folder you extracted:
    ./google-cloud-sdk/install.sh
    The script prompts you to perform the following setup actions. To accept, answer Y when prompted.
    • Install Python 3.13 and recommended modules if needed.
    • Add the gcloud CLI to your PATH and enable command completion.
    • Opt in to send anonymous usage statistics to help improve the gcloud CLI.
    You can also perform the installation non-interactively by providing flags. To view available flags, run:
    ./google-cloud-sdk/install.sh --help
    To run the install script with screen reader mode enabled:
    ./google-cloud-sdk/install.sh --screen-reader=true
  5. Optional: If you updated your PATH in the previous step, open a new terminal so that the changes take effect.
  6. Run gcloud init to initialize, authorize, and configure the gcloud CLI.
  7. Optional: Install additional components using the component manager.
Windows

The Google Cloud CLI on Windows requires Windows 8.1 and later, or 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://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.

    • 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.10 to 3.14. 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.
  3. 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. Leave the options to start the shell and configure your installation selected. The installer starts a terminal window and runs the gcloud init command to initialize, authorize, and configure the gcloud CLI.
  4. 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.

Setting up credentials to access protected data

Installing gsutil lets you download and access publicly-accessible data, but in order to access protected data or write to a protected bucket, you need to set up credentials in order to authenticate. For example, if someone else has created a Google Cloud account and uploaded data to Cloud Storage that is only accessible to you or other specific individuals, you must set up your credentials to the Cloud Storage service to be able to access this data.

For more information and instructions on authenticating using different account credentials (such as OAuth2, HMAC, and service accounts), see the gsutil creds.py documentation on GitHub.

Note the following reminders:

  • When authenticating with HMAC keys, you should disable credential passing from the Google Cloud CLI by using the following command:

    gcloud config set pass_credentials_to_gsutil false

Enable mTLS

You might also want to enable mutual TLS (mTLS). When mTLS is enabled on your device, your device attempts to connect to the mTLS request endpoint for the JSON API. Before the connection is allowed, Cloud Storage verifies the certificate on your device.

The simplest way to to obtain a certificate is through Google Cloud CLI. You can set one manually in the .boto file by setting the following values under "Credentials":

  • use_client_certificate: A flag controlling whether or not to use mTLS.

  • cert_provider_command: A shell command that prints a certificate to stdout

    Try it for yourself

    If you're new to Google Cloud, create an account to evaluate how Cloud Storage performs in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

    Try Cloud Storage free

Troubleshooting

You can authenticate gsutil by running gsutil config -a or gsutil config -e but by default, a gsutil installation bundled with the Google Cloud CLI prioritizes active gcloud OAuth2 credentials over local .boto credentials. As a result, running gsutil config has no operational effect unless credentials sharing is explicitly disabled by using gcloud config set pass_credentials_to_gsutil false. We recommend uninstalling gsutil from the Google Cloud CLI and installing gsutil as a standalone tool instead.