This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Reference

Low level reference docs for your project.

The Below CLI Command Reference are mapped from ksctl/cli repo

CLI Command Reference

Docs are available now in cli repo Here are the links for the documentation files

CLI Root Command

1 - ksctl

Command documentation for ksctl

ksctl

CLI tool for managing multiple K8s clusters

Synopsis

CLI tool which can manage multiple K8s clusters from local clusters to cloud provider specific clusters.

Options

      --debug-cli   Its used to run debug mode against cli's menudriven interface
  -h, --help        help for ksctl
  -t, --toggle      Help message for toggle
  -v, --verbose     Enable verbose output

SEE ALSO

Auto generated by spf13/cobra on 22-Feb-2025

2 - ksctl_addons

Command documentation for ksctl_addons

ksctl addons

Use to work with addons

Synopsis

It is used to work with addons

Examples


ksctl addons --help

Options

  -h, --help   help for addons

Options inherited from parent commands

      --debug-cli   Its used to run debug mode against cli's menudriven interface
  -v, --verbose     Enable verbose output

SEE ALSO

Auto generated by spf13/cobra on 22-Feb-2025

3 - ksctl_addons_disable

Command documentation for ksctl_addons_disable

ksctl addons disable

Use to disable an addon

Synopsis

It is used to disable an addon

ksctl addons disable [flags]

Examples


ksctl addons disable --help

Options

  -h, --help   help for disable

Options inherited from parent commands

      --debug-cli   Its used to run debug mode against cli's menudriven interface
  -v, --verbose     Enable verbose output

SEE ALSO

Auto generated by spf13/cobra on 22-Feb-2025

4 - ksctl_addons_enable

Command documentation for ksctl_addons_enable

ksctl addons enable

Use to enable an addon

Synopsis

It is used to enable an addon

ksctl addons enable [flags]

Examples


ksctl addons enable --help

Options

  -h, --help   help for enable

Options inherited from parent commands

      --debug-cli   Its used to run debug mode against cli's menudriven interface
  -v, --verbose     Enable verbose output

SEE ALSO

Auto generated by spf13/cobra on 22-Feb-2025

5 - ksctl_cluster

Command documentation for ksctl_cluster

ksctl cluster

Use to work with clusters

Synopsis

It is used to work with cluster

Examples


ksctl cluster --help

Options

  -h, --help   help for cluster

Options inherited from parent commands

      --debug-cli   Its used to run debug mode against cli's menudriven interface
  -v, --verbose     Enable verbose output

SEE ALSO

Auto generated by spf13/cobra on 22-Feb-2025

6 - ksctl_cluster_connect

Command documentation for ksctl_cluster_connect

ksctl cluster connect

Connect to existing cluster

Synopsis

It is used to connect to existing cluster

ksctl cluster connect [flags]

Examples


ksctl connect --help

Options

  -h, --help   help for connect

Options inherited from parent commands

      --debug-cli   Its used to run debug mode against cli's menudriven interface
  -v, --verbose     Enable verbose output

SEE ALSO

Auto generated by spf13/cobra on 22-Feb-2025

7 - ksctl_cluster_create

Command documentation for ksctl_cluster_create

ksctl cluster create

Use to create a cluster

Synopsis

It is used to create cluster with the given name from user

ksctl cluster create [flags]

Examples


ksctl create --help

Options

  -h, --help   help for create

Options inherited from parent commands

      --debug-cli   Its used to run debug mode against cli's menudriven interface
  -v, --verbose     Enable verbose output

SEE ALSO

Auto generated by spf13/cobra on 22-Feb-2025

8 - ksctl_cluster_delete

Command documentation for ksctl_cluster_delete

ksctl cluster delete

Use to delete a cluster

Synopsis

It is used to delete cluster with the given name from user

ksctl cluster delete [flags]

Examples


ksctl delete --help

Options

  -h, --help   help for delete

Options inherited from parent commands

      --debug-cli   Its used to run debug mode against cli's menudriven interface
  -v, --verbose     Enable verbose output

SEE ALSO

Auto generated by spf13/cobra on 22-Feb-2025

9 - ksctl_cluster_get

Command documentation for ksctl_cluster_get

ksctl cluster get

Use to get the cluster

Synopsis

It is used to get the cluster created by the user

ksctl cluster get [flags]

Examples


ksctl get --help

Options

  -h, --help   help for get

Options inherited from parent commands

      --debug-cli   Its used to run debug mode against cli's menudriven interface
  -v, --verbose     Enable verbose output

SEE ALSO

Auto generated by spf13/cobra on 22-Feb-2025

