Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

cli

package module

Go to main page

Versions in this module

v0

v0.3.1

Jun 21, 2026

v0.3.0

Jun 21, 2026

Changes in this version

type App

+ DefaultCommand func() Command[any]

v0.2.1

Jun 21, 2026

v0.2.0

Jun 12, 2026

v0.1.0

Jun 12, 2026

Changes in this version

+ var ErrCommandNotFound = errors.New("command not found")

+ var ErrDisplaySubCommands = errors.New("print sub commands")

+ var ErrDotenvNotFound = errors.New("dotenv file not found")

+ var ErrNoCommands = errors.New("no commands registered")

+ var ErrShowingHelp = errors.New("showing help")

+ var ErrShowingVersion = errors.New("showing version")

+ var ErrValidationFailed = errors.New("validation failed")

+ func FormatAliases(codec OutputCodec) []string

+ func GetDotEnv(file string) (map[string]string, error)

+ func GetDotEnvs(files ...string) (map[string]string, error)

+ func IsRealError(err error) bool

+ func LoadDotEnv(paths ...string) error

+ type App interface

+ Add func(name string, cmd Command[any]) Command[any]

+ Commands func() []Command[any]

+ Config func() Config

+ Default func(cmd Command[any]) Command[any]

+ Help func(cmd Command[any]) Command[any]

+ HelpOutputs func(formats ...OutputCodec) App

+ OutputFormats func() []OutputCodec

+ Resolve func(resolvers ...Resolver) App

+ Run func(osArgs []string) error

+ func NewApp(config Config, opts GlobalFlags) App

+ type BaseCommand struct

+ Inputs *T

+ func NewBaseCommand[T any]() BaseCommand[T]

+ func (c *BaseCommand[T]) Add(name string, cmd Command[any])

+ func (c *BaseCommand[T]) Args() map[int][]string

+ func (c *BaseCommand[T]) Commands() []Command[any]

+ func (c *BaseCommand[T]) Description() string

+ func (c *BaseCommand[T]) Examples() [][]string

+ func (c *BaseCommand[T]) Flags() map[string][]string

+ func (c *BaseCommand[T]) Name(name string) string

+ func (c *BaseCommand[T]) Options() any

+ func (c *BaseCommand[T]) Validate(options map[string]any) error

+ type Command interface

+ Add func(name string, cmd Command[any])

+ Args func() map[int][]string

+ Commands func() []Command[any]

+ Description func() string

+ Examples func() [][]string

+ Flags func() map[string][]string

+ Help func() string

+ Name func(name string) string

+ Options func() any

+ Run func(options GlobalFlags, unknowns Unknowns) error

+ Validate func(options map[string]any) error

+ type Config struct

+ Name string

+ Version string

+ type GlobalFlags struct

+ Cwd string

+ Help bool

+ HelpFormat string

+ HelpValues bool

+ Version bool

+ type OutputCodec interface

+ Extension func() string

+ Marshal func(v any) ([]byte, error)

+ type Resolver interface

+ Resolve func(cmd string, values map[string]any) (map[string]any, error)

+ type Unknowns struct

+ Args []string

+ Options map[string]any

+ type Verbosity struct

+ V1 bool

+ V2 bool

+ V3 bool

+ func (v Verbosity) AtLeast(level int) bool

+ func (v Verbosity) Level() int

+ func (v Verbosity) Verbose() bool