This page shows how to install the Google Cloud SDK, initialize it, and run
gcloud commands from the command-line.
Before you begin
- Create a Google Cloud Platform project, if you don't have one already.
Download the Google Cloud SDK installer.
Launch the installer and follow the prompts.
After installation has completed, the installer presents several options:
Make sure that the following are selected:
- Start Google Cloud SDK Shell
- Run 'gcloud init'
The installer then starts a terminal window and runs the
- If the Cloud SDK fails to run after installing version 274.0.0, please refer to this tracking bug for the latest workarounds.
- If your installation is unsuccessful
due to the
findcommand not being recognized, ensure your
PATHenvironment variable is set to include the folder containing
find. Usually, this is
- If you have just uninstalled Cloud SDK, you will need to reboot your system before installing Cloud SDK again.
Initialize the SDK
gcloud init command to perform several common SDK setup tasks. These
include authorizing the SDK tools to access Google Cloud Platform using your
user account credentials and setting up the default SDK configuration.
To initialize the SDK:
Run the following at a command prompt:
Note: If you get an error related to the gcloud command not being found, refer to step 5 in the section above.
Note: To prevent the command from launching a web browser, use
gcloud init --console-onlyinstead. To authorize without a web browser and non-interactively, create a service account with the appropriate scopes using the Google Cloud Platform Console and use
gcloud auth activate-service-accountwith the corresponding JSON key file.
Accept the option to log in using your Google user account:
To continue, you must log in. Would you like to log in (Y/n)? Y
In your browser, log in to your Google user account when prompted and click Allow to grant permission to access Google Cloud Platform resources.
At the command prompt, select a Cloud Platform project from the list of those where you have Owner, Editor or Viewer permissions:
Pick cloud project to use:  [my-project-1]  [my-project-2] ... Please enter your numeric choice:
If you only have one project,
gcloud initselects it for you.
If you have the Google Compute Engine API enabled,
gcloud initallows you to choose a default Compute Engine zone:
Which compute zone would you like to use as project default?  [asia-east1-a]  [asia-east1-b] ...  Do not use default zone Please enter your numeric choice:
gcloud initconfirms that you have complete the setup steps successfully:
gcloud has now been configured! You can use [gcloud config] to change more gcloud settings. Your active configuration is: [default]
(Optional) If you'd like a more streamlined screen reader experience, the gcloud command-line tool comes with an
To enable this property, run:
gcloud config set accessibility/screen_reader true
For more details about the accessibility features that come with the gcloud command-line tool, refer to the Enabling accessibility features guide.
Run core gcloud commands
gcloud commands to view information about your SDK installation:
To list accounts whose credentials are stored on the local system:
gcloud auth list
gclouddisplays a list of credentialed accounts:
Credentialed Accounts ACTIVE ACCOUNT * firstname.lastname@example.org email@example.com
To list the properties in your active SDK configuration:
gcloud config list
gclouddisplays the list of properties:
[core] account = firstname.lastname@example.org disable_usage_reporting = False project = example-project
To view information about your Cloud SDK installation and the active SDK configuration:
gclouddisplays a summary of information about your Cloud SDK installation. This includes information about your system, the installed SDK components, the active user account and current project, and the properties in the active SDK configuration.
To view information about
gcloudcommands and other topics from the command line:
For example, to view the help for
gcloud compute instances create:
gcloud help compute instances create
gclouddisplays a help topic that contains a description of the command, a list of command flags and arguments, and examples of how to use it.
- Read the
gcloudtool guide for an overview of the
gcloudcommand-line tool, including a quick introduction to key concepts, command conventions, and helpful tips.
- Read the
gcloudreference guide for detailed pages on each
gcloudcommand, including descriptions, flags, and examples, that you can use to perform a variety of tasks on Google Cloud Platform.
- Install additional components such as the App Engine emulators or
kubectlusing the Cloud SDK component manager.