10 - ksctl_cluster_list

Command documentation for ksctl_cluster_list

ksctl cluster list

Use to list all the clusters

Synopsis

It is used to list all the clusters created by the user

ksctl cluster list [flags]

Examples


ksctl list --help

Options

  -h, --help   help for list

Options inherited from parent commands

      --debug-cli   Its used to run debug mode against cli's menudriven interface
  -v, --verbose     Enable verbose output

SEE ALSO

Auto generated by spf13/cobra on 22-Feb-2025

11 - ksctl_cluster_scaledown

Command documentation for ksctl_cluster_scaledown

ksctl cluster scaledown

Use to manually scaledown a selfmanaged cluster

Synopsis

It is used to manually scaledown a selfmanaged cluster

ksctl cluster scaledown [flags]

Examples


ksctl update scaledown --help

Options

  -h, --help   help for scaledown

Options inherited from parent commands

      --debug-cli   Its used to run debug mode against cli's menudriven interface
  -v, --verbose     Enable verbose output

SEE ALSO

Auto generated by spf13/cobra on 22-Feb-2025

12 - ksctl_cluster_scaleup

Command documentation for ksctl_cluster_scaleup

ksctl cluster scaleup

Use to manually scaleup a selfmanaged cluster

Synopsis

It is used to manually scaleup a selfmanaged cluster

ksctl cluster scaleup [flags]

Examples


ksctl update scaleup --help

Options

  -h, --help   help for scaleup

Options inherited from parent commands

      --debug-cli   Its used to run debug mode against cli's menudriven interface
  -v, --verbose     Enable verbose output

SEE ALSO

Auto generated by spf13/cobra on 22-Feb-2025

13 - ksctl_configure

Command documentation for ksctl_configure

ksctl configure

Configure ksctl cli

Synopsis

It will display the current ksctl cli configuration

ksctl configure [flags]

Options

  -h, --help   help for configure

Options inherited from parent commands

      --debug-cli   Its used to run debug mode against cli's menudriven interface
  -v, --verbose     Enable verbose output

SEE ALSO

Auto generated by spf13/cobra on 22-Feb-2025

14 - ksctl_configure_cloud

Command documentation for ksctl_configure_cloud

ksctl configure cloud

Configure cloud

Synopsis

It will help you to configure the cloud

ksctl configure cloud [flags]

Options

  -h, --help   help for cloud

Options inherited from parent commands

      --debug-cli   Its used to run debug mode against cli's menudriven interface
  -v, --verbose     Enable verbose output

SEE ALSO

Auto generated by spf13/cobra on 22-Feb-2025

15 - ksctl_configure_storage

Command documentation for ksctl_configure_storage

ksctl configure storage

Configure storage

Synopsis

It will help you to configure the storage

ksctl configure storage [flags]

Options

  -h, --help   help for storage

Options inherited from parent commands

      --debug-cli   Its used to run debug mode against cli's menudriven interface
  -v, --verbose     Enable verbose output

SEE ALSO

Auto generated by spf13/cobra on 22-Feb-2025

16 - ksctl_configure_telemetry

Command documentation for ksctl_configure_telemetry

ksctl configure telemetry

Configure telemetry

Synopsis

It will help you to configure the telemetry

ksctl configure telemetry [flags]

Options

  -h, --help   help for telemetry

Options inherited from parent commands

      --debug-cli   Its used to run debug mode against cli's menudriven interface
  -v, --verbose     Enable verbose output

SEE ALSO

Auto generated by spf13/cobra on 22-Feb-2025

17 - ksctl_self-update

Command documentation for ksctl_self-update

ksctl self-update

Use to update the ksctl cli

Synopsis

It is used to update the ksctl cli

ksctl self-update [flags]

Examples


ksctl self-update --help

Options

  -h, --help   help for self-update

Options inherited from parent commands

      --debug-cli   Its used to run debug mode against cli's menudriven interface
  -v, --verbose     Enable verbose output

SEE ALSO

  • ksctl - CLI tool for managing multiple K8s clusters
Auto generated by spf13/cobra on 22-Feb-2025

18 - ksctl_version

Command documentation for ksctl_version

ksctl version

ksctl version

Synopsis

To get version for ksctl components

ksctl version [flags]

Examples


ksctl version --help

Options

  -h, --help   help for version

Options inherited from parent commands

      --debug-cli   Its used to run debug mode against cli's menudriven interface
  -v, --verbose     Enable verbose output

SEE ALSO

  • ksctl - CLI tool for managing multiple K8s clusters
Auto generated by spf13/cobra on 22-Feb-2025