Version: main 🚧

Platform CLI hub

This page is a Platform-focused entry point to the vcluster platform CLI. It groups commands by task and links each one to its full flag reference.

The canonical, flag-level reference for every command lives in the vCluster CLI docs. This page shows the Platform UI equivalent next to each CLI command.

Common tasks and CLI equivalents

Start or install the platform

Task	Platform UI	CLI command
Install Platform	Not available in the UI. Platform installs with Helm or the CLI.	`vcluster platform start`

See the quickstart guide or the Helm installation guide for full install flows.

Log in and access keys

Task	Platform UI	CLI command
Log in to Platform	Sign in at the Platform URL	`vcluster platform login`
Log out of Platform	Avatar menu (bottom of the sidebar) > `Logout`	`vcluster platform logout`
Create an access key	`Users` > select a user > `Create Access Key` > name it in the drawer > `Create`	`vcluster platform create accesskey`

Connect a cluster

Task	Platform UI	CLI command
Register a cluster with Platform	`Clusters` > `Connect Cluster via CLI` > follow the drawer's generated command	`vcluster platform add cluster`
Create a local kubeconfig context for a connected cluster	`Clusters` > kebab menu > `Access`, then copy the generated command	`vcluster platform connect cluster`

Create, list, and delete tenant clusters

Task	Platform UI	CLI command
Create a tenant cluster	project dropdown > `Tenant Clusters` > `Create Tenant Cluster`	`vcluster platform create vcluster`
Add an existing tenant cluster	`Tenant Clusters` > `Add Existing Cluster` > `Add existing tenant cluster`	`vcluster platform add vcluster`
List tenant clusters	project dropdown > `Tenant Clusters`	`vcluster platform list vclusters`
Delete a tenant cluster	`Tenant Clusters` > kebab menu (`More actions`) > `Delete`	`vcluster platform delete vcluster`

Create, list, and delete namespaces

Task	Platform UI	CLI command
Create a namespace	`Projects` > `Namespaces` > `Create Namespace` > optional template > `Create Namespace`	`vcluster platform create namespace`
List namespaces	`Projects` > `Namespaces`	`vcluster platform list namespaces`
Delete a namespace	`Namespaces` view, hover the row, click the delete icon in the Actions column	`vcluster platform delete namespace`

See retrieve a namespace kubeconfig for related namespace commands.

Task	Platform UI	CLI command
Put a namespace to sleep	`Namespaces` view, hover the row, click `Sleep`	`vcluster platform sleep namespace`
Wake up a namespace	`Namespaces` view, hover the Status column, click `Wakeup`	`vcluster platform wakeup namespace`
Put a tenant cluster to sleep	`Tenant Clusters` > select a cluster > ellipsis menu > `Sleep`	`vcluster platform sleep vcluster`
Wake up a tenant cluster	`Tenant Clusters` > kebab menu (`More actions`) > `Wake Up`, shown only while sleeping	`vcluster platform wakeup vcluster`
Share a tenant cluster	`Tenant Clusters` > `Edit` > `Permissions` > `Add Permission` > `Save Changes`	`vcluster platform share vcluster`
Share a namespace	`Namespaces` > `Edit` > `Permissions` > `Save Changes`	`vcluster platform share namespace`

Backup, destroy, and reset password

Task	Platform UI	CLI command
Back up Platform	Not available in the UI, CLI/Helm only	`vcluster platform backup management`
Destroy a Platform instance	Not available in the UI, CLI/Helm only	`vcluster platform destroy`
Reset a user's password	`Users` > select a user > `Reset Password` > confirm > `Copy & Close`	`vcluster platform reset password`

Resetting the admin password without UI access is CLI/kubectl only, see reset the admin password.

All platform CLI commands

Start

Command	Description
`vcluster platform start`	Start a vCluster platform instance and connect via port-forwarding

Command	Description
`vcluster platform login`	Login to a vCluster platform instance

Logout

Command	Description
`vcluster platform logout`	Log out of a vCluster platform instance

