flagger

README

Flagger

English | 中文

Flagger is a library based on Viper and Pflag for structured parameter handling.

Usage

go get github.com/robotism/flagger

Example Usage example/cmd/root.go

• Parameter Struct

  type AppConfig struct {
      Debug    bool   `mapstructure:"debug" short:"d" description:"debug mode" default:"false"`
      Timezone string `mapstructure:"timezone" description:"timezone" default:"UTC"`
      Server Server `mapstructure:"server" group:"server"`
      Database map[string]Database `mapstructure:"database" group:"database" mapkey:"<dbkey>"`
  }
  
  type Server struct {
      Port int `mapstructure:"port" description:"port" default:"8080"`
  }
  
  type Database struct {
      Host string `mapstructure:"host" description:"host" default:"localhost"`
      Port int    `mapstructure:"port" description:"port" default:"3306"`
      User string `mapstructure:"user" description:"user" default:"root"`
      Pass string `mapstructure:"pass" description:"pass"`
  }
  

• Command Initialization

  package cmd
  
  import (
      "log"
      "os"
  
      "github.com/robotism/flagger"
      "github.com/robotism/flagger/example/config"
      "github.com/spf13/cobra"
  )
  
  var (
      f = flagger.New()
      c = &config.AppConfig{}
  )
  
  // rootCmd represents the base command when called without any subcommands
  var rootCmd = &cobra.Command{
      Use:   "example",
      Short: "a flagger example",
      Long:  `a flagger example`,
      Run: func(cmd *cobra.Command, args []string) {
          log.Printf("%+v\n", c)
      },
  }
  
  func Execute() {
      err := rootCmd.Execute()
      if err != nil {
          os.Exit(1)
      }
  }
  
  func init() {
      f.UseFlags(rootCmd.Flags())
      f.UseConfigFileArgDefault()
      f.Parse(c)
  }
  

• Run: Display Help

  > go run main.go -h
  
  a flagger example
  
  Usage:
  example [flags]
  
  Flags:
  -c, --config string                  config file path
      --database.<dbkey>.host string   host (default "localhost")
      --database.<dbkey>.pass string   pass
      --database.<dbkey>.port int      port (default 3306)
      --database.<dbkey>.user string   user (default "root")
  -d, --debug                          debug mode
  -h, --help                           help for example
      --server.port int                port (default 8080)
      --timezone string                timezone (default "UTC")
  
  

• Run: Use Environment Variables and Command Line Parameters

  > set SERVER_PORT=9999
  > go run main.go -d=true --timezone=Asia/Shanghai --database.default.host=127.0.0.1
  
  2025/02/20 14:07:31 &{Debug:true Timezone:Asia/Shanghai Server:{Port:9999} Database:map[default:{Host:127.0.0.1 Port:3306 User:root Pass:}]}
  

• Run: Use Configuration File

  go run main.go -d=true --timezone=Asia/Shanghai --database.default.host=127.0.0.1 -c config.yaml
  
  2025/02/20 14:07:59 &{Debug:true Timezone:Asia/Shanghai Server:{Port:9999} Database:map[default:{Host:127.0.0.1 Port:4000 User:root Pass:12345678}]}
  
  go run main.go -c config.yaml
  
  2025/02/20 14:08:14 &{Debug:true Timezone:UTC Server:{Port:9999} Database:map[default:{Host:xxx.xxx.xxx.xxx Port:4000 User:root Pass:12345678}]}
  

Loading Priority:

• Command Line Flags (Flags): If a configuration option is provided via the command line, the value from the command line will take precedence.
• Environment Variables: If the configuration option is not provided via the command line, it will attempt to retrieve the value from environment variables.
• Configuration File: If the configuration option is not found in environment variables, it will load from the configuration file.
• Default Values: If none of the above methods provide the value, the default value set in the code will be used.

Documentation

Overview

Package flagger provides a library for structuring parameters in Go.

Index

• Constants
• type Flagger
  • func New() *Flagger
  • func (f *Flagger) BindEnv(in ...string)
  • func (f *Flagger) GetFlags() *pflag.FlagSet
  • func (f *Flagger) GetMapkey() string
  • func (f *Flagger) GetViper() *viper.Viper
  • func (f *Flagger) Parse(o interface{}, args ...string) error
  • func (f *Flagger) UseConfigFileArg(argNameLong, argNameShort, defaultFileName string)
  • func (f *Flagger) UseConfigFileArgDefault()
  • func (f *Flagger) UseConfigFileName(name string)
  • func (f *Flagger) UseConfigPath(dirs ...string)
  • func (f *Flagger) UseConfigPathDefault()
  • func (f *Flagger) UseConfigType(configType string)
  • func (f *Flagger) UseConfigTypeYaml()
  • func (f *Flagger) UseEnvKeyReplacer(replacer *strings.Replacer)
  • func (f *Flagger) UseEnvPrefix(prefix string)
  • func (f *Flagger) UseFlags(fs *pflag.FlagSet)
  • func (f *Flagger) UseMapKey(mapkey string)
  • func (f *Flagger) UseViper(v *viper.Viper)

Constants

const (
	DEFAULT_MAPKEY = "<mapkey>"
)

Types

type Flagger

type Flagger struct {
	// contains filtered or unexported fields
}

func New

func New() *Flagger

func (*Flagger) BindEnv

func (f *Flagger) BindEnv(in ...string)

func (*Flagger) GetFlags

func (f *Flagger) GetFlags() *pflag.FlagSet

func (*Flagger) GetMapkey

func (f *Flagger) GetMapkey() string

func (*Flagger) GetViper

func (f *Flagger) GetViper() *viper.Viper

func (*Flagger) Parse

func (f *Flagger) Parse(o interface{}, args ...string) error

func (*Flagger) UseConfigFileArg

func (f *Flagger) UseConfigFileArg(argNameLong, argNameShort, defaultFileName string)

func (*Flagger) UseConfigFileArgDefault

func (f *Flagger) UseConfigFileArgDefault()

func (*Flagger) UseConfigFileName

func (f *Flagger) UseConfigFileName(name string)

func (*Flagger) UseConfigPath

func (f *Flagger) UseConfigPath(dirs ...string)

func (*Flagger) UseConfigPathDefault

func (f *Flagger) UseConfigPathDefault()

func (*Flagger) UseConfigType

func (f *Flagger) UseConfigType(configType string)

func (*Flagger) UseConfigTypeYaml

func (f *Flagger) UseConfigTypeYaml()

func (*Flagger) UseEnvKeyReplacer

func (f *Flagger) UseEnvKeyReplacer(replacer *strings.Replacer)

func (*Flagger) UseEnvPrefix

func (f *Flagger) UseEnvPrefix(prefix string)

func (*Flagger) UseFlags

func (f *Flagger) UseFlags(fs *pflag.FlagSet)

func (*Flagger) UseMapKey

func (f *Flagger) UseMapKey(mapkey string)

func (*Flagger) UseViper

func (f *Flagger) UseViper(v *viper.Viper)