cli

Documentation

Index

• func AddKubectlFlagsToCmd(cmd *cobra.Command) clientcmd.ClientConfig
• func AskToProceed(message string) bool
• func MarshalLocalYAMLFile(path string, obj interface{}) error
• func NewVersionCmd(cliName string) *cobra.Command
• func PromptCredentials(username, password string) (string, string)
• func PromptMessage(message, value string) string
• func PromptPassword(password string) string
• func PromptUsername(username string) string
• func UnmarshalLocalFile(path string, obj interface{}) error
• func UnmarshalRemoteFile(url string, obj interface{}) error

Functions

func AddKubectlFlagsToCmd

func AddKubectlFlagsToCmd(cmd *cobra.Command) clientcmd.ClientConfig

AddKubectlFlagsToCmd adds kubectl like flags to a command and returns the ClientConfig interface for retrieving the values.

func AskToProceed

func AskToProceed(message string) bool

AskToProceed prompts the user with a message (typically a yes or no question) and returns whether or not they responded in the affirmative or negative.

func MarshalLocalYAMLFile

func MarshalLocalYAMLFile(path string, obj interface{}) error

MarshalLocalYAMLFile writes JSON or YAML to a file on disk. The caller is responsible for checking error return values.

func NewVersionCmd

func NewVersionCmd(cliName string) *cobra.Command

NewVersionCmd returns a new `version` command to be used as a sub-command to root

func PromptCredentials

func PromptCredentials(username, password string) (string, string)

PromptCredentials is a helper to prompt the user for a username and password (unless already supplied)

func PromptMessage

func PromptMessage(message, value string) string

PromptMessage prompts the user for a value (unless already supplied)

func PromptPassword

func PromptPassword(password string) string

PromptPassword prompts the user for a password, without local echo. (unless already supplied)

func PromptUsername

func PromptUsername(username string) string

PromptUsername prompts the user for a username value

func UnmarshalLocalFile

func UnmarshalLocalFile(path string, obj interface{}) error

UnmarshalLocalFile retrieves JSON or YAML from a file on disk. The caller is responsible for checking error return values.

func UnmarshalRemoteFile

func UnmarshalRemoteFile(url string, obj interface{}) error

UnmarshalRemoteFile retrieves JSON or YAML through a GET request. The caller is responsible for checking error return values.