cliutil

Documentation

Index

• Variables
• func BeautifyCobraUsageAndHelp(rootCmd *cobra.Command)
• func CheckCommandArgsAndMayPrintHelp(cmd *cobra.Command, args []string, minArgs int) (shouldContinue bool, err error)
• func OsArch(os, arch string) string
• func OsArgs() string
• func OsArgs0() string
• func PrintTable(rows [][]string, header bool)
• func Prompt(prompt string) string
• func PromptForConfirm(format string, a ...interface{}) bool
• func PromptForConfirmOrAbortError(format string, a ...interface{}) error
• func PromptForPassword(format string, a ...interface{}) string
• func SuggestionFromFormat(format string, a ...interface{}) (errorx.Property, string)
• func SuggestionFromString(str string) (errorx.Property, string)
• func SuggestionFromTemplate(templateStr string, data interface{}) (errorx.Property, string)
• type SSHConnectionProps
  • func ReadIdentityFileOrPassword(identityFilePath string, usePass bool) (*SSHConnectionProps, error)

Variables

var (
	// ErrIdentityFileReadFiled is ErrIdentityFileReadFiled
	ErrIdentityFileReadFiled = errNS.NewType("id_read_failed", errutil.ErrTraitPreCheck)
)

Functions

func BeautifyCobraUsageAndHelp

func BeautifyCobraUsageAndHelp(rootCmd *cobra.Command)

BeautifyCobraUsageAndHelp beautifies cobra usages and help.

func CheckCommandArgsAndMayPrintHelp

func CheckCommandArgsAndMayPrintHelp(cmd *cobra.Command, args []string, minArgs int) (shouldContinue bool, err error)

CheckCommandArgsAndMayPrintHelp checks whether user passes enough number of arguments. If insufficient number of arguments are passed, an error with proper suggestion will be raised. When no argument is passed, command help will be printed and no error will be raised.

func OsArch

func OsArch(os, arch string) string

OsArch builds an "os/arch" string from input, it converts some similar strings to different words to avoid misreading when displaying in terminal

func OsArgs

func OsArgs() string

OsArgs return the whole command line that user inputs, e.g. tiops deploy --xxx, or tiup cluster deploy --xxx

func OsArgs0

func OsArgs0() string

OsArgs0 return the command name that user inputs, e.g. tiops, or tiup cluster.

func PrintTable

func PrintTable(rows [][]string, header bool)

PrintTable accepts a matrix of strings and print them as ASCII table to terminal

func Prompt

func Prompt(prompt string) string

Prompt accepts input from console by user

func PromptForConfirm

func PromptForConfirm(format string, a ...interface{}) bool

PromptForConfirm accepts yes / no from console by user

func PromptForConfirmOrAbortError

func PromptForConfirmOrAbortError(format string, a ...interface{}) error

PromptForConfirmOrAbortError accepts yes / no from console by user, generates AbortError if user does not input yes.

func PromptForPassword

func PromptForPassword(format string, a ...interface{}) string

PromptForPassword reads a password input from console

func SuggestionFromFormat

func SuggestionFromFormat(format string, a ...interface{}) (errorx.Property, string)

SuggestionFromFormat creates a suggestion from a format. Usage: SomeErrorX.WithProperty(SuggestionFromFormat(..))

func SuggestionFromString

func SuggestionFromString(str string) (errorx.Property, string)

SuggestionFromString creates a suggestion from string. Usage: SomeErrorX.WithProperty(SuggestionFromString(..))

func SuggestionFromTemplate

func SuggestionFromTemplate(templateStr string, data interface{}) (errorx.Property, string)

SuggestionFromTemplate creates a suggestion from go template. Colorize function and some other utilities are available. Usage: SomeErrorX.WithProperty(SuggestionFromTemplate(..))

Types

type SSHConnectionProps

type SSHConnectionProps struct {
	Password               string
	IdentityFile           string
	IdentityFilePassphrase string
}

SSHConnectionProps is SSHConnectionProps

func ReadIdentityFileOrPassword

func ReadIdentityFileOrPassword(identityFilePath string, usePass bool) (*SSHConnectionProps, error)

ReadIdentityFileOrPassword is ReadIdentityFileOrPassword