cli

package

Go to main page

Versions in this module

v0

v0.1.18

Dec 11, 2025

v0.1.17

Dec 10, 2025

v0.1.16

Nov 25, 2025

v0.1.15

Nov 21, 2025

Changes in this version

+ var SingleLongFlagError = "flag -%s is a long flag, use --%s instead"

type CLI

+ func (c *CLI) OutputErrHelp(err error)

v0.1.14

Nov 20, 2025

Changes in this version

+ const CommandSortAdded

+ const CommandSortAlphaAsc

+ const CommandSortAlphaDesc

type CLI

+ Hidden bool

+ Raw bool

+ func (c *CLI) IsCompleteFlag(arg string) bool

+ func (c *CLI) IsCompleteFlagInContext(arg string, args []string) bool

+ type FlagItem struct

+ Nodes []FlagItemNode

+ Type FlagType

+ func NewFlagItemDir() FlagItem

+ func NewFlagItemFile() FlagItem

+ func NewFlagItemSelect(nodes ...FlagItemNode) FlagItem

+ func NewFlagItemSelectString(value ...string) FlagItem

+ func (f FlagItem) String() string

+ type FlagItemNode struct

+ Description string

+ Value string

+ func NewFlagItemNode(value string, description string) FlagItemNode

type FlagSet

+ Item map[*ShortLongValue]FlagItem

+ ShortLongMap map[string]*ShortLongValue

+ func (f *FlagSet) Bool(name string, value bool, usage string, item ...FlagItem) *bool

+ func (f *FlagSet) BoolVar(p *bool, name string, value bool, usage string, item ...FlagItem)

+ func (f *FlagSet) Duration(name string, value time.Duration, usage string, item ...FlagItem) *time.Duration

+ func (f *FlagSet) DurationVar(p *time.Duration, name string, value time.Duration, usage string, ...)

+ func (f *FlagSet) Float64(name string, value float64, usage string, item ...FlagItem) *float64

+ func (f *FlagSet) Float64Var(p *float64, name string, value float64, usage string, item ...FlagItem)

+ func (f *FlagSet) Int(name string, value int, usage string, item ...FlagItem) *int

+ func (f *FlagSet) Int64(name string, value int64, usage string, item ...FlagItem) *int64

+ func (f *FlagSet) Int64Var(p *int64, name string, value int64, usage string, item ...FlagItem)

+ func (f *FlagSet) IntVar(p *int, name string, value int, usage string, item ...FlagItem)

+ func (f *FlagSet) Parse(arguments []string) error

+ func (f *FlagSet) String(name string, value string, usage string, item ...FlagItem) *string

+ func (f *FlagSet) StringVar(p *string, name string, value string, usage string, item ...FlagItem)

+ func (f *FlagSet) Uint(name string, value uint, usage string, item ...FlagItem) *uint

+ func (f *FlagSet) Uint64(name string, value uint64, usage string, item ...FlagItem) *uint64

+ func (f *FlagSet) Uint64Var(p *uint64, name string, value uint64, usage string, item ...FlagItem)

+ func (f *FlagSet) UintVar(p *uint, name string, value uint, usage string, item ...FlagItem)

+ type FlagType uint8

+ const FlagItemDir

+ const FlagItemFile

+ const FlagItemSelect

+ type SubCommands struct

+ func (s *SubCommands) Add(cli ...*CLI) error

+ func (s *SubCommands) CloneList() []*CLI

+ func (s *SubCommands) Get(use string) *CLI

+ func (s *SubCommands) GetSort() commandSort

+ func (s *SubCommands) Len() int

+ func (s *SubCommands) Range(f func(cli *CLI) bool)

+ func (s *SubCommands) SetSort(sort commandSort)

v0.1.13

Oct 15, 2025

Changes in this version

+ func Alias(alias, original string)

+ func BoolShortLong(short, long string, value bool, usage string) *bool

+ func BoolVarShortLong(p *bool, short, long string, value bool, usage string)

+ func DurationShortLong(short, long string, value time.Duration, usage string) *time.Duration

+ func DurationVarShortLong(p *time.Duration, short, long string, value time.Duration, usage string)

+ func Float64ShortLong(short, long string, value float64, usage string) *float64

+ func Float64VarShortLong(p *float64, short, long string, value float64, usage string)

+ func Int64ShortLong(short, long string, value int64, usage string) *int64

+ func Int64VarShortLong(p *int64, short, long string, value int64, usage string)

+ func IntShortLong(short, long string, value int, usage string) *int

+ func IntVarShortLong(p *int, short, long string, value int, usage string)

+ func PasswordStringShortLong(short, long string, value string, usage string, showNum ...int) *string

+ func PasswordStringVarShortLong(p *string, short, long string, value string, usage string, showNum ...int)

+ func StringShortLong(short, long string, value string, usage string) *string

+ func StringVarShortLong(p *string, short, long string, value string, usage string)

+ func Strings(name string, value []string, usage string) *[]string

+ func StringsShortLong(short, long string, value []string, usage string) *[]string

+ func StringsVar(p *[]string, name string, value []string, usage string)

+ func StringsVarShortLong(p *[]string, short, long string, value []string, usage string)

+ func Uint64ShortLong(short, long string, value uint64, usage string) *uint64

+ func Uint64VarShortLong(p *uint64, short, long string, value uint64, usage string)

+ func UintShortLong(short, long string, value uint, usage string) *uint

+ func UintVarShortLong(p *uint, short, long string, value uint, usage string)

type FlagSet

+ func (f *FlagSet) Alias(alias, original string)

