API Reference
Complete API reference for the CLI framework.
Packages
- SingleProgram - Single command CLI applications
- MultipleProgram - Multi-command CLI applications
- Interactive - Interactive components API
- Loading - Loading components API
Types
Context
The Context type provides access to command-line flags and arguments.
go
type Context struct {
// ... fields
}Command
The Command type represents a CLI command.
go
type Command struct {
Name string
Usage string
Flags []Flag
Action Action
}Flag Types
StringFlag- String flagIntFlag- Integer flagBoolFlag- Boolean flagStringSliceFlag- String slice flagIntSliceFlag- Integer slice flag
Functions
NewSingleProgram
Creates a new single command program.
go
func NewSingleProgram(cfg *SingleProgramConfig) *SingleProgramNewMultipleProgram
Creates a new multiple command program.
go
func NewMultipleProgram(cfg *MultipleProgramConfig) *MultipleProgram