CheatPress

gcloud CLI Google Cloud CLI

Version 588.0.0 · source

gcloud CLI, Postcard, light preview Light · Postcard 102 × 152 mm · PDF gcloud CLI, Postcard, dark preview Dark · Postcard 102 × 152 mm · PDF gcloud CLI, Postcard, ink saver preview Ink saver · Postcard 102 × 152 mm · PDF
gcloud CLI, A5, light preview Light · A5 148 × 210 mm · PDF gcloud CLI, A5, dark preview Dark · A5 148 × 210 mm · PDF gcloud CLI, A5, ink saver preview Ink saver · A5 148 × 210 mm · PDF
gcloud CLI, A4, light preview Light · A4 210 × 297 mm · PDF gcloud CLI, A4, dark preview Dark · A4 210 × 297 mm · PDF gcloud CLI, A4, ink saver preview Ink saver · A4 210 × 297 mm · PDF
gcloud CLI, A4 landscape, light preview Light · A4 landscape 297 × 210 mm · PDF gcloud CLI, A4 landscape, dark preview Dark · A4 landscape 297 × 210 mm · PDF gcloud CLI, A4 landscape, ink saver preview Ink saver · A4 landscape 297 × 210 mm · PDF
gcloud CLI, A3, light preview Light · A3 297 × 420 mm · PDF gcloud CLI, A3, dark preview Dark · A3 297 × 420 mm · PDF gcloud CLI, A3, ink saver preview Ink saver · A3 297 × 420 mm · PDF
gcloud CLI, A3 landscape, light preview Light · A3 landscape 420 × 297 mm · PDF gcloud CLI, A3 landscape, dark preview Dark · A3 landscape 420 × 297 mm · PDF gcloud CLI, A3 landscape, ink saver preview Ink saver · A3 landscape 420 × 297 mm · PDF
gcloud CLI, Letter, light preview Light · Letter 8.5 × 11 in · PDF gcloud CLI, Letter, dark preview Dark · Letter 8.5 × 11 in · PDF gcloud CLI, Letter, ink saver preview Ink saver · Letter 8.5 × 11 in · PDF
gcloud CLI, Tabloid, light preview Light · Tabloid 11 × 17 in · PDF gcloud CLI, Tabloid, dark preview Dark · Tabloid 11 × 17 in · PDF gcloud CLI, Tabloid, ink saver preview Ink saver · Tabloid 11 × 17 in · PDF

Start here

gcloud auth login
Sign in with your browser
gcloud projects list
See your projects
gcloud config set project <id>
Pick the active project
gcloud config list
Show active settings
gcloud compute instances list
List VMs
gcloud compute ssh <vm>
Log into a VM
gcloud storage ls
List buckets
gcloud <group> --help
Explore any command

Concepts

  1. Account who you are
  2. Configuration project, region, zone
  3. Command gcloud compute ...
  4. Resource VM, bucket, role

Auth and accounts

gcloud auth login
Sign in via browser
gcloud auth list
Show credentialed accounts
gcloud config set account <email>
Switch the active account
gcloud auth application-default login
Credentials for local code and SDKs
Separate from gcloud's own login; stored as a local ADC file.
gcloud auth activate-service-account --key-file <file>
Sign in as a service account
gcloud init
Guided first-time setup

Config and projects

gcloud config list
Show active properties
gcloud config set project <id>
Set default project
gcloud config set compute/region <region>
Set default region
gcloud config set compute/zone <zone>
Set default zone
gcloud config configurations list
List named configurations
gcloud config configurations create <name>
Create a configuration
gcloud config configurations activate <name>
Switch configuration
gcloud projects list
List projects you can see
gcloud services list --enabled
List enabled APIs
gcloud services enable <api>.googleapis.com
Enable an API

Compute instances

gcloud compute instances list
List VMs
gcloud compute instances describe <vm>
Show one VM
gcloud compute instances create <vm>
Create a VM
gcloud compute instances create <vm> --machine-type=<type> --image-family=<family> --image-project=<project>
Create with explicit size and image
gcloud compute instances start <vm>
Start a VM
gcloud compute instances stop <vm>
Stop a VM
gcloud compute instances delete <vm>
Delete a VM

SSH and copy

gcloud compute ssh <vm>
SSH into a VM
Creates and uploads an SSH key on first use.
gcloud compute ssh <vm> --zone=<zone>
SSH naming the zone
gcloud compute ssh <vm> --command="<cmd>"
Run one command remotely
gcloud compute ssh <vm> --tunnel-through-iap
SSH without a public IP
gcloud compute ssh <vm> -- -L <port>:localhost:<port>
Forward a local port
gcloud compute scp <file> <vm>:<path>
Copy a file to a VM

Storage

gcloud storage ls
List buckets
gcloud storage ls gs://<bucket>/<prefix>
List objects
gcloud storage cp <src> <dst>
Copy files to, from or between buckets
gcloud storage cp -r <dir> gs://<bucket>
Upload a directory
gcloud storage mv <src> <dst>
Move or rename objects
gcloud storage rm gs://<bucket>/<object>
Delete an object
gcloud storage rm -r gs://<bucket>/<prefix>
Delete recursively
gcloud storage rsync -r <src> <dst>
Sync a directory with a bucket
gcloud storage buckets create gs://<bucket> --location=<loc>
Create a bucket

IAM

gcloud iam service-accounts list
List service accounts
gcloud iam service-accounts create <name>
Create a service account
gcloud projects get-iam-policy <project>
Show who has which role
gcloud projects add-iam-policy-binding <project> --member=<member> --role=<role>
Grant a role
Members look like user:a@b.com or serviceAccount:<email>.

Format and filter

--format=json
Output as JSON
--format="value(<field>)"
Print bare values for scripts
--format="table(<f1>, <f2>)"
Choose table columns
--filter="<field>=<value>"
Keep matching rows
--filter="name~^<prefix>"
Match with a regex
--filter="labels.<key>=<val>"
Filter by label
--quiet
Skip prompts, take defaults
Also answers yes to delete confirmations, so use with care.
--project=<id>
Override the project for one call

Help and discovery

gcloud help <command>
Open full help for a command
gcloud <group> --help
List subcommands in a group
gcloud version
Print CLI version
gcloud --verbosity=debug <command>
Show HTTP detail while debugging

Recipes

Separate work and personal setups
gcloud config configurations create workgcloud config set project <work-project>gcloud config set account <you@work.com>gcloud config configurations activate default
Script-friendly VM IPs
gcloud compute instances list \  --filter="status=RUNNING" \  --format="value(name,networkInterfaces[0].accessConfigs[0].natIP)"
Create a VM and log in
gcloud services enable compute.googleapis.comgcloud compute instances create demo --zone=<zone>gcloud compute ssh demo --zone=<zone>gcloud compute instances delete demo --zone=<zone>
Grant a service account bucket access
gcloud iam service-accounts create uploadergcloud storage buckets add-iam-policy-binding gs://<bucket> \  --member=serviceAccount:<email> --role=roles/storage.objectAdmin