cmd

package

v0.15.0 Latest Latest Go to latest Published: Feb 21, 2023 License: MIT Imports: 13 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/f110/heimdallr

Links

Open Source Insights

Documentation ¶

Index ¶

type Command
type Flag
- func NewFlag[T flagTypes](name, usage string, setValueFunc func(*FlagValue[T], string) error, ...) *Flag[T]
type FlagSet
- func NewFlagSet(name string, errorHandling pflag.ErrorHandling) *FlagSet
type FlagValue

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Command ¶ added in v0.15.0

type Command struct {
	Use   string
	Short string
	Long  string
	Run   func(ctx context.Context, cmd *Command, args []string) error
	// contains filtered or unexported fields
}

func (*Command) AddCommand ¶ added in v0.15.0

func (c *Command) AddCommand(cmd *Command)

func (*Command) Execute ¶ added in v0.15.0

func (c *Command) Execute(args []string) error

func (*Command) Flags ¶ added in v0.15.0

func (c *Command) Flags() *FlagSet

func (*Command) Name ¶ added in v0.15.0

func (c *Command) Name() string

func (*Command) Usage ¶ added in v0.15.0

func (c *Command) Usage() string

type Flag ¶ added in v0.15.0

type Flag[T flagTypes] struct {
	// contains filtered or unexported fields
}

func NewFlag ¶ added in v0.15.0

func NewFlag[T flagTypes](name, usage string, setValueFunc func(*FlagValue[T], string) error, setDefaultValueFunc func(*pflag.Flag, T) error, toStr func(T) string) *Flag[T]

func (*Flag[T]) Default ¶ added in v0.15.0

func (f *Flag[T]) Default(defaultValue T) *Flag[T]

func (*Flag[T]) Deprecated ¶ added in v0.15.0

func (f *Flag[T]) Deprecated(msg string) *Flag[T]

func (*Flag[_]) Flag ¶ added in v0.15.0

func (f *Flag[_]) Flag() *pflag.Flag

func (*Flag[T]) Hidden ¶ added in v0.15.0

func (f *Flag[T]) Hidden() *Flag[T]

func (*Flag[T]) Required ¶ added in v0.15.0

func (f *Flag[T]) Required() *Flag[T]

func (*Flag[T]) Shorthand ¶ added in v0.15.0

func (f *Flag[T]) Shorthand(p string) *Flag[T]

func (*Flag[T]) ShorthandDeprecated ¶ added in v0.15.0

func (f *Flag[T]) ShorthandDeprecated(msg string) *Flag[T]

func (*Flag[_]) Value ¶ added in v0.15.0

func (f *Flag[_]) Value() string

func (*Flag[T]) Var ¶ added in v0.15.0

func (f *Flag[T]) Var(p *T) *Flag[T]

type FlagSet ¶ added in v0.15.0

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

func NewFlagSet ¶ added in v0.15.0

func NewFlagSet(name string, errorHandling pflag.ErrorHandling) *FlagSet

func (*FlagSet) AddFlagSet ¶ added in v0.15.0

func (fs *FlagSet) AddFlagSet(v *FlagSet)

func (*FlagSet) Args ¶ added in v0.15.0

func (fs *FlagSet) Args() []string

func (*FlagSet) Bool ¶ added in v0.15.0

func (fs *FlagSet) Bool(name, usage string) *Flag[bool]

func (*FlagSet) Copy ¶ added in v0.15.0

func (fs *FlagSet) Copy() *FlagSet

func (*FlagSet) Duration ¶ added in v0.15.0

func (fs *FlagSet) Duration(name, usage string) *Flag[time.Duration]

func (*FlagSet) Float32 ¶ added in v0.15.0

func (fs *FlagSet) Float32(name, usage string) *Flag[float32]

func (*FlagSet) HasFlags ¶ added in v0.15.0

func (fs *FlagSet) HasFlags() bool

func (*FlagSet) Int ¶ added in v0.15.0

func (fs *FlagSet) Int(name, usage string) *Flag[int]

func (*FlagSet) Int64 ¶ added in v0.15.0

func (fs *FlagSet) Int64(name, usage string) *Flag[int64]

func (*FlagSet) Len ¶ added in v0.15.0

func (fs *FlagSet) Len() int

func (*FlagSet) OnelineUsage ¶ added in v0.15.0

func (fs *FlagSet) OnelineUsage(leftPadding, wrap int) string

func (*FlagSet) Parse ¶ added in v0.15.0

func (fs *FlagSet) Parse(args []string) error

func (*FlagSet) String ¶ added in v0.15.0

func (fs *FlagSet) String(name, usage string) *Flag[string]

func (*FlagSet) StringArray ¶ added in v0.15.0

func (fs *FlagSet) StringArray(name, usage string) *Flag[[]string]

func (*FlagSet) Uint ¶ added in v0.15.0

func (fs *FlagSet) Uint(name, usage string) *Flag[uint]

func (*FlagSet) Usage ¶ added in v0.15.0

func (fs *FlagSet) Usage() string

type FlagValue ¶ added in v0.15.0

type FlagValue[T flagTypes] struct {
	// contains filtered or unexported fields
}

func (*FlagValue[T]) Set ¶ added in v0.15.0

func (f *FlagValue[T]) Set(val string) error

func (*FlagValue[T]) String ¶ added in v0.15.0

func (f *FlagValue[T]) String() string

func (*FlagValue[T]) Type ¶ added in v0.15.0

func (f *FlagValue[T]) Type() string

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
dashboard
discovery
heimctl
heimdev
operator
release
reverseproxy
rpcserver
tunnel

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