Hide
Cloud Storage

gsutil Tool

gsutil is a Python application that lets you access Google Cloud Storage from the command line. You can use gsutil to do a wide range of bucket and object management tasks, including:

  • Creating and deleting buckets.
  • Uploading, downloading, and deleting objects.
  • Listing buckets and objects.
  • Moving, copying, and renaming objects.
  • Editing object and bucket ACLs.

Contents

  1. Getting Started
  2. Built-In Help
  3. About gsutil

Getting Started

Accessing Publicly Accessible Data

To get started using gsutil, you can simply download and install the application, and use it to access publicly-accessible data. You do not need to sign up for a Google Cloud Storage or a Google account to use gsutil for this purpose.

For example, you can download and install the gsutil client and run the following command to download data from a publicly-accessible bucket called uspto:

gsutil ls gs://uspto-pair/applications/0800401*

You should see a listing of objects whose name starts with gs://uspto-pair/applications/0800401.

Reading and Writing Data as an Authenticated User

If you would like to use gsutil to access objects and buckets that are protected, you need to authenticate to Google Cloud Storage. You can do so in one of two ways, depending on your use case:

Back to top

Built-In Help

gsutil contains thorough built-in help about every command as well as a number of topics, which you can get by running:

gsutil help

This command outputs a list of all commands and available help topics, and you can then get detailed help for each command or topic. For example, you can get help about the gsutil cp command by running:

gsutil help cp

To get information about gsutil top-level command-line options, use:

gsutil help options

To get information about your gsutil setup, use:

gsutil version -l

The gsutil help pages are also available online. For example, the online pages for the commands shown above are gsutil help, gsutil cp, gsutil options, and gsutil version.

Back to top

About gsutil

gsutil is an open-source project. To download the developer version of gsutil or volunteer to help develop gsutil, visit the gsutil project on GitHub.

Back to top