Command Line Usage

This page provides usage for workstation CLI.

workstation

Create and manage Google Cloud Workstation.

Usage:

workstation [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--version	boolean	Show the version and exit.	False
--help	boolean	Show this message and exit.	False

create

Create a workstation.

Usage:

workstation create [OPTIONS]

Options:

Name	Type	Description	Default
--config, -c	text	Name of workstation config	None
--project, -p	text	GCP Project name, if not provided will use the default project in gcloud config.	None
--location, -l	text	Workstation location, if not provided will use the default location in gcloud config.	us-central1
--cluster	text	Cluster used for workstations.	cluster-public
--name	text	Name of the workstation to create.	None
--proxy	text	proxy setting.	None
--no-proxy	text	No proxy setting.	None
--env, -e		Environment variables to set at runtime.	None
--help	boolean	Show this message and exit.	False

delete

Delete workstation.

Usage:

workstation delete [OPTIONS]

Options:

Name	Type	Description	Default
-n, --name	text	Name of the workstation to delete.	None
--help	boolean	Show this message and exit.	False

list

List workstations.

Usage:

workstation list [OPTIONS]

Options:

Name	Type	Description	Default
--config, -c	text	Name of workstation config	None
--project, -p	text	GCP Project name, if not provided will use the default project in gcloud config.	None
--location, -l	text	Workstation location, if not provided will use the default location in gcloud config.	us-central1
--cluster	text	Cluster used for workstations.	cluster-public
--json	boolean	print json output	False
-u, --user	text	Lists workstations only from a given user.	runner
-a, --all	boolean	List workstations from all users.	False
--help	boolean	Show this message and exit.	False

list-configs

List workstation configurations.

Usage:

workstation list-configs [OPTIONS]

Options:

Name	Type	Description	Default
--config, -c	text	Name of workstation config	None
--project, -p	text	GCP Project name, if not provided will use the default project in gcloud config.	None
--location, -l	text	Workstation location, if not provided will use the default location in gcloud config.	us-central1
--cluster	text	Cluster used for workstations.	cluster-public
--help	boolean	Show this message and exit.	False

logs

Open logs for the workstation.

Usage:

workstation logs [OPTIONS] NAME

Options:

Name	Type	Description	Default
--project	text	Name of the workstation GCP project.	None
--help	boolean	Show this message and exit.	False

start

Start workstation and optionally open it either locally with VSCode or through VSCode in a browser.

Usage:

workstation start [OPTIONS]

Options:

Name	Type	Description	Default
-n, --name	text	Name of the workstation to start.	_required
--code	boolean	Open workstation in VSCode locally. This requires setup illustrated in https://workstation.mlds.cash/#connect-to-a-workstation-with-local-vs-code	False
--browser	boolean	Open workstation with a remote VSCode session in a web browser.	False
--help	boolean	Show this message and exit.	False

stop

Stop workstation.

Usage:

workstation stop [OPTIONS]

Options:

Name	Type	Description	Default
-n, --name	text	Name of the workstation to stop.	None
--help	boolean	Show this message and exit.	False

sync

Sync files to workstation.

Usage:

workstation sync [OPTIONS]

Options:

Name	Type	Description	Default
-n, --name	text	Name of the workstation to sync.	None
--help	boolean	Show this message and exit.	False