Install gsutil

This page describes the installation and setup of gsutil, a tool that enables you to access Cloud Storage from the command-line using HTTPS.

Simply installing gsutil gives you immediate read and/or write access to public data. Authenticating to the Cloud Storage service gives you read and/or write access to protected data that has been shared with you. Enabling billing gives you the ability to create and manage your own buckets.

System requirements

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

  • gsutil versions 5.0 and up require Python 3.

  • If you plan to use composite objects, you need to install compiled crcmod. On Windows, this is only available for 32-bit Python.

Installing gsutil

The officially supported installation and update method for gsutil is as part of the Google Cloud SDK.

Installing gsutil as part of the Google Cloud SDK

Follow the instructions for your operating system to install gsutil as a part of the Google Cloud SDK:

Linux
  1. 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
    Your operating system must be able to run one of these supported Python versions in order for Cloud SDK to run. For more information on how to choose and configure your Python interpreter, refer to gcloud topic startup.
  2. Download one of the following:
  3. Platform Package Size SHA256 Checksum
    Linux 64-bit

    (x86_64)

    google-cloud-sdk-359.0.0-linux-x86_64.tar.gz 92.2 MB b84828fbd7c2c842edf3df4d514f01f7b6a9e587fa5b563b0f1dde4587574b1b
    Linux 64-bit

    (arm)

    google-cloud-sdk-359.0.0-linux-arm.tar.gz 89.6 MB fb09d8054c7e1cefb2dc0f5b4d42b189857871e22c31cc5eb769e7cc36f44a2c
    Linux 32-bit

    (x86)

    google-cloud-sdk-359.0.0-linux-x86.tar.gz 89.6 MB ba6511beec5891be7e2ab8385efd30e4308debd708dd07b1d8a4591495e950ce
  4. 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-359.0.0-linux-x86_64.tar.gz

    For the 64-bit arm archive file, run:

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

    For the 32-bit archive file, run:

    curl -O https://dl.google.com/dl/cloudsdk/channels/rapid/downloads/google-cloud-sdk-359.0.0-linux-x86.tar.gz
  5. 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.
  6. 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.
  7. Run gcloud init to initialize the SDK:
  8. ./google-cloud-sdk/bin/gcloud init
    
  9. 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:

Installation
  1. 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
  2. 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 -
  3. 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
          

  4. 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
  5. 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
  1. 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-el8-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
    
  2. Install the Cloud SDK:
    sudo dnf install google-cloud-sdk
  3. 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
  4. 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
  1. Cloud SDK requires Python:
    • Supported versions are Python 3 (3.7 recommended) and Python 2 (2.7.9 or higher).
    • Modern versions of macOS include the appropriate version of Python required for the Cloud SDK. To check your current Python version, run python -V.
    • For Cloud SDK release version 352.0.0 and above, the main install script offers to install CPython's Python 3.7 on Intel-based Macs.
    • For more information on how to choose and configure your Python interpreter, refer to gcloud topic startup.
  2. Download one of the following:
  3. Platform Package Size SHA256 Checksum
    macOS 64-bit

    (x86_64)

    google-cloud-sdk-359.0.0-darwin-x86_64.tar.gz 92.7 MB f79438933a40b893b8997f1e1351d8dd1f99faaf2925a4aa6ae2f118452e8825
    macOS 64-bit

    (arm64, Apple M1 silicon)

    google-cloud-sdk-359.0.0-darwin-arm.tar.gz 92.6 MB 0c5d415382a5b9bb5bf31bdf471394e4bbe5fc9a0793c759eea1e3a6becb33b5
    macOS 32-bit

    (x86)

    google-cloud-sdk-359.0.0-darwin-x86.tar.gz 96.5 MB 4d086077c18ba8a1fe4a3d79357c284c07c6567fbb5973d00ae66b205beb22c5

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

    2. 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, and optionally install Python 3.7.

      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.
    3. Run gcloud init to initialize the SDK:
    4. ./google-cloud-sdk/bin/gcloud init
      
    5. Optional. Install additional components using the component manager.
Windows
  1. 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
        
  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. Cloud SDK requires Python; supported versions are Python 3 (preferred, 3.5 to 3.8) and Python 2 (2.7.9 or higher). Cloud SDK comes bundled with Python 3 by default. To use Cloud SDK, 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 Cloud SDK 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 Cloud SDK shell, and configure the Cloud SDK. 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 Cloud SDK 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 have just uninstalled Cloud SDK, you must reboot your system before installing Cloud SDK again.

