xcmd

Documentation

Index

• Variables
• func Args(fn func(cmd *Command)) func(cmd *Command) *Command
• func GetPasswd(prompt ...string) ([]byte, error)
• func GetPasswdMasked(prompt ...string) ([]byte, error)
• func GetPasswdPrompt(prompt string, mask bool, r fdReader, w io.Writer) ([]byte, error)
• func Init(cfn ...func(cmd *Command)) func(fn ...func(*Command))
• func WithDebug(debug ...bool) func(cmd *Command)
• func WithHome(defaultHome ...string) func(cmd *Command)
• func WithLogLevel(ll ...string) func(cmd *Command)
• func WithMode(mode ...string) func(cmd *Command)
• type Command

Variables

var (
	ErrInterrupted       = errors.New("interrupted")
	ErrMaxLengthExceeded = fmt.Errorf("maximum byte limit (%v) exceeded", maxLength)
)

Functions

func Args

func Args(fn func(cmd *Command)) func(cmd *Command) *Command

func GetPasswd

func GetPasswd(prompt ...string) ([]byte, error)

GetPasswd returns the password read from the terminal without echoing input. The returned byte array does not include end-of-line characters.

func GetPasswdMasked

func GetPasswdMasked(prompt ...string) ([]byte, error)

GetPasswdMasked returns the password read from the terminal, echoing asterisks. The returned byte array does not include end-of-line characters.

func GetPasswdPrompt

func GetPasswdPrompt(prompt string, mask bool, r fdReader, w io.Writer) ([]byte, error)

GetPasswdPrompt prompts the user and returns the password read from the terminal. If mask is true, then asterisks are echoed. The returned byte array does not include end-of-line characters.

func Init

func Init(cfn ...func(cmd *Command)) func(fn ...func(*Command))

func WithDebug

func WithDebug(debug ...bool) func(cmd *Command)

func WithHome

func WithHome(defaultHome ...string) func(cmd *Command)

func WithLogLevel

func WithLogLevel(ll ...string) func(cmd *Command)

func WithMode

func WithMode(mode ...string) func(cmd *Command)

Types

type Command

type Command = cobra.Command