gcutil Tool

This document describes installation and usage of the gcutil tool. gcutil is a command-line tool that is used to manage your Google Compute Engine resources.

If you haven't already activated Google Compute Engine, follow the Getting Started Guide.


System requirements

gcutil runs on UNIX-based operating systems such as Linux and Mac OS X. To use gcutil, you must have Python 2.6.x or 2.7.x installed on your computer. gcutil does not support Python 3.x. Python is installed by default on most Linux distributions and Mac OS X.

Install gcutil

To install gcutil:

  1. Download gcutil-1.16.1.tar.gz file.

    wget https://dl.google.com/dl/cloudsdk/release/artifacts/gcutil-1.16.1.tar.gz
  2. Extract the files.

    Run the following command to extract the tar file. This unpacks a directory named gcutil-1.16.1 in /usr/local/share.

    sudo tar xzvpf gcutil-1.16.1.tar.gz -C /usr/local/share
  3. Create a symbolic link to the gcutil binary.

    sudo ln -sf /usr/local/share/gcutil-1.16.1/gcutil /usr/local/bin/gcutil
  4. Start using gcutil.

    If you modified your system path, restart your shell before continuing so the changes can take effect. To see a list of available gcutil commands, run:

    gcutil help

For additional information on authenticating with the Cloud SDK, such as if you are working in a terminal session on another machine, see the following section.

Authenticate gcutil

To authenticate gcutil, follow the instructions for gcloud compute.

Then, test out the tool by running:

gcutil listinstances

Send feedback about...

Compute Engine Documentation