- NAME
-
- gcloud colab runtimes create - create a notebook runtime
- SYNOPSIS
-
-
gcloud colab runtimes create--display-name=DISPLAY_NAME--runtime-template=RUNTIME_TEMPLATE[--async] [--description=DESCRIPTION] [--labels=[KEY=VALUE, …]] [--region=REGION] [--runtime-id=RUNTIME_ID] [--runtime-user=RUNTIME_USER] [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
- Create a notebook runtime that can be used to run code from your notebook (IPYNB file).
- EXAMPLES
- To create a runtime in region 'us-central1' with the display name 'my-runtime'
and template with id 'my-template', run:
gcloud colab runtimes create --region = us-central1 --display-name = my-runtime --runtime-template = my-templateTo create a runtime for user 'USER@DOMAIN.COM', run:
gcloud colab runtimes create --runtime-user = USER@DOMAIN.COM --region = us-central1 --display-name = my-runtime --runtime-template = my-template - REQUIRED FLAGS
-
-
--display-name=DISPLAY_NAME - The display name of the runtime to create.
- Runtime template resource - Unique name of the runtime template to configure the
runtime with. This was optionally provided by setting --runtime-template-id in
the create runtime-template command, or was system-generated if unspecified.
This represents a Cloud resource. (NOTE) Some attributes are not given arguments
in this group but can be set in other ways.
To set the
projectattribute:- provide the argument
--runtime-templateon the command line with a fully specified name; - provide the argument
--projecton the command line; - set the property
core/project.
To set the
regionattribute:- provide the argument
--runtime-templateon the command line with a fully specified name; - provide the argument
--regionon the command line; - set the property
colab/region.
This must be specified.
-
--runtime-template=RUNTIME_TEMPLATE - ID of the runtime template or fully qualified identifier for the runtime
template.
To set the
nameattribute:- provide the argument
--runtime-templateon the command line.
- provide the argument
- provide the argument
-
- OPTIONAL FLAGS
-
-
--async - Return immediately, without waiting for the operation in progress to complete.
-
--description=DESCRIPTION - The description
-
--labels=[KEY=VALUE,…] - Add labels to identify and group the runtime template.
- Region resource - Cloud region to create runtime. Please see https://cloud.google.com/colab/docs/locations
for a list of supported regions. This represents a Cloud resource. (NOTE) Some
attributes are not given arguments in this group but can be set in other ways.
To set the
projectattribute:- provide the argument
--regionon the command line with a fully specified name; - set the property
colab/regionwith a fully specified name; - provide the argument
--projecton the command line; - set the property
core/project.
- provide the argument
-
--region=REGION - ID of the region or fully qualified identifier for the region.
To set the
regionattribute:- provide the argument
--regionon the command line; - set the property
colab/region.
- provide the argument
-
--runtime-id=RUNTIME_ID - The id of the runtime to create. If not specified, a random id will be generated.
-
--runtime-user=RUNTIME_USER - User email for the runtime owner. Runtimes can only be used by the owner. If a user is not provided, the gcloud user will be assumed to be the owner. The user cannot be a service account.
-
- GCLOUD WIDE FLAGS
- These flags are available to all commands:
--access-token-file,--account,--billing-project,--configuration,--flags-file,--flatten,--format,--help,--impersonate-service-account,--log-http,--project,--quiet,--trace-token,--user-output-enabled,--verbosity.Run
$ gcloud helpfor details. - NOTES
- This variant is also available:
gcloud beta colab runtimes create
gcloud colab runtimes create
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-05-27 UTC.

