OS Manuals

/usr/bin/kots

Kubernetes Off-The-Shelf (KOTS) Software

From kots 1.130.4-r6 (os), captured 2026-11-05 by running kots --help (exit 0). permalink

Also provided by 1 other package version
.

Usage:
  kots [command]

Available Commands:
  admin-console    Make the admin console accessible
  backup           Provides wrapper functionality to interface with the backup source
  completion       Generate completion script
  docker           KOTS Docker interface
  download         Download Kubernetes manifests from your cluster to the local filesystem
  enable-ha        Enables HA mode for the admin console
  get              Display kots resources
  help             Help about any command
  install          Install an application to a cluster
  pull             Pull Kubernetes manifests from remote upstream to the local filesystem
  remove           Remove an application from console
  reset-password   Change the password on the admin console
  reset-tls        Reverts kurl_proxy to a self-signed TLS certificate
  restore          Provides wrapper functionality to interface with the restore source
  set              Configure kots resources
  upload           Upload Kubernetes manifests from the local filesystem to your cluster
  upstream         Provides wrapper functionality to interface with the upstream source
  velero           KOTS Velero interface
  version          Print the current version and exit

Flags:
      --as string                      Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
      --as-group stringArray           Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
      --as-uid string                  UID to impersonate for the operation.
      --as-user-extra stringArray      User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key.
      --cache-dir string               Default cache directory (default "/tmp/.kube/cache")
      --certificate-authority string   Path to a cert file for the certificate authority
      --client-certificate string      Path to a client certificate file for TLS
      --client-key string              Path to a client key file for TLS
      --cluster string                 The name of the kubeconfig cluster to use
      --context string                 The name of the kubeconfig context to use
      --disable-compression            If true, opt-out of response compression for all requests to the server
  -h, --help                           help for kots
      --insecure-skip-tls-verify       If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
      --kubeconfig string              Path to the kubeconfig file to use for CLI requests.
  -n, --namespace string               If present, the namespace scope for this CLI request
      --request-timeout string         The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
  -s, --server string                  The address and port of the Kubernetes API server
      --tls-server-name string         Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used
      --token string                   Bearer token for authentication to the API server
      --user string                    The name of the kubeconfig user to use
      --version version[=true]         --version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version

Use "kots [command] --help" for more information about a command.
Options (21)
OptionDescriptionSource
--as stringUsername to impersonate for the operation.help
--as-group stringArrayGroup to impersonate for the operation, this flag can be repeated to specify multiple groups.help
--as-uid stringUID to impersonate for the operation.help
--as-user-extra stringArrayUser extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key.help
--cache-dir stringDefault cache directory (default "/tmp/.kube/cache")help
--certificate-authority stringPath to a cert file for the certificate authorityhelp
--client-certificate stringPath to a client certificate file for TLShelp
--client-key stringPath to a client key file for TLShelp
--cluster stringThe name of the kubeconfig cluster to usehelp
--context stringThe name of the kubeconfig context to usehelp
--disable-compressionIf true, opt-out of response compression for all requests to the serverhelp
-h, --helphelp for kotshelp
--insecure-skip-tls-verifyIf true, the server's certificate will not be checked for validity.help
--kubeconfig stringPath to the kubeconfig file to use for CLI requests.help
-n, --namespace stringIf present, the namespace scope for this CLI requesthelp
--request-timeout stringThe length of time to wait before giving up on a single server request.help
-s, --server stringThe address and port of the Kubernetes API serverhelp
--tls-server-name stringServer name to use for server certificate validation.help
--token stringBearer token for authentication to the API serverhelp
--user stringThe name of the kubeconfig user to usehelp
--version version[=true--version, --version=raw prints version information and quits;help

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