Access keys

Command	Description
`vcluster platform access-key`	Prints the access token to a vCluster platform instance

Connect

Command	Description
`vcluster platform connect`	connects to vCluster platform resources
`vcluster platform connect cluster`	Creates a kube context for the given cluster
`vcluster platform connect management`	Creates a kube context to the vCluster platform Management API
`vcluster platform connect namespace`	Creates a kube context for the given vCluster platform namespace
`vcluster platform connect vcluster`	Connect to a virtual cluster

Add

Command	Description
`vcluster platform add`	Adds a cluster to vCluster platform
`vcluster platform add cluster`	add current cluster to vCluster platform
`vcluster platform add standalone`	Adds an existing vCluster Standalone cluster to the vCluster platform
`vcluster platform add vcluster`	Adds an existing vCluster to the vCluster platform

Create

Command	Description
`vcluster platform create`	Creates vCluster platform resources
`vcluster platform create accesskey`	Creates a new access key for the current user
`vcluster platform create namespace`	Creates a new vCluster platform namespace in the given cluster
`vcluster platform create vcluster`	Creates a new virtual cluster

Delete

Command	Description
`vcluster platform delete`	Deletes vCluster platform resources
`vcluster platform delete namespace`	Deletes a vCluster platform namespace from a cluster
`vcluster platform delete vcluster`	Deletes a virtual cluster

List

Command	Description
`vcluster platform list`	Lists configuration
`vcluster platform list clusters`	Lists the loft clusters you have access to
`vcluster platform list namespaces`	Lists the vCluster platform namespaces you have access to
`vcluster platform list projects`	Lists the loft projects you have access to
`vcluster platform list secrets`	Lists all the shared secrets you have access to
`vcluster platform list teams`	Lists the vCluster platform teams you are member of
`vcluster platform list vclusters`	Lists all virtual clusters that are connected to the current platform

Get

Command	Description
`vcluster platform get`	Retrieves and display informations
`vcluster platform get cluster`	Prints the current cluster
`vcluster platform get cluster-access-key`	Retrieve the network peer cluster access key
`vcluster platform get current-user`	Retrieves the current logged in user
`vcluster platform get secret`	Returns the key value of a project / shared secret

Set

Command	Description
`vcluster platform set`	Set configuration
`vcluster platform set secret`	Sets the key value of a project / shared secret

Command	Description
`vcluster platform share`	Shares a virtual cluster / namespace with another vCluster platform user or team
`vcluster platform share namespace`	Shares a vCluster platform namespace with another platform user or team
`vcluster platform share vcluster`	Shares a virtual cluster with another vCluster platform user or team

Sleep

Command	Description
`vcluster platform sleep`	Put a virtual cluster / namespace to sleep
`vcluster platform sleep namespace`	Put a vCluster platform namespace to sleep
`vcluster platform sleep vcluster`	Put a virtual cluster to sleep

Wake up

Command	Description
`vcluster platform wakeup`	Wake up a virtual cluster / namespace
`vcluster platform wakeup namespace`	Wakes up a vCluster platform namespace
`vcluster platform wakeup vcluster`	Wake up a virtual cluster after it was put to sleep.

Backup

Command	Description
`vcluster platform backup`	Backup subcommands
`vcluster platform backup management`	Create a vCluster platform management plane backup

Reset

Command	Description
`vcluster platform reset`	Reset configuration
`vcluster platform reset password`	Resets the password of a user

Destroy

Command	Description
`vcluster platform destroy`	Destroy a vCluster Platform instance

Common tasks and CLI equivalents​

Start or install the platform​

Log in and access keys​

Connect a cluster​

Create, list, and delete tenant clusters​

Create, list, and delete namespaces​

Sleep, wake up, and share resources​

Backup, destroy, and reset password​

All platform CLI commands​

Start​

Login​

Logout​

Access keys​

Connect​

Add​

Create​

Delete​

List​

Get​

Set​

Share​

Sleep​

Wake up​

Backup​

Reset​

Destroy​