cmdBuilder

package

v1.0.16 Latest Latest Go to latest Published: Apr 27, 2024 License: MIT Imports: 26 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/zeropsio/zcli

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func ExecuteRootCmd(rootCmd *Cmd) (err error)
type ArgOption
type Cmd
- func NewCmd() *Cmd
type CmdParamReader
type FlagOption
- func HiddenFlag() FlagOption
- func ShortHand(shorthand string) FlagOption
type GuestCmdData
type LoggedUserCmdData
type ParamsReader
type ScopeLevel

Constants ¶

View Source

const (
	TerminalModeAuto     terminalMode = "auto"
	TerminalModeDisabled terminalMode = "disabled"
	TerminalModeEnabled  terminalMode = "enabled"
)

Variables ¶

This section is empty.

Functions ¶

func ExecuteRootCmd ¶ added in v1.0.5

func ExecuteRootCmd(rootCmd *Cmd) (err error)

Types ¶

type ArgOption ¶

type ArgOption = func(cfg *cmdArg)

func ArrayArg ¶

func ArrayArg() ArgOption

func OptionalArg ¶

func OptionalArg() ArgOption

func OptionalArgLabel ¶

func OptionalArgLabel(label string) ArgOption

type Cmd ¶

type Cmd struct {
	// contains filtered or unexported fields
}

func NewCmd ¶

func NewCmd() *Cmd

func (*Cmd) AddChildrenCmd ¶

func (cmd *Cmd) AddChildrenCmd(childrenCmd *Cmd) *Cmd

func (*Cmd) Arg ¶

func (cmd *Cmd) Arg(name string, auxOptions ...ArgOption) *Cmd

func (*Cmd) BoolFlag ¶

func (cmd *Cmd) BoolFlag(name string, defaultValue bool, description string, auxOptions ...FlagOption) *Cmd

func (*Cmd) GuestRunFunc ¶

func (cmd *Cmd) GuestRunFunc(runFunc guestRunFunc) *Cmd

func (*Cmd) HelpFlag ¶

func (cmd *Cmd) HelpFlag(description string, auxOptions ...FlagOption) *Cmd

func (*Cmd) IntFlag ¶

func (cmd *Cmd) IntFlag(name string, defaultValue int, description string, auxOptions ...FlagOption) *Cmd

func (*Cmd) LoggedUserRunFunc ¶

func (cmd *Cmd) LoggedUserRunFunc(runFunc loggedUserRunFunc) *Cmd

func (*Cmd) Long ¶

func (cmd *Cmd) Long(long string) *Cmd

func (*Cmd) ScopeLevel ¶

func (cmd *Cmd) ScopeLevel(scopeLevel ScopeLevel) *Cmd

func (*Cmd) SetHelpTemplate ¶ added in v1.0.5

func (cmd *Cmd) SetHelpTemplate(template string) *Cmd

func (*Cmd) Short ¶

func (cmd *Cmd) Short(short string) *Cmd

func (*Cmd) SilenceError ¶ added in v1.0.8

func (cmd *Cmd) SilenceError(silenceError bool) *Cmd

func (*Cmd) SilenceUsage ¶

func (cmd *Cmd) SilenceUsage(silenceUsage bool) *Cmd

func (*Cmd) StringFlag ¶

func (cmd *Cmd) StringFlag(name string, defaultValue string, description string, auxOptions ...FlagOption) *Cmd

func (*Cmd) Use ¶

func (cmd *Cmd) Use(use string) *Cmd

type CmdParamReader ¶

type CmdParamReader struct {
	// contains filtered or unexported fields
}

func (*CmdParamReader) GetBool ¶

func (r *CmdParamReader) GetBool(name string) bool

func (*CmdParamReader) GetInt ¶

func (r *CmdParamReader) GetInt(name string) int

func (*CmdParamReader) GetString ¶

func (r *CmdParamReader) GetString(name string) string

type FlagOption ¶

type FlagOption = func(cfg *cmdFlag)

func HiddenFlag ¶

func HiddenFlag() FlagOption

func ShortHand ¶

func ShortHand(shorthand string) FlagOption

type GuestCmdData ¶

type GuestCmdData struct {
	CliStorage *cliStorage.Handler
	UxBlocks   uxBlock.UxBlocks
	Args       map[string][]string
	Params     ParamsReader

	PrintHelp func()
}

type LoggedUserCmdData ¶

type LoggedUserCmdData struct {
	*GuestCmdData
	RestApiClient *zeropsRestApiClient.Handler

	// optional params
	Project *entity.Project
	Service *entity.Service

	VpnKeys map[uuid.ProjectId]entity.VpnKey
}

type ParamsReader ¶

type ParamsReader interface {
	GetString(name string) string
	GetInt(name string) int
	GetBool(name string) bool
}

type ScopeLevel ¶

type ScopeLevel interface {
	AddCommandFlags(*Cmd)
	LoadSelectedScope(ctx context.Context, cmd *Cmd, cmdData *LoggedUserCmdData) error
	GetParent() ScopeLevel
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL