interfaces

Documentation

Index

• func ShowVersion(name, version, buildDate, oSBuildName string)
• type Cli
• type Command
• type Options
• type ParsingContext
• type SecretEngine

Functions

func ShowVersion

func ShowVersion(name, version, buildDate, oSBuildName string)

Types

type Cli

type Cli interface {
	Init(opt Options)
	// ShowVersion - default show version
	ShowVersion()
	SetConfig(cfg interface{})
	GenerateConfig(cfg interface{}, output string)
	SetDefaultAction(callback func(ctx interface{}) (err error))
	SetCommand(subcommand []*Command)
	Run(inputs ...any) (err error)
	ParsingContext(ctx interface{}) ParsingContext
	RegisterClean(inputs ...any)
}

type Command

type Command struct {
	EnvConfigName              string
	Config                     interface{}
	Name                       string
	Description                string
	Action                     func(ctx interface{}) (err error)
	SubCommand                 []*Command
	NotExitWhenCommandNotFound bool
	DisableDefaultFlag         bool
}

type Options

type Options struct {
	Name                string
	Description         string
	Version             string
	BuildDate           string
	OSBuildName         string
	Logger              logger.Logger
	DisableDefaultFlag  bool
	ShowVersionFunction func()
}

type ParsingContext

type ParsingContext interface {
	ArgumentsFirst() (val string, err error)
}

type SecretEngine

type SecretEngine interface {
	Init() error
	GetVariableData(key string) string
	GetConfigData(key string) (res []byte, err error)
}