+ func (f *FlagSet) BoolShortLong(short, long string, value bool, usage string) *bool

+ func (f *FlagSet) BoolVarShortLong(p *bool, short, long string, value bool, usage string)

+ func (f *FlagSet) DurationShortLong(short, long string, value time.Duration, usage string) *time.Duration

+ func (f *FlagSet) DurationVarShortLong(p *time.Duration, short, long string, value time.Duration, usage string)

+ func (f *FlagSet) Float64ShortLong(short, long string, value float64, usage string) *float64

+ func (f *FlagSet) Float64VarShortLong(p *float64, short, long string, value float64, usage string)

+ func (f *FlagSet) Int64ShortLong(short, long string, value int64, usage string) *int64

+ func (f *FlagSet) Int64VarShortLong(p *int64, short, long string, value int64, usage string)

+ func (f *FlagSet) IntShortLong(short, long string, value int, usage string) *int

+ func (f *FlagSet) IntVarShortLong(p *int, short, long string, value int, usage string)

+ func (f *FlagSet) PasswordStringShortLong(short, long string, value string, usage string, showNum ...int) *string

+ func (f *FlagSet) PasswordStringVarShortLong(p *string, short, long string, value string, usage string, showNum ...int)

+ func (f *FlagSet) PrintDefaults()

+ func (f *FlagSet) StringShortLong(short, long string, value string, usage string) *string

+ func (f *FlagSet) StringVarShortLong(p *string, short, long string, value string, usage string)

+ func (f *FlagSet) Strings(name string, value []string, usage string) *[]string

+ func (f *FlagSet) StringsShortLong(short, long string, value []string, usage string) *[]string

+ func (f *FlagSet) StringsVar(p *[]string, name string, value []string, usage string)

+ func (f *FlagSet) StringsVarShortLong(p *[]string, short, long string, value []string, usage string)

+ func (f *FlagSet) Uint64ShortLong(short, long string, value uint64, usage string) *uint64

+ func (f *FlagSet) Uint64VarShortLong(p *uint64, short, long string, value uint64, usage string)

+ func (f *FlagSet) UintShortLong(short, long string, value uint, usage string) *uint

+ func (f *FlagSet) UintVarShortLong(p *uint, short, long string, value uint, usage string)

+ type PasswordValue struct

+ func (p *PasswordValue) Get() any

+ func (p *PasswordValue) Set(s string) error

+ func (p *PasswordValue) String() string

+ type ShortLongValue struct

+ LongName string

+ ShortName string

+ Value flag.Value

+ func (sl *ShortLongValue) Get() any

+ func (sl *ShortLongValue) GetNames() string

+ func (sl *ShortLongValue) Set(s string) error

+ func (sl *ShortLongValue) String() string

+ type StringsValue []string

+ func (s *StringsValue) Get() any

+ func (s *StringsValue) Set(value string) error

+ func (s *StringsValue) String() string

v0.1.12

Oct 14, 2025

Changes in this version

+ func PasswordString(name string, value string, usage string, showNum ...int) *string

+ func PasswordStringVar(p *string, name string, value string, usage string, showNum ...int)

+ type FlagSet struct

+ func (f *FlagSet) PasswordString(name string, value string, usage string, showNum ...int) *string

+ func (f *FlagSet) PasswordStringVar(p *string, name string, value string, usage string, showNum ...int)

v0.1.11

Oct 10, 2025

Changes in this version

type CLI

+ Usage string

v0.1.10

Oct 9, 2025

Changes in this version

+ func AddCommand(cli ...*CLI) error

+ func Args() []string

+ func Bool(name string, value bool, usage string) *bool

+ func BoolFunc(name, usage string, fn func(string) error)

+ func BoolVar(p *bool, name string, value bool, usage string)

+ func Duration(name string, value time.Duration, usage string) *time.Duration

+ func DurationVar(p *time.Duration, name string, value time.Duration, usage string)

+ func Float64(name string, value float64, usage string) *float64

+ func Float64Var(p *float64, name string, value float64, usage string)

+ func Func(name, usage string, fn func(string) error)

+ func Int(name string, value int, usage string) *int

+ func Int64(name string, value int64, usage string) *int64

+ func Int64Var(p *int64, name string, value int64, usage string)

+ func IntVar(p *int, name string, value int, usage string)

+ func Lookup(name string) *flag.Flag

+ func NArg() int

+ func Parse() error

+ func Parsed() bool

+ func Run() error

+ func Set(name, value string) error

+ func String(name string, value string, usage string) *string

+ func StringVar(p *string, name string, value string, usage string)

+ func TextVar(p encoding.TextUnmarshaler, name string, value encoding.TextMarshaler, ...)

+ func Uint(name string, value uint, usage string) *uint

+ func Uint64(name string, value uint64, usage string) *uint64

+ func Uint64Var(p *uint64, name string, value uint64, usage string)

+ func UintVar(p *uint, name string, value uint, usage string)

+ func Var(p flag.Value, name string, usage string)

+ func Visit(fn func(*flag.Flag))

+ func VisitAll(fn func(*flag.Flag))

+ type CLI struct

+ CommandFunc CommandFunc

+ Instruction string

+ SubCommands map[string]*CLI

+ Use string

+ var CommandLine *CLI

+ func NewCLI(use, instruction string, errorHandling flag.ErrorHandling) *CLI

+ func (c *CLI) AddCommand(cli ...*CLI) error

+ func (c *CLI) Help()

+ func (c *CLI) Parse(arguments []string) error

+ func (c *CLI) Run(arguments []string) error

+ type CommandFunc func(args []string) error

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