tui

Documentation

Index

• Constants
• Variables
• func AddColorFunctions(addCallback func(string, any))
• 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 PromptForAnswerOrAbortError(answer string, format string, a ...any) error
• func PromptForConfirmAnswer(answer string, format string, a ...any) (bool, string)
• func PromptForConfirmNo(format string, a ...any) (bool, string)
• func PromptForConfirmOrAbortError(format string, a ...any) error
• func PromptForConfirmYes(format string, a ...any) (bool, string)
• func PromptForPassword(format string, a ...any) string
• func RegisterArg0(s string)
• func SuggestionFromFormat(format string, a ...any) (errorx.Property, string)
• func SuggestionFromString(str string) (errorx.Property, string)
• func SuggestionFromTemplate(templateStr string, data any) (errorx.Property, string)
• type SSHConnectionProps
  • func ReadIdentityFileOrPassword(identityFilePath string, usePass bool) (*SSHConnectionProps, error)

Constants

const (
	ASCIIArtWarning = `` /* 623-byte string literal not displayed */

)

pre-defined ascii art strings

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

func AddColorFunctions(addCallback func(string, any))

AddColorFunctions invokes callback for each colorize functions.

func AddColorFunctionsForCobra

func AddColorFunctionsForCobra()

AddColorFunctionsForCobra adds colorize functions to cobra, so that they can be used in usage or help.

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. tiup deploy --xxx, or tiup cluster deploy --xxx

func OsArgs0

func OsArgs0() string

OsArgs0 return the command name that user inputs, e.g. tiup, 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 PromptForAnswerOrAbortError

func PromptForAnswerOrAbortError(answer string, format string, a ...any) error

PromptForAnswerOrAbortError accepts string from console by user, generates AbortError if user does not input the pre-defined answer.

func PromptForConfirmAnswer

func PromptForConfirmAnswer(answer string, format string, a ...any) (bool, string)

PromptForConfirmAnswer accepts string from console by user, default to empty and only return true if the user input is exactly the same as pre-defined answer.

func PromptForConfirmNo

func PromptForConfirmNo(format string, a ...any) (bool, string)

PromptForConfirmNo accepts yes / no from console by user, default to Yes and only return true if the user input is No

func PromptForConfirmOrAbortError

func PromptForConfirmOrAbortError(format string, a ...any) error

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

func PromptForConfirmYes

func PromptForConfirmYes(format string, a ...any) (bool, string)

PromptForConfirmYes accepts yes / no from console by user, default to No and only return true if the user input is Yes

func PromptForPassword

func PromptForPassword(format string, a ...any) string

PromptForPassword reads a password input from console

func RegisterArg0

func RegisterArg0(s string)

RegisterArg0 register arg0

func SuggestionFromFormat

func SuggestionFromFormat(format string, a ...any) (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 any) (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