spinkube / spin-plugin-kube

A Spin plugin for interacting with Kubernetes.
Other
20 stars 5 forks source link

mark kubectl flags as hidden #19

Closed bacongobbler closed 7 months ago

bacongobbler commented 7 months ago

Other than --kubeconfig and --namespace, a large majority of the flags provided by k8s.io/cli-runtime rarely apply to the k8s plugin. To address this, I'm marking them as hidden, removing their shortflag versions, and placing a --kube- prefix in front of each option. That way these flags do not clash with any flags we introduce in the future, and they're still accessible by the user should the need arise in the future.

bacongobbler commented 7 months ago

New help output:

><> spin k8s help
Manage apps running on Kubernetes

Usage:
  k8s [command]

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  connect     connect to spin app locally
  delete      Delete app
  deploy      deploy spin app
  get         Display detailed information about an app
  help        Help about any command
  list        List apps
  logs        print the logs for a SpinApp
  scaffold    scaffold SpinApp manifest
  version     Display version information

Flags:
  -h, --help                help for k8s
      --kubeconfig string   Path to the kubeconfig file to use for CLI requests.
  -n, --namespace string    If present, the namespace scope for this CLI request
  -v, --version             version for k8s

Use "k8s [command] --help" for more information about a command.