Skip to main content
Version: main 🚧

vCluster CLI

The vCluster CLI, vcluster, creates, connects to, and maintains clusters from your terminal. This section is its reference. Three pages cover setting the CLI up, and every other page documents one command, with its flags and examples, generated from the CLI's own help. If you don't have the CLI yet, start with Install the vCluster CLI.

How commands reach a cluster​

Most commands manage a cluster's lifecycle, and they work through a driver. vcluster use driver sets the default deployment method to Helm, the platform, or Docker. The lifecycle commands, such as create, connect, list, delete, pause, and restore, use that default, and each one takes a --driver flag to override it for a single run.

The driver decides what a command does, not only where it runs. Pausing a cluster with the Helm driver, for example, stops different things than pausing it through the platform. When a command's effect matters, read the task page that uses it, such as Pause and resume a cluster.

A few commands don't use a driver at all. vcluster certs, vcluster token, and vcluster node work on one cluster's control plane certificates, join tokens, and nodes. The commands under vcluster platform work with vCluster Platform itself, such as logging in, access keys, and backups. For those grouped next to their UI equivalents, see the Platform CLI hub in the vCluster Platform docs.

Find a command​

The table groups the top-level commands by task. Each command page lists its subcommands.

TaskCommandWhat it does
Set up the CLIvcluster use driverSets Helm, the platform, or Docker as the default driver
vcluster upgradeUpdates the CLI itself
vcluster versionPrints the installed CLI version
vcluster telemetryTurns CLI telemetry on or off
vcluster creditsSaves the license and copyright notices of the CLI's dependencies
Create and connectvcluster createDeploys a cluster from a vcluster.yaml you pass with --values
vcluster connectConnects to a cluster and gets a kubeconfig for it
vcluster disconnectSwitches your kube context back after a connect that changed it
vcluster listLists your clusters
vcluster describeShows the details of one cluster
vcluster deleteRemoves a cluster
Run clustersvcluster pause and vcluster resumePause a cluster and start it again. What pause stops depends on the driver
vcluster snapshot create and vcluster snapshot getRequest a snapshot of a cluster, and get one from its storage location
vcluster restoreRestores a cluster from a snapshot
vcluster certsChecks the control plane certificates and rotates the leaf certificates or the CA
vcluster debugCollects diagnostic information, or opens a shell in the control plane pod
Nodes and imagesvcluster tokenCreates, lists, and deletes the bootstrap tokens private nodes use to join
vcluster nodeUpgrades or deletes a node, and loads a local Docker image into one
vcluster registryPushes images, archives, and Helm charts into the cluster's registry
The platformvcluster platformHolds the commands for vCluster Platform
vcluster uiOpens the platform web UI
vcluster set secretSets a key in a project secret
vcluster logoutLogs out of the platform. To log in, use vcluster platform login, because vcluster login is deprecated

Two setup pages aren't commands. Global flags covers the flags every command accepts, such as the kube context, namespace, and log verbosity. Use vCluster CLI as a kubectl plugin lets you run the same commands through kubectl.

Commands in context​

A command page tells you what a command accepts. The task pages tell you when to run it and what happens. To run clusters in Docker, see Deployment basics. To join private nodes, see Join manually provisioned nodes. For kubeconfigs, snapshots, and certificate rotation, see Access and expose vCluster, Create snapshots, and Rotate certificates.