promputils

Documentation

Index

• Constants
• func AppendCommand(parentCmd *Cmd, text, desc string)
• func AppendOpt(text, cmd, desc string, arg structarg.Argument)
• func AppendPos(text, cmd, desc string, arg structarg.Argument)
• func Completer(d prompt.Document) []prompt.Suggest
• func ExecuteAndGetResult(s string) (string, error)
• func Executor(s string)
• func GenerateAutoCompleteCmds(rootCmd *Cmd, shell string) string
• func InitEnv(_parser *structarg.ArgumentParser, _session *mcclient.ClientSession)
• type Cmd
  • func GetRootCmd() *Cmd
  • func InitRootCmd(name, desc string, optArgs, posArgs []structarg.Argument) *Cmd
  • func NewCmd(name, desc string) *Cmd
  • func (c *Cmd) AddCmd(cmd *Cmd)
  • func (c *Cmd) AddOptArgument(arg structarg.Argument, argStr string, desc string)
  • func (c *Cmd) AddPosArgument(arg structarg.Argument, argStr string, desc string)
  • func (c *Cmd) GenZshCompletion(w io.Writer) error
  • func (c Cmd) GetArguments() []structarg.Argument
  • func (c Cmd) GetName() string
  • func (c Cmd) GetOptArguments() []structarg.Argument
  • func (c Cmd) GetPosArguments() []structarg.Argument
  • func (c Cmd) GetPromptOptSuggests() []prompt.Suggest
  • func (c Cmd) GetPromptPosSuggests() []prompt.Suggest
  • func (c *Cmd) Root() *Cmd
• type CmdArgument

Constants

const BASH_COMPLETE_SCRIPT_1 = `` /* 238-byte string literal not displayed */

const BASH_COMPLETE_SCRIPT_2 = `` /* 615-byte string literal not displayed */

const ZSH_COMPLETE_SCRIPT_1 = `` /* 205-byte string literal not displayed */

Functions

func AppendCommand

func AppendCommand(parentCmd *Cmd, text, desc string)

func AppendOpt

func AppendOpt(text, cmd, desc string, arg structarg.Argument)

func AppendPos

func AppendPos(text, cmd, desc string, arg structarg.Argument)

func Completer

func Completer(d prompt.Document) []prompt.Suggest

func ExecuteAndGetResult

func ExecuteAndGetResult(s string) (string, error)

func Executor

func Executor(s string)

func GenerateAutoCompleteCmds

func GenerateAutoCompleteCmds(rootCmd *Cmd, shell string) string

func InitEnv

func InitEnv(_parser *structarg.ArgumentParser, _session *mcclient.ClientSession)

Types

type Cmd

type Cmd struct {
	Name string
	Desc string

	ParentCmd *Cmd
	SubCmds   []*Cmd
	// contains filtered or unexported fields
}

func GetRootCmd

func GetRootCmd() *Cmd

func InitRootCmd

func InitRootCmd(name, desc string, optArgs, posArgs []structarg.Argument) *Cmd

func NewCmd

func NewCmd(name, desc string) *Cmd

func (*Cmd) AddCmd

func (c *Cmd) AddCmd(cmd *Cmd)

func (*Cmd) AddOptArgument

func (c *Cmd) AddOptArgument(arg structarg.Argument, argStr string, desc string)

func (*Cmd) AddPosArgument

func (c *Cmd) AddPosArgument(arg structarg.Argument, argStr string, desc string)

func (*Cmd) GenZshCompletion

func (c *Cmd) GenZshCompletion(w io.Writer) error

func (Cmd) GetArguments

func (c Cmd) GetArguments() []structarg.Argument

func (Cmd) GetName

func (c Cmd) GetName() string

func (Cmd) GetOptArguments

func (c Cmd) GetOptArguments() []structarg.Argument

func (Cmd) GetPosArguments

func (c Cmd) GetPosArguments() []structarg.Argument

func (Cmd) GetPromptOptSuggests

func (c Cmd) GetPromptOptSuggests() []prompt.Suggest

func (Cmd) GetPromptPosSuggests

func (c Cmd) GetPromptPosSuggests() []prompt.Suggest

func (*Cmd) Root

func (c *Cmd) Root() *Cmd

type CmdArgument

type CmdArgument struct {
	Suggest  prompt.Suggest
	Argument structarg.Argument
}