cobrax

package module

Go to main page

Versions in this module

v0

v0.6.0

Sep 16, 2024

Changes in this version

+ func PrintConfigCmd(name string) *cobra.Command

type PrintConfigFormat

+ func (f *PrintConfigFormat) Set(v string) error

+ func (f *PrintConfigFormat) String() string

+ func (f *PrintConfigFormat) Type() string

v0.5.1

Sep 8, 2024

Changes in this version

+ func GenConfigRunE(format PrintConfigFormat) func(cmd *cobra.Command, args []string) error

v0.5.0

Sep 6, 2024

Changes in this version

+ func GetFlags(cmd *cobra.Command) map[string]any

+ func PrintConfig(w io.Writer, m map[string]any, format PrintConfigFormat) error

+ type PrintConfigFormat int

+ const JSON

+ const TOML

+ const YAML

+ type VerbosityLevelOption func(*VerbosityLevelOptions)

+ func WithQuietName(quietName string) VerbosityLevelOption

+ func WithVerbosityName(verboseName string) VerbosityLevelOption

+ func WithVerbosityStep(step int) VerbosityLevelOption

+ func WithVerbosityZeroLevel(level slog.Level) VerbosityLevelOption

+ type VerbosityLevelOptions struct

v0.4.0

Jun 10, 2024

v0.3.1

Apr 15, 2024

v0.3.0

Apr 4, 2024

Changes in this version

+ func BindConfigs(v *viper.Viper, rootCmdName string, opts ...ConfigOption) error

type ConfigOption

+ func WithConfigFileFlag(cmd *cobra.Command, flagName string) ConfigOption

+ func WithConfigFileName(file string) ConfigOption

+ func WithConfigFilePaths(paths ...string) ConfigOption

+ func WithMergeConfig(merge bool) ConfigOption

+ func WithOverrideBy(key string) ConfigOption

+ func WithOverrideDisabled() ConfigOption

+ type ConfigOptions struct

v0.2.0

Mar 21, 2024

Changes in this version

+ var ErrNoFileSpecified = errors.New("no file specified")

+ func WithManualInputEnabled(o *Option)

+ type Option struct

+ type OptionFunc func(*Option)

+ func WithStdin(stdin io.Reader) OptionFunc

v0.1.5

Dec 30, 2023

Changes in this version

+ func SnakeToKebab(f *pflag.FlagSet, name string) pflag.NormalizedName

v0.1.4

Dec 29, 2023

v0.1.3

Dec 29, 2023

Changes in this version

+ var DefaultRootFlagOption = RootFlagOption

+ func NewRootWithOption(v *viper.Viper, option RootFlagOption) *cobra.Command

+ type FlagOption struct

+ Name string

+ Shorthand string

+ Usage string

+ type RootFlagOption struct

+ Config FlagOption

+ NoColor FlagOption

+ Quiet FlagOption

+ Verbose FlagOption

+ Version FlagOption

v0.1.2

Dec 29, 2023

Changes in this version

+ func NewRoot(v *viper.Viper) *cobra.Command

+ func RootPersistentPreRunE(cmd *cobra.Command, v *viper.Viper, args []string) error

+ func VerbosityCount(v *viper.Viper) int

+ func VerbosityLevel(v *viper.Viper) slog.Level

v0.1.1

Dec 29, 2023

Changes in this version

+ func OverrideBySubConfig(v *viper.Viper, key string) error

+ type ConfigBinder struct

+ func NewConfigBinder(cmd *cobra.Command) *ConfigBinder

+ func NewConfigBinderWithOption(cmd *cobra.Command, option ...ConfigOption) *ConfigBinder

+ func (b *ConfigBinder) Bind(v *viper.Viper) error

+ type ConfigOption interface

+ func WithConfigFile(file string) ConfigOption

+ func WithConfigFlagName(name string) ConfigOption

+ func WithGlobalConfigFiles(paths ...string) ConfigOption

+ func WithProjectConfigFiles(paths ...string) ConfigOption

v0.1.0

Dec 29, 2023

Changes in this version

