cli

Jan 16, 2025

Changes in this version

type BoolVar

+ AllowFromFile bool

+ AllowFromPrompt bool

type DurationVar

+ AllowFromFile bool

+ AllowFromPrompt bool

type Float64Var

+ AllowFromFile bool

+ AllowFromPrompt bool

type Int64Var

+ AllowFromFile bool

+ AllowFromPrompt bool

type IntVar

+ AllowFromFile bool

+ AllowFromPrompt bool

type LogLevelVar

+ AllowFromFile bool

+ AllowFromPrompt bool

type Option

+ func WithPromptAll(fn PromptAllFunc) Option

+ func WithWorkingDir(fn WorkingDirFunc) Option

+ type PromptAllFunc = func(ctx context.Context, msg string, args ...any) (string, error)

type StringMapVar

+ AllowFromFile bool

+ AllowFromPrompt bool

type StringSliceVar

+ AllowFromFile bool

+ AllowFromPrompt bool

type StringVar

+ AllowFromFile bool

+ AllowFromPrompt bool

type TimeVar

+ AllowFromFile bool

+ AllowFromPrompt bool

type Uint64Var

+ AllowFromFile bool

+ AllowFromPrompt bool

type UintVar

+ AllowFromFile bool

+ AllowFromPrompt bool

type Var

+ AllowFromFile bool

+ AllowFromPrompt bool

+ type WorkingDirFunc = func() (string, error)

Aug 17, 2023

Changes in this version

type FlagSection

+ func (f *FlagSection) LogLevelVar(i *LogLevelVar)

+ type LogLevelVar struct

+ Logger *slog.Logger

Aug 16, 2023

Changes in this version

type BaseCommand

+ func (c *BaseCommand) PromptAll(ctx context.Context, msg string, args ...any) (string, error)

+ func (c *BaseCommand) PromptTo(ctx context.Context, splitFunc bufio.SplitFunc, msg string, args ...any) (string, error)

Jul 26, 2023

Changes in this version

+ type AfterParseFunc func(existingErr error) error

type BaseCommand

+ func (c *BaseCommand) GetEnv(key string) string

+ func (c *BaseCommand) LookupEnv(key string) (string, bool)

+ func (c *BaseCommand) NewFlagSet(opts ...Option) *FlagSet

+ func (c *BaseCommand) SetLookupEnv(fn LookupEnvFunc)

type FlagSet

+ func (f *FlagSet) AfterParse(fn AfterParseFunc)

+ func (f *FlagSet) Arg(i int) string

+ func (f *FlagSet) GetEnv(k string) string

+ func (f *FlagSet) Lookup(name string) *flag.Flag

+ func (f *FlagSet) LookupEnv(k string) (string, bool)

type LookupEnvFunc

+ func MultiLookuper(fns ...LookupEnvFunc) LookupEnvFunc

Jul 19, 2023

Changes in this version

type BaseCommand

+ func (c *BaseCommand) ExecutablePath() (string, error)

+ func (c *BaseCommand) WorkingDir() (string, error)

type Command

+ ExecutablePath func() (string, error)

+ WorkingDir func() (string, error)

Jun 11, 2023

Changes in this version

+ type ArgPredictor interface

+ PredictArgs func() complete.Predictor

type BaseCommand

+ func (c *BaseCommand) Errf(format string, a ...any)

+ func (c *BaseCommand) Outf(format string, a ...any)

type BoolVar

+ Predict complete.Predictor

type Command

+ Errf func(format string, a ...any)

+ Outf func(format string, a ...any)

type DurationVar

+ Predict complete.Predictor

type FlagSection

+ func (f *FlagSection) TimeVar(layout string, i *TimeVar)

type Float64Var

+ Predict complete.Predictor

type Int64Var

+ Predict complete.Predictor

type IntVar

+ Predict complete.Predictor

type StringMapVar

+ Predict complete.Predictor

type StringSliceVar

+ Predict complete.Predictor

type StringVar

+ Predict complete.Predictor

+ type TimeVar struct

+ Aliases []string

+ Default time.Time

+ EnvVar string

+ Example string

+ Hidden bool

+ Name string

+ Predict complete.Predictor

+ Target *time.Time

+ Usage string

type Uint64Var

+ Predict complete.Predictor

type UintVar

+ Predict complete.Predictor

type Value

+ Predictor func() complete.Predictor

type Var

+ Predict complete.Predictor

Mar 23, 2023

Changes in this version

+ func Flag(f *FlagSection, i *Var[T])

+ type BaseCommand struct

+ func (c *BaseCommand) Flags() *FlagSet

+ func (c *BaseCommand) Hidden() bool

+ func (c *BaseCommand) Pipe() (stdin, stdout, stderr *bytes.Buffer)

+ func (c *BaseCommand) Prompt(msg string) (string, error)

+ func (c *BaseCommand) SetStderr(w io.Writer)

+ func (c *BaseCommand) SetStdin(r io.Reader)

+ func (c *BaseCommand) SetStdout(w io.Writer)

+ func (c *BaseCommand) Stderr() io.Writer

+ func (c *BaseCommand) Stdin() io.Reader

+ func (c *BaseCommand) Stdout() io.Writer

+ type BoolVar struct

+ Aliases []string

+ Default bool

+ EnvVar string

+ Example string

+ Hidden bool

+ Name string

+ Target *bool

+ Usage string

+ type Command interface

+ Desc func() string

+ Flags func() *FlagSet

+ Help func() string

+ Hidden func() bool

+ Pipe func() (stdin, stdout, stderr *bytes.Buffer)

+ Prompt func(msg string) (string, error)

+ Run func(ctx context.Context, args []string) error

+ SetStderr func(w io.Writer)

+ SetStdin func(r io.Reader)

+ SetStdout func(w io.Writer)

+ Stderr func() io.Writer

+ Stdin func() io.Reader

+ Stdout func() io.Writer

+ type CommandFactory func() Command

+ type DurationVar struct

+ Aliases []string

+ Default time.Duration

+ EnvVar string

+ Example string

+ Hidden bool

+ Name string

+ Target *time.Duration

+ Usage string

+ type FlagSection struct

+ func (f *FlagSection) BoolVar(i *BoolVar)

+ func (f *FlagSection) DurationVar(i *DurationVar)

+ func (f *FlagSection) Float64Var(i *Float64Var)

+ func (f *FlagSection) Int64Var(i *Int64Var)

+ func (f *FlagSection) IntVar(i *IntVar)

+ func (f *FlagSection) StringMapVar(i *StringMapVar)

+ func (f *FlagSection) StringSliceVar(i *StringSliceVar)

+ func (f *FlagSection) StringVar(i *StringVar)

+ func (f *FlagSection) Uint64Var(i *Uint64Var)

+ func (f *FlagSection) UintVar(i *UintVar)

+ type FlagSet struct

+ func NewFlagSet(opts ...Option) *FlagSet

+ func (f *FlagSet) Args() []string

+ func (f *FlagSet) Help() string

+ func (f *FlagSet) NewSection(name string) *FlagSection

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

+ func (f *FlagSet) Parsed() bool

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

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

+ type Float64Var struct

+ Aliases []string

+ Default float64

+ EnvVar string

+ Example string

+ Hidden bool

+ Name string

+ Target *float64

+ Usage string

+ type Int64Var struct

+ Aliases []string

+ Default int64

+ EnvVar string

+ Example string

+ Hidden bool

+ Name string

+ Target *int64

+ Usage string

+ type IntVar struct

+ Aliases []string

+ Default int

+ EnvVar string

+ Example string

+ Hidden bool

+ Name string

+ Target *int

+ Usage string

+ type LookupEnvFunc = func(string) (string, bool)

+ func MapLookuper(m map[string]string) LookupEnvFunc

+ type Option func(fs *FlagSet) *FlagSet

+ func WithLookupEnv(fn LookupEnvFunc) Option

+ type ParserFunc func(val string) (T, error)

+ type PrinterFunc func(cur T) string

+ type RootCommand struct

+ Commands map[string]CommandFactory

+ Description string

+ Hide bool

+ Name string

+ Version string

+ func (r *RootCommand) Desc() string

+ func (r *RootCommand) Help() string

+ func (r *RootCommand) Hidden() bool

+ func (r *RootCommand) Run(ctx context.Context, args []string) error

+ type SetterFunc func(cur *T, val T)

+ type StringMapVar struct

+ Aliases []string

+ Default map[string]string

+ EnvVar string

+ Example string

+ Hidden bool

+ Name string

+ Target *map[string]string

+ Usage string

+ type StringSliceVar struct

+ Aliases []string

+ Default []string

+ EnvVar string

+ Example string

+ Hidden bool

+ Name string

+ Target *[]string

+ Usage string

+ type StringVar struct

+ Aliases []string

+ Default string

+ EnvVar string

+ Example string

+ Hidden bool

+ Name string

+ Target *string

+ Usage string

+ type Uint64Var struct

+ Aliases []string

+ Default uint64

+ EnvVar string

+ Example string

+ Hidden bool

+ Name string

+ Target *uint64

+ Usage string

+ type UintVar struct

+ Aliases []string

+ Default uint

+ EnvVar string

+ Example string

+ Hidden bool

+ Name string

+ Target *uint

+ Usage string

+ type Value interface

+ Aliases func() []string

+ Example func() string

+ Get func() any

+ Hidden func() bool

+ IsBoolFlag func() bool

+ type Var struct

+ Aliases []string

+ Default T

+ EnvVar string

+ Example string

+ Hidden bool

+ IsBool bool

+ Name string

+ Parser ParserFunc[T]

+ Printer PrinterFunc[T]

+ Setter SetterFunc[T]

+ Target *T

+ Usage string