cliutil

Documentation

Index

• func AskOne(p survey.Prompt, response interface{}, v survey.Validator, ...) error
• func ChooseBool(message string, target *bool) error
• func ChooseFromList(message string, choice *string, options []string) error
• func Contains(a []string, s string) bool
• func EnsureCsv(message string, source string, target *[]string, staticMode bool) error
• func EnsureKVCsv(message string, source string, target *map[string]string, staticMode bool) error
• func GetBoolInput(msg string, value *bool) error
• func GetBoolInputDefault(msg string, value *bool, defaultValue bool) error
• func GetFreePort() (int, error)
• func GetIngressHost(ctx context.Context, proxyName, proxyNamespace, proxyPort string, ...) (string, error)
• func GetLogger() io.Writer
• func GetLogsPath() string
• func GetResource(uri string) (io.ReadCloser, error)
• func GetStringInput(msg string, value *string) error
• func GetStringInputDefault(msg string, value *string, defaultValue string) error
• func GetStringInputDefaultLazyPrompt(msgProvider func() string, value *string, defaultValue string) error
• func GetStringInputLazyPrompt(msgProvider func() string, value *string) error
• func GetStringSliceInput(msg string, value *[]string) error
• func GetStringSliceInputLazyPrompt(msgProvider func() string, value *[]string) error
• func GetUint32Input(msg string, value *uint32) error
• func GetUint32InputDefault(msg string, value *uint32, defaultValue uint32) error
• func GetYesInput(msg string) (bool, error)
• func Initialize() error
• func MultiChooseFromList(message string, choices *[]string, options []string) error
• func PortForward(namespace string, resource string, localPort string, kubePort string, ...) (*exec.Cmd, error)
• func PortForwardGet(ctx context.Context, namespace string, resource string, localPort string, ...) (string, *exec.Cmd, error)
• func SelectJoinedData(message string, target *string, list []JoinerData) error
• func UseStdio(io terminal.Stdio)
• type JoinerData
• type JoinerDataSlice

Functions

func AskOne

func AskOne(p survey.Prompt, response interface{}, v survey.Validator, opts ...survey.AskOpt) error

func ChooseBool

func ChooseBool(message string, target *bool) error

func ChooseFromList

func ChooseFromList(message string, choice *string, options []string) error

func Contains

func Contains(a []string, s string) bool

TODO(mitchdraft) move this to a util file

func EnsureCsv

func EnsureCsv(message string, source string, target *[]string, staticMode bool) error

func EnsureKVCsv

func EnsureKVCsv(message string, source string, target *map[string]string, staticMode bool) error

Expected format of source: k1,v1,k2,v2

func GetBoolInput

func GetBoolInput(msg string, value *bool) error

func GetBoolInputDefault

func GetBoolInputDefault(msg string, value *bool, defaultValue bool) error

func GetFreePort

func GetFreePort() (int, error)

func GetIngressHost

func GetIngressHost(ctx context.Context, proxyName, proxyNamespace, proxyPort string, localCluster bool, clusterName string) (string, error)

GetIngressHost returns the host address of the ingress

func GetLogger

func GetLogger() io.Writer

func GetLogsPath

func GetLogsPath() string

func GetResource

func GetResource(uri string) (io.ReadCloser, error)

GetResource identified by the given URI. The URI can either be a http(s) address or a relative/absolute file path.

func GetStringInput

func GetStringInput(msg string, value *string) error

func GetStringInputDefault

func GetStringInputDefault(msg string, value *string, defaultValue string) error

func GetStringInputDefaultLazyPrompt

func GetStringInputDefaultLazyPrompt(msgProvider func() string, value *string, defaultValue string) error

func GetStringInputLazyPrompt

func GetStringInputLazyPrompt(msgProvider func() string, value *string) error

func GetStringSliceInput

func GetStringSliceInput(msg string, value *[]string) error

func GetStringSliceInputLazyPrompt

func GetStringSliceInputLazyPrompt(msgProvider func() string, value *[]string) error

func GetUint32Input

func GetUint32Input(msg string, value *uint32) error

func GetUint32InputDefault

func GetUint32InputDefault(msg string, value *uint32, defaultValue uint32) error

func GetYesInput

func GetYesInput(msg string) (bool, error)

func Initialize

func Initialize() error

func MultiChooseFromList

func MultiChooseFromList(message string, choices *[]string, options []string) error

func PortForward

func PortForward(namespace string, resource string, localPort string, kubePort string, verbose bool) (*exec.Cmd, error)

PortForward call kubectl port-forward. Callers are expected to clean up the returned portFwd *exec.cmd after the port-forward is no longer needed.

func PortForwardGet

func PortForwardGet(ctx context.Context, namespace string, resource string, localPort string, kubePort string, verbose bool, getPath string) (string, *exec.Cmd, error)

PortForwardGet call kubectl port-forward and make a GET request. Callers are expected to clean up the returned portFwd *exec.cmd after the port-forward is no longer needed.

func SelectJoinedData

func SelectJoinedData(message string, target *string, list []JoinerData) error

func UseStdio

func UseStdio(io terminal.Stdio)

Types

type JoinerData

type JoinerData interface {
	Join() string
	ID() string
}

type JoinerDataSlice

type JoinerDataSlice []JoinerData