Skip to content

CLI tool reference

This document contains a reference of the Kubitect CLI tool. It documents each command along with its flags.

Tip

All available commands can be displayed by running kubitect --help or simply kubitect -h.

To see the help for a particular command, run kubitect command -h.

Kubitect commands🔗︎

kubitect apply🔗︎

Apply the cluster configuration.

Usage

kubitect apply [flags]

Flags

  • -a, --action <string>
      cluster action: create | scale | upgrade (default: create)
  • --auto-approve
      automatically approve any user permission requests
  • --cluster <string>
      name of the cluster to be used (default: default)
  • -c, --config <string>
      path to the cluster config file
  • -l, --local
      use a current directory as the cluster path

kubitect destroy🔗︎

Destroy the cluster. Configuration files such as cluster configuration are left in the cluster directory.

Usage

kubitect destroy [flags]

Flags

  • --auto-approve
      automatically approve any user permission requests
  • --cluster <string>
      name of the cluster to be used (default: default)
  • -l, --local
      use a current directory as the cluster path

kubitect export config🔗︎

Print cluster's configuration file to the standard output.

Usage

kubitect export config [flags]

Flags

  • --cluster <string>
      name of the cluster to be used (default: default)
  • -l, --local
      use a current directory as the cluster path

kubitect export kubeconfig🔗︎

Print cluster's kubeconfig to the standard output.

Usage

kubitect export kubeconfig [flags]

Flags

  • --cluster <string>
      name of the cluster to be used (default: default)
  • -l, --local
      use a current directory as the cluster path

kubitect list clusters🔗︎

List Kubitect clusters.

Usage

kubitect list clusters

kubitect purge🔗︎

Purge the cluster directory. Purge commands removes all files generated during cluster creation. Note that only destroyed clusters can be purged.

Usage

kubitect purge [flags]

Flags

  • --auto-approve
      automatically approve any user permission requests
  • --cluster <string>
      name of the cluster to be used (default: default)

Autogenerated commands🔗︎

kubitect completion🔗︎

Generate the autocompletion script for Kubitect for the specified shell.

Usage

kubitect completion [command]

Commands

  • bash
      Generate the autocompletion script for bash.
  • fish
      Generate the autocompletion script for fish.
  • zsh
      Generate the autocompletion script for zsh.

Tip

Run kubitect completion shell -h for instructions how to add autocompletion for a specific shell.

kubitect help🔗︎

Help provides help for any command in the application. Simply type kubitect help [path to command] for full details.

Usage

kubitect help [command]

or

kubitect [command] -h

Other🔗︎

Version flag🔗︎

Print Kubitect CLI tool version.

Usage

kubitect -v

or

kubitect --version

Debug flag🔗︎

Enable debug messages. This can be especially handy with the apply command.

Usage

kubitect [command] --debug