cobrautil

Documentation

Index

• func AddConfigFileForEachCommand(cmd *cobra.Command, g templates.FlagGroups, configFileFlagName string)
• func BindAll(cmd *cobra.Command, envPrefix, configFileFlagName string, opts ...ViperOpt) error
• func BindFromViper(cmd *cobra.Command, v *viper.Viper) error
• func FullCommandName(cmd *cobra.Command) string
• func FullCommandNameTitle(cmd *cobra.Command) string
• func WriteConfigFile(w io.Writer, g templates.FlagGroups, configFileFlagName string, ...)
• func WriteMarkdownDoc(w io.Writer, g templates.FlagGroups, envPrefix string, cmd *cobra.Command)
• type DescribeFormat
• type FlagsDescriber
  • func (d FlagsDescriber) DescribeFlags(fs *pflag.FlagSet) ([]byte, error)
• type ViperOpt

Functions

func AddConfigFileForEachCommand

func AddConfigFileForEachCommand(cmd *cobra.Command, g templates.FlagGroups, configFileFlagName string)

func BindAll

func BindAll(cmd *cobra.Command, envPrefix, configFileFlagName string, opts ...ViperOpt) error

BindAll updates the given command flags with values from the environment variables and config file. The supported formats are: JSON, YAML, TOML, HCL, and Java properties. The file format is determined by the file extension, if not specified the default format is YAML. The following precedence order of configuration sources is used: command flags, environment variables, config file, default values.

func BindFromViper

func BindFromViper(cmd *cobra.Command, v *viper.Viper) error

BindFromViper updates the given command flags with values from preconditioned Viper instance.

func FullCommandName

func FullCommandName(cmd *cobra.Command) string

FullCommandName returns the full name of the command from the root command.

func FullCommandNameTitle

func FullCommandNameTitle(cmd *cobra.Command) string

FullCommandNameTitle returns the full name of the command from the root command with the first letter of each word capitalized.

func WriteConfigFile

func WriteConfigFile(w io.Writer, g templates.FlagGroups, configFileFlagName string, fs *pflag.FlagSet)

func WriteMarkdownDoc

func WriteMarkdownDoc(w io.Writer, g templates.FlagGroups, envPrefix string, cmd *cobra.Command)

Types

type DescribeFormat

type DescribeFormat int

const (
	Plain DescribeFormat = iota
	JSON
	YAML
)

type FlagsDescriber

type FlagsDescriber struct {
	Format          DescribeFormat
	Unredacted      bool
	ShowChangedOnly bool
	ShowHidden      bool
}

func (FlagsDescriber) DescribeFlags

func (d FlagsDescriber) DescribeFlags(fs *pflag.FlagSet) ([]byte, error)

type ViperOpt

type ViperOpt func(*viper.Viper)