OS Manuals

/usr/bin/vcluster

From vcluster-cli-fips 0.37.6-r1 (enterprise-packages), captured 2026-11-08 by running vcluster --help (exit 0). permalink

vcluster root command

Usage:
  vcluster [command]

Available Commands:
  certs       vCluster certs subcommands
  completion  Generate the autocompletion script for the specified shell
  connect     Connect to a virtual cluster
  create      Create a new virtual cluster
  credits     Saves the OSS credits
  debug       Debug retrieves information from vCluster
  delete      Deletes a virtual cluster
  describe    Describes a virtual cluster
  disconnect  Disconnects from a vCluster platform context
  help        Help about any command
  list        Lists all virtual clusters
  login       Log in to a vCluster platform instance
  logout      Log out of a vCluster platform instance
  node        vCluster node subcommand
  pause       Pauses a virtual cluster
  platform    vCluster platform subcommands
  registry    vCluster registry subcommand
  restore     Restores a virtual cluster from snapshot
  resume      Resumes a virtual cluster
  set         Set configuration
  snapshot    Snapshot a virtual cluster (deprecated, use 'vcluster snapshot create' instead)
  telemetry   Sets your vcluster telemetry preferences
  token       vCluster token subcommand
  ui          Start the web UI
  upgrade     Upgrade the vcluster CLI to the newest version
  use         vCluster use subcommand
  version     Print the vCluster version

Flags:
      --config string       The vcluster CLI config to use (will be created if it does not exist) (default "/tmp/.vcluster/config.json")
      --context string      The kubernetes config context to use
      --debug               Prints the stack trace if an error occurs
  -h, --help                help for vcluster
      --log-output string   The log format to use. Can be either plain, raw or json (default "plain")
  -n, --namespace string    The kubernetes namespace to use
  -s, --silent              Run in silent mode and prevents any vcluster log output except panics & fatals
  -v, --version             version for vcluster

Use "vcluster [command] --help" for more information about a command.
Options (8)
OptionDescriptionSource
--config stringThe vcluster CLI config to use (will be created if it does not exist) (default "/tmp/.vcluster/config.json")help
--context stringThe kubernetes config context to usehelp
--debugPrints the stack trace if an error occurshelp
-h, --helphelp for vclusterhelp
--log-output stringThe log format to use.help
-n, --namespace stringThe kubernetes namespace to usehelp
-s, --silentRun in silent mode and prevents any vcluster log output except panics & fatalshelp
-v, --versionversion for vclusterhelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.