app

package

v1.0.0 Latest Latest Go to latest Published: Aug 14, 2023 License: Apache-2.0 Imports: 14 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

This section is empty.

This section is empty.

func FormatBaseName(basename string) string

func PrintSections(w io.Writer, fss FlagSets, cols int)

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

func NewApp(name string, basename string, opts ...Option) *App

func (a *App) Run()

type CliOptions interface {
	Flags() (fss FlagSets)
	Validate() []error
}

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

func NewCommand(usage string, desc string, opts ...CommandOption) *Command

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

type CommandOption func(*Command)

func WithCommandOptions(opt CliOptions) CommandOption

func WithCommandRunFunc(run RunCommandFunc) CommandOption

type CompleteableOptions interface {
	Complete() error
}

type FlagSets struct {
	Order []string
	Sets  map[string]*pflag.FlagSet
}

func (fs *FlagSets) FlagSet(name string) *pflag.FlagSet

type Option func(app *App)

func WithDefaultValidArgs() Option

func WithDescription(desc string) Option

func WithNoConfig() Option

func WithOptions(opt CliOptions) Option

func WithRunFunc(run RunFunc) Option

func WithValidArgs(args cobra.PositionalArgs) Option

type RunCommandFunc func(args []string) error

type RunFunc func(basename string) error