rootcmd

package

v0.6.3 Latest Latest Go to latest Published: Mar 27, 2024 License: Apache-2.0 Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package rootcmd provide common functions to hollow binaries and cli set up

This section is empty.

This section is empty.

This section is empty.

type Options struct {
	App         string
	ConfigFile  string
	Debug       bool
	PrettyPrint bool
	// contains filtered or unexported fields
}

Options are the basic setting rootcmd needs or sets

func (o *Options) GetConfigFile() string

GetConfigFile returns the path to the config file

func (o *Options) GetLogger() *zap.SugaredLogger

GetLogger returns the zap.SugarLogger

func (o *Options) InitConfig()

InitConfig reads in config file and ENV variables if set.

func (o *Options) SetupLogging(logger *zap.SugaredLogger)

SetupLogging is a common configuraion of a zap.SugaredLogger, set to the logger passed

type Root struct {
	Cmd     *cobra.Command
	Options *Options
}

Root contains a cobra.Command and options

func NewRootCmd(app, short string) *Root

NewRootCmd returns a

func (r *Root) Execute() error

Execute is a vanity wrapper on cobra.Command.Execute()

func (r *Root) InitFlags()

InitFlags are the 3 common flags for rootcmd

func (r *Root) ViperBindFlag(name, flag string)

ViperBindFlag provides a wrapper around the viper bindings that handles error checks