Perform updates with the components update command: gcloud components update.

To learn how to use gsutil, see Quickstart: Using the gsutil Tool exercise, or run gsutil help.

Alternative installation methods

There are several ways to install gsutil as a stand-alone product. You may prefer one of these methods if you do not want any of the other components that come with the Cloud SDK, or if you are managing packages with PyPI.

If you are installing gsutil 5.0 or higher, you must have Python 3 installed on your computer, with Python 3.5 to 3.8 preferred. Python 3 is installed by default on most distributions of Linux and macOS, however:

  • Python 3 is not installed by default on Windows, but can be installed manually.
  • Python 3 might not be installed by default on CentOS or RHEL. If it is not currently installed, it can be installed manually.

Expand the desired method for instructions to install gsutil.

Setting Up Credentials to Access Protected Data

Installing gsutil allows you to 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 (authenticate). For example, if someone else has created a Cloud Storage account and uploaded data 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.

If you installed gsutil as part of the Google Cloud SDK, follow these instructions. Otherwise, see the Authenticate stand-alone gsutil section.

Authenticate Google Cloud SDK

When using gsutil as part of the Google Cloud SDK, OAuth2 is used to authenticate and authorize access. Note that you may have already performed the following steps if you performed Installing gsutil as part of the Google Cloud SDK above. If you ran gcloud init previously, you are asked if you want to re-initialize the configuration or create a new one.

  1. Open a command prompt instance.

  2. Run gcloud init at the command prompt.

    You receive the following output:

    Welcome! This command will take you through the configuration of gcloud.
     
    Your current configuration has been set to: [default]
     
    To continue, you must login. Would you like to login (Y/n)?
    

  3. Type "Y" and press enter to login.

    • The command prints a URL and tries to open a browser window to request access to your project. If a browser window can be opened, you receive the following output:

      Your browser has been opened to visit:
       
      https://accounts.google.com/o/oauth2/auth?redirect_uri=http%3A%2F%2F...
      

      Go to the next step.

    • If you are working on a local machine and your browser doesn't automatically load the URL, retry the gcloud init command with the --console-only flag:

      gcloud init --console-only
      

      If you use this command, or if the Cloud SDK detects that a browser can not be opened (such as if you are working on a remote machine), you receive the following output:

      Go to the following link in your browser:
       
      https://accounts.google.com/o/oauth2/auth?redirect_uri=urn%3Aietf%3Awg%3A...
       
      Enter verification code:
      

      Open a browser and navigate to the URL provided.

  4. If prompted, sign in with the Google account associated with your Cloud Storage data in the browser window.

  5. Grant access.

    • If the browser window opened automatically, review the application permissions and click Accept when you are ready. The verification code is then automatically sent to the command line tool.

    • If you are working on a remote machine or used the --console-only flag, copy the verification code from the URL and paste it to the terminal command line, after Enter verification code:.

  6. Choose the default project for this configuration.

    After setting up your credentials, the gcloud command-line tool prompts you for a default project for this configuration and provides a list of available projects. Select a project ID from the list.

    When you set this property, gsutil commands that require a project, such as gsutil mb, use the default project ID unless you override them with the -p flag or set the CLOUDSDK_CORE_PROJECT environment variable.

That's it. You're ready to access protected data. To see a listing of gsutil commands, type gsutil at the command prompt.

Authenticate stand-alone gsutil

Authenticate with HMAC

While OAuth 2.0 is the recommended way to authenticate gsutil, you can also use HMAC keys for your credentials. To authenticate with HMAC, use the -a flag in the gsutil config command:

gsutil config -a

Using this command takes you through a similar process as authenticating the stand-alone gsutil (see previous section), except you are prompted for the access ID and secret associated with your HMAC key.

If you are using the Google Cloud SDK, you also should disable credential passing using the command:

gcloud config set pass_credentials_to_gsutil false

Enable mTLS

You may also want to enable mutual TLS (mTLS). When mTLS is enabled on your device, your device attempts to connect to storage.mtls.googleapis.com. 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 SDK. You can set one manually in the .boto file by setting the following values under "Credentials":

  1. use_client_certificate: A flag controlling whether or not to use mTLS.
  2. cert_provider_command: A shell command that prints a certificate to stdout for gsutil to read.

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