+ func DebugViper(v *viper.Viper) string

+ func OpenOrStdIn(filename string, fs afero.Fs, stdin io.Reader) (io.ReadCloser, error)

+ func ReadConfigFile(v *viper.Viper, cfgFile string, override bool, subCommandName string) error

+ func SetLogger(l *slog.Logger)

+ func VersionFunc() string

v0.0.8

May 3, 2023

v0.0.7

Apr 1, 2023

Changes in this version

+ var Version = ""

type Command

+ UseQuietFlag bool

+ UseVersionFlag bool

v0.0.6

Mar 30, 2023

v0.0.5

Mar 19, 2023

Changes in this version

+ func OnInitialize(y ...Initializer)

type Command

+ func (c *Command) Called() bool

+ func (c *Command) PreExecute()

+ type Initializer func(*Command)

v0.0.4

Mar 10, 2023

v0.0.3

Mar 3, 2023

Changes in this version

type Command

+ func (c *Command) OpenOrStdIn(filename string) (io.ReadCloser, error)

v0.0.2

Feb 28, 2023

Changes in this version

type Command

+ D *log.Logger

+ V *log.Logger

v0.0.1

Feb 22, 2023

Changes in this version

+ type Command struct

+ AutomaticBindViper bool

+ PersistentPostRun func(cmd *Command, args []string)

+ PersistentPostRunE func(cmd *Command, args []string) error

+ PersistentPreRun func(cmd *Command, args []string)

+ PersistentPreRunE func(cmd *Command, args []string) error

+ PostRun func(cmd *Command, args []string)

+ PostRunE func(cmd *Command, args []string) error

+ PreRun func(cmd *Command, args []string)

+ PreRunE func(cmd *Command, args []string) error

+ Run func(cmd *Command, args []string)

+ RunE func(cmd *Command, args []string) error

+ UseConfigFile bool

+ UseDebugLogging bool

+ UseEnv bool

+ func NewCommand() *Command

+ func Wrap(cmd *cobra.Command) *Command

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

+ func (c *Command) BindEnv(input ...string) error

+ func (c *Command) BindFlag(key string) error

+ func (c *Command) BindFlags() error

+ func (c *Command) BindInheritedFlag(key string) error

+ func (c *Command) BindInheritedFlags() error

+ func (c *Command) BindLocalFlag(key string) error

+ func (c *Command) BindLocalFlags() error

+ func (c *Command) BindLocalNonPersistentFlag(key string) error

+ func (c *Command) BindLocalNonPersistentFlags() error

+ func (c *Command) BindNonInheritedFlag(key string) error

+ func (c *Command) BindNonInheritedFlags() error

+ func (c *Command) BindPersistentFlag(key string) error

+ func (c *Command) BindPersistentFlags() error

+ func (c *Command) Commands() []*Command

+ func (c *Command) Debug(msg string)

+ func (c *Command) Debugf(format string, i ...interface{})

+ func (c *Command) Execute() error

+ func (c *Command) ExecuteC() (cmd *cobra.Command, err error)

+ func (c *Command) ExecuteContext(ctx context.Context) error

+ func (c *Command) ExecuteContextC(ctx context.Context) (*cobra.Command, error)

+ func (c *Command) Fs() afero.Fs

+ func (c *Command) PrintOut(i ...interface{})

+ func (c *Command) PrintOutf(format string, i ...interface{})

+ func (c *Command) PrintOutln(i ...interface{})

+ func (c *Command) ReadFileOrStdIn(fileFlag string) (io.ReadCloser, error)

+ func (c *Command) RemoveCommand(cmds ...*Command)

+ func (c *Command) ResetCommands()

+ func (c *Command) Root() *Command

+ func (c *Command) SetFs(fs afero.Fs)

+ func (c *Command) SetViper(v *viper.Viper)

+ func (c *Command) Verbose(msg string)

+ func (c *Command) Verbosef(format string, i ...interface{})

+ func (c *Command) Viper() *viper.Viper

+ func (c *Command) WalkCommands(fn func(*Command))

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