Google Cloud の主要なコマンドライン ツールである Google Cloud CLI の go-to コマンドのリスト。
また、初級入門、コマンドの概要、印刷可能な PDF も含まれています。
クイック リファレンス
ご利用にあたって
gcloud CLI を使ってみましょう。
gcloud init: gcloud CLI を初期化、承認、構成します。gcloud version: バージョンとインストールされているコンポーネントを表示します。gcloud components install: 特定のコンポーネントをインストールします。gcloud components update: gcloud CLI を最新バージョンに更新します。gcloud config set project: 作業するデフォルトの Google Cloud プロジェクトを設定します。gcloud info: 現在の gcloud CLI 環境の詳細を表示します。
ヘルプ
gcloud CLI にはヘルプが用意されています。
gcloud help: gcloud CLI リファレンス ドキュメントで特定の用語を検索します。gcloud feedback: gcloud CLI チームにフィードバックを提供します。gcloud topic: ユーザー補助、フィルタリング、書式設定など、コマンド以外のトピックに関する補助的なヘルプ資料です。
カスタマイズ
自分用の gcloud CLI を作成します（プロパティを使用して構成をカスタマイズします）。
gcloud config set: 現在の構成のプロパティ（compute/zone など）を定義します。gcloud config get: gcloud CLI プロパティの値を取得します。gcloud config list: 現在の構成のすべてのプロパティを表示します。gcloud config configurations create: 新しい名前付き構成を作成します。gcloud config configurations list: 使用可能なすべての構成のリストを表示します。gcloud config configurations activate: 既存の名前付き構成に切り替えます。
認可と認証情報
gcloud CLI に対する認可の付与および取り消し、認証情報の管理を行う。
gcloud auth login: Google Cloud ユーザー認証情報を使用して gcloud CLI に対する Google Cloud のアクセスを認可し、現在のアカウントをアクティブとして設定します。gcloud auth activate-service-account:gcloud auth loginと類似していますが、サービス アカウントの認証情報を使用して Google Cloud アクセスを許可します。gcloud auth application-default: Cloud クライアント ライブラリのアプリケーションのデフォルト認証情報（ADC）を管理します。gcloud auth list: 認証情報が付与されているすべてのアカウントを一覧表示します。gcloud auth print-access-token: 現在のアカウントのアクセス トークンを表示します。gcloud auth revoke: アカウントのアクセス認証情報を削除します。
プロジェクト
プロジェクトのアクセス ポリシーを管理する
gcloud projects describe: プロジェクトのメタデータ（ID を含む）を表示します。gcloud projects add-iam-policy-binding: 指定したプロジェクトに IAM ポリシー バインディングを追加します。
IAM
Identity and Access Management（IAM）の設定とサービス アカウントを構成する
gcloud iam list-grantable-roles: リソースに関する IAM の付与可能なロールを一覧表示します。gcloud iam roles create: プロジェクトまたは組織用のカスタムロールを作成します。gcloud iam service-accounts create: プロジェクトのサービス アカウントを作成します。gcloud iam service-accounts add-iam-policy-binding: IAM ポリシー バインディングをサービス アカウントに追加します。gcloud iam service-accounts set-iam-policy-binding: 既存の IAM ポリシー バインディングを置き換えます。gcloud iam service-accounts keys list: サービス アカウントのキーを一覧表示します。
Docker と Google Kubernetes Engine（GKE）
コンテナ化されたアプリケーションを Kubernetes で管理する
gcloud auth configure-docker: gcloud CLI を Docker 認証ヘルパーとして登録します。gcloud container clusters create: GKE コンテナを実行するためのクラスタを作成します。gcloud container clusters list: GKE コンテナを実行するためのクラスタを一覧表示します。gcloud container clusters get-credentials:kubeconfigを更新して、kubectlで GKE クラスタを使用するようにします。gcloud container images list-tags: コンテナ イメージのタグとダイジェスト メタデータを一覧表示します。
仮想マシンと Compute Engine
Google Cloud インフラストラクチャで VM を作成、実行、管理する
gcloud compute zones list: Compute Engine のゾーンを一覧表示します。gcloud compute instances create: VM インスタンスを作成するgcloud compute instances describe: VM インスタンスの詳細を表示します。gcloud compute instances list: プロジェクト内のすべての VM インスタンスを一覧表示します。gcloud compute disks snapshot: 永続ディスクのスナップショットを作成します。gcloud compute snapshots describe: スナップショットの詳細を表示します。gcloud compute snapshots delete: スナップショットを削除します。gcloud compute ssh: SSH を使用して VM インスタンスに接続します。
サーバーレスと App Engine
フルマネージド型のサーバーレスなプラットフォーム上で高度なスケーラビリティを備えたアプリケーションを構築
gcloud app deploy: アプリのコードと構成を App Engine サーバーにデプロイします。gcloud app versions list: App Engine サーバーにデプロイされたすべてのサービスのすべてのバージョンを一覧表示します。gcloud app browse: 現在のアプリをウェブブラウザで開きます。gcloud app create: 現在のプロジェクト内で App Engine アプリを作成します。gcloud app logs read: 最新の App Engine アプリのログを表示します。
その他
便利なコマンド
gcloud kms decrypt: Cloud Key Management Service 鍵を使用して、暗号テキストを（平文ファイルに）復号します。gcloud logging logs list: プロジェクトのログを一覧表示します。gcloud sql backups describe: Cloud SQL インスタンスのバックアップに関する情報を表示します。gcloud sql export sql: Cloud SQL インスタンスから SQL ファイルにデータをエクスポートします。
初級入門
gcloud CLI の使用を開始するためのクイックガイド。
Google Cloud CLI のインストール
インストール手順に沿って Google Cloud CLI をインストールします。
フラグ、引数など
引数には位置引数またはフラグを指定できます
- 位置引数: コマンド名の後に設定します。位置引数の順序を考慮する必要があります。
フラグ: 位置引数の後に設定します。フラグの順序に決まりはありません。
フラグには次のいずれかを指定できます。
- 名前と値のペア（
--foo=bar） - ブール値（
--force/no-force）
また、フラグは次のどちらも設定できます。
- 必須
- 省略可: オプションのフラグが指定されない場合は、デフォルト値が使用されます。
- 名前と値のペア（
グローバル フラグ
gcloud CLI の操作では、次のようなフラグを使用できます。
--help: コマンドの機能が不明な場合、詳細なヘルプを表示します。--project: 現在のプロジェクト以外のプロジェクトを使用しているかどうか。--quiet: インタラクティブなプロンプト表示（および入力のデフォルト値の適用）を無効にします。--verbosity: 詳細レベルをdebug、info、warning、error、critical、noneに設定できます。--version:gcloudのバージョン情報を表示します。--format: 出力形式をconfig、csv、default、diff、disable、flattened、get、json、list、multi、none、object、table、text、value、yamlに設定します。
結果のクリーンアップ
フィルタ、形式、制限、並べ替えのフラグを指定して、出力を最大限利用します。
接頭辞は us であるが、マシンタイプは f1-micro ではない Compute Engine インスタンスの場合:
gcloud compute instances list --filter="zone ~ ^us AND -machineType:f1-micro"
2018 年 1 月 15 日以降に作成されたプロジェクトのリストの場合、古いものから新しいものの順に並べ替えられ、プロジェクト番号、プロジェクト ID、作成日時の列（日付と時刻はローカル タイムゾーン）が含まれるテーブルとして表示されます:
gcloud projects list --format="table(projectNumber,projectId,createTime.date(tz=LOCAL))"
--filter="createTime>=2018-01-15T12:00:00" --sort-by=createTime
ラベル my-label（任意の値）が含まれる 10 個の Compute Engine インスタンスのリストの場合:
gcloud compute instances list --filter="labels.my-label:*" --limit=10
コマンドの概要
gcloud CLI コマンドの基本パターン。自力でコマンドを見つけることに役立ちます。
gcloud CLI コマンドの検索
gcloud CLI はツリー構造になっています。リーフ以外のノードはコマンド グループで、リーフノードはコマンドです。（また、タブ補完はコマンドやリソースでも機能します）。
ほとんどの gcloud コマンドは、次の形式に従います。
gcloud + release level (optional) + component + entity + operation + positional args + flags
次に例を示します。gcloud + compute + instances + create + example-instance-1 + --zone=us-central1-a
リリースレベル
リリースレベルは、コマンドのリリース状況を指します。
例: アルファ版コマンドの場合は alpha、ベータ版コマンドの場合は beta で、GA コマンドにはリリースレベルは必要ありません。
コンポーネント
コンポーネントは、さまざまな Google Cloud サービスを指します。
例: Compute Engine の場合は compute、App Engine の場合は app などのようになります。
エンティティ
エンティティは、要素の複数形、またはコンポーネントの下位にある要素のコレクションを指します。
例: disks、firewalls、images、instances、regions、zones（コンピューティング用）
オペレーション
オペレーションは、エンティティに対して実行されるオペレーションの命令の動詞形を指します。
例: describe、list、create/update、delete/clear、import、export、copy、remove、add、reset、restart、restore、run、deploy が一般的なオペレーションです。
位置引数
位置引数は、コマンドの実行に必要な、命令に固有の必須の引数を指します。
例: <INSTANCE_NAMES> は、gcloud compute instances create に必要な位置引数です。
フラグ
フラグは、追加の引数を指します（--flag-name(=value)）。これは位置引数の後にコマンドに渡されます。
例: --machine-type=<MACHINE_TYPE> と --preemptible は、gcloud compute instances create のオプションのフラグです。