Documentation
¶
Index ¶
- Variables
- func AddColorFunctions(addCallback func(string, interface{}))
- func AddColorFunctionsForCobra()
- 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 PromptForConfirmNo(format string, a ...interface{}) (bool, string)
- func PromptForConfirmOrAbortError(format string, a ...interface{}) error
- func PromptForConfirmYes(format string, a ...interface{}) (bool, string)
- func PromptForPassword(format string, a ...interface{}) string
- func RegisterArg0(s 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
Constants ¶
This section is empty.
Variables ¶
var ( // ColorErrorMsg is the ansi color formatter for error messages ColorErrorMsg = color.New(color.FgHiRed) // ColorSuccessMsg is the ansi color formatter for success messages ColorSuccessMsg = color.New(color.FgHiGreen) // ColorWarningMsg is the ansi color formatter for warning messages ColorWarningMsg = color.New(color.FgHiYellow) // ColorCommand is the ansi color formatter for commands ColorCommand = color.New(color.FgHiBlue, color.Bold) // ColorKeyword is the ansi color formatter for cluster name ColorKeyword = color.New(color.FgHiBlue, color.Bold) )
var ( // ErrIdentityFileReadFailed is ErrIdentityFileReadFailed ErrIdentityFileReadFailed = errNS.NewType("id_read_failed", utils.ErrTraitPreCheck) )
Functions ¶
func AddColorFunctions ¶ added in v1.6.0
func AddColorFunctions(addCallback func(string, interface{}))
AddColorFunctions invokes callback for each colorize functions.
func AddColorFunctionsForCobra ¶ added in v1.6.0
func AddColorFunctionsForCobra()
AddColorFunctionsForCobra adds colorize functions to cobra, so that they can be used in usage or help.
func BeautifyCobraUsageAndHelp ¶ added in v1.6.0
BeautifyCobraUsageAndHelp beautifies cobra usages and help.
func CheckCommandArgsAndMayPrintHelp ¶ added in v1.6.0
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 ¶ added in v1.6.0
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 ¶ added in v1.6.0
func OsArgs() string
OsArgs return the whole command line that user inputs, e.g. tiup deploy --xxx, or tiup cluster deploy --xxx
func OsArgs0 ¶ added in v1.6.0
func OsArgs0() string
OsArgs0 return the command name that user inputs, e.g. tiup, or tiup cluster.
func PrintTable ¶
PrintTable accepts a matrix of strings and print them as ASCII table to terminal
func PromptForConfirmNo ¶ added in v1.6.0
PromptForConfirmNo accepts yes / no from console by user, default to Yes and only return true if the user input is No
func PromptForConfirmOrAbortError ¶ added in v1.6.0
PromptForConfirmOrAbortError accepts yes / no from console by user, generates AbortError if user does not input yes.
func PromptForConfirmYes ¶ added in v1.6.0
PromptForConfirmYes accepts yes / no from console by user, default to No and only return true if the user input is Yes
func PromptForPassword ¶ added in v1.6.0
PromptForPassword reads a password input from console
func SuggestionFromFormat ¶ added in v1.6.0
SuggestionFromFormat creates a suggestion from a format. Usage: SomeErrorX.WithProperty(SuggestionFromFormat(..))
func SuggestionFromString ¶ added in v1.6.0
SuggestionFromString creates a suggestion from string. Usage: SomeErrorX.WithProperty(SuggestionFromString(..))
func SuggestionFromTemplate ¶ added in v1.6.0
SuggestionFromTemplate creates a suggestion from go template. Colorize function and some other utilities are available. Usage: SomeErrorX.WithProperty(SuggestionFromTemplate(..))
Types ¶
type SSHConnectionProps ¶ added in v1.6.0
type SSHConnectionProps struct { Password string IdentityFile string IdentityFilePassphrase string }
SSHConnectionProps is SSHConnectionProps
func ReadIdentityFileOrPassword ¶ added in v1.6.0
func ReadIdentityFileOrPassword(identityFilePath string, usePass bool) (*SSHConnectionProps, error)
ReadIdentityFileOrPassword is ReadIdentityFileOrPassword