cli

package module

v0.0.1 Latest Latest Go to latest Published: Feb 12, 2024 License: MIT Imports: 4 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/ytils/cli

Links

Open Source Insights

README ¶

cli

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrFailure = errors.New("failure")

ErrFailure can be returned from a command to trigger a non-zero exit code with no extra message.

Functions ¶

func Parse ¶

func Parse[T any]() *T

func ParseExecute ¶

func ParseExecute[T any]() *T

Types ¶

type Commander ¶

type Commander interface {
	Execute(args []string) error
}

Commander is a required interface for CLI commands.

type Initer ¶

type Initer[T any] interface {
	Init(app *T) error
}

Initer is an optional interface for commands that require global flags. The command can read the global values and store them to be later used in Execute.

type Validator ¶

type Validator interface {
	Validate() error
}

Validator is an optional interface for commands that require additional validation of their flags.

Source Files ¶

View all Source files

cli.go

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