jcli

Apr 10, 2024

Changes in this version

+ type FlagPrinter interface

+ Printf func(template string, args ...interface{})

type Option

+ func EnableSilence() Option

+ func WithFlagPrinter(printer FlagPrinter) Option

Sep 25, 2023

Changes in this version

type App

+ func (a *App) Logger() Logger

+ func (a *App) PrintWorkingDir()

type CommandOption

+ func EnableCommandCompletion(hidden bool) CommandOption

+ type Logger interface

+ Debug func(msg string, keysAndValues ...interface{})

+ Debugf func(template string, args ...interface{})

+ Error func(msg string, keysAndValues ...interface{})

+ Errorf func(template string, args ...interface{})

+ Fatal func(msg string, keysAndValues ...interface{})

+ Fatalf func(template string, args ...interface{})

+ Info func(msg string, keysAndValues ...interface{})

+ Infof func(template string, args ...interface{})

+ Warn func(msg string, keysAndValues ...interface{})

+ Warnf func(template string, args ...interface{})

type Option

+ func EnableCompletion(hidden bool) Option

+ func WithLogger(logger Logger) Option

Aug 12, 2023

Changes in this version

type CommandOption

+ func EnableCommandVersion() CommandOption

Aug 11, 2023

Changes in this version

type CommandOption

+ func EnableVersion() CommandOption

Aug 11, 2023

Changes in this version

type CommandOption

+ func WithCommandExamples(examples string) CommandOption

type Option

+ func WithExamples(examples string) Option

Aug 8, 2023

Changes in this version

type Command

+ func (c *Command) Flags() *pflag.FlagSet

+ func (c *Command) MarkHidden(flags ...string)

Aug 7, 2023

Changes in this version

type Command

+ func (c *Command) Name() string

Aug 6, 2023

Changes in this version

type Command

+ func (c *Command) Help() error

+ func (c *Command) Run()

Jul 11, 2023

Changes in this version

type Option

+ func WithOnSignalReceived(receiver func(os.Signal), signals ...os.Signal) Option

+ type SignalReceiver func(os.Signal)

Jul 10, 2023

Changes in this version

+ func SetupSignalHandler(signals ...os.Signal) <-chan struct

Jul 9, 2023

Changes in this version

type Option

+ func DisableCommandSorting() Option

May 11, 2023

Changes in this version

type Command

+ func (c *Command) CobraCommand() *cobra.Command

May 9, 2023

Changes in this version

+ func IconBlue(msg string) string

type CommandOption

+ func WithCommandDesc(desc string) CommandOption

May 8, 2023

Changes in this version

+ func PrintWorkingDir()

type App

+ func (a *App) AddCobraCommands(commands ...*cobra.Command)

+ type Command struct

+ func NewCommand(name string, desc string, opts ...CommandOption) *Command

+ func (c *Command) AddCobraCommands(commands ...*cobra.Command)

+ func (c *Command) AddCommands(commands ...*Command)

+ type CommandOption interface

+ func WithCommandAliases(aliases ...string) CommandOption

+ func WithCommandCliOptions(opts CliOptions) CommandOption

+ func WithCommandRunFunc(run RunCommandFunc) CommandOption

type Option

+ func WithAliases(aliases ...string) Option

+ type RunCommandFunc func(args []string) error

May 7, 2023

Changes in this version

+ const ConfigFlagName

+ const FlagSetNameGlobal

+ func Blue(msg string) string

+ func Colorize(msg string, attrs ...color.Attribute) string

+ func Green(msg string) string

+ func NormalizeCliName(basename string) string

+ func Red(msg string) string

+ func Yellow(msg string) string

+ type App struct

+ func New(name string, opts ...Option) *App

+ func (a *App) AddCommands(commands ...*cobra.Command)

+ func (a *App) Command() *cobra.Command

+ func (a *App) Run()

+ type CliOptions interface

+ Flags func() (fss cliflag.NamedFlagSets)

+ Validate func() []error

+ type CompletableOptions interface

+ Complete func() error

+ type Option interface

+ func DisableConfig() Option

+ func DisableVersion() Option

+ func WithBaseName(basename string) Option

+ func WithCliOptions(opts CliOptions) Option

+ func WithDesc(desc string) Option

+ func WithRunFunc(run RunFunc) Option

+ func WithSilence() Option

+ func WithSortFlags(v bool) Option

+ type PrintableOptions interface

+ String func() string

+ type RunFunc func() error