cli

Documentation

Index

• type Cmd
  • func (c *Cmd[T]) Describe() string
  • func (c *Cmd[T]) Match(args []string) bool
  • func (c *Cmd[T]) Run(args []string) int
• type Example
• type Runable

Types

type Cmd

type Cmd[T any] struct {
	Name        string
	Description string
	Examples    []Example
	Usage       string
	ParseArgs   func([]string) (T, error)
	Fn          func(T) error
	SubCmds     []Runable
}

func (*Cmd[T]) Describe

func (c *Cmd[T]) Describe() string

func (*Cmd[T]) Match

func (c *Cmd[T]) Match(args []string) bool

func (*Cmd[T]) Run

func (c *Cmd[T]) Run(args []string) int

type Example

type Example struct {
	Description string
	Args        []string
	Output      string
	Error       error
}

type Runable

type Runable interface {
	Run([]string) int
	Describe() string
	Match([]string) bool
}