README
¶
flags
Golang flags parser with zero dependency.
Usage
See simple.go for basic usage.
Concept
flags gives a simple way to get flag's value from argument or environment variable.
Argument takes priority over environment variable. Argument and environment variable names are generated from configuration you pass.
The FlagSet name is used to prefix all environment variable, replacing - by _.
The prefix name is used then to specialize your flag name (e.g. if you have want to use the same flags twice, you can change the prefix)
The argument's name is in camelCase format. The environement variable name is in SNAKE_UPPER_CASE format.
Flags can take a default value, that can be overriden programatically, always in the case you reuse the same flags twice (see advanced.go example.)
Security
Be careful when using the arguments values, if someone list the processes on the system, they will appear in plain-text. Pass secrets by environment variables: it's less easily visible.
Documentation
¶
Index ¶
- func Bool(fs *flag.FlagSet, prefix, docPrefix, name, label string, value bool, ...) *bool
- func Duration(fs *flag.FlagSet, prefix, docPrefix, name, label string, value time.Duration, ...) *time.Duration
- func FirstLowerCase(s string) string
- func FirstUpperCase(s string) string
- func Float64(fs *flag.FlagSet, prefix, docPrefix, name, label string, value float64, ...) *float64
- func Int(fs *flag.FlagSet, prefix, docPrefix, name, label string, value int, ...) *int
- func Int64(fs *flag.FlagSet, prefix, docPrefix, name, label string, value int64, ...) *int64
- func SnakeCase(s string) string
- func String(fs *flag.FlagSet, prefix, docPrefix, name, label string, value string, ...) *string
- func Uint(fs *flag.FlagSet, prefix, docPrefix, name, label string, value uint, ...) *uint
- func Uint64(fs *flag.FlagSet, prefix, docPrefix, name, label string, value uint64, ...) *uint64
- type Override
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Bool ¶ added in v1.0.0
func Bool(fs *flag.FlagSet, prefix, docPrefix, name, label string, value bool, overrides []Override) *bool
Bool creates a bool flag
func Duration ¶ added in v1.1.0
func Duration(fs *flag.FlagSet, prefix, docPrefix, name, label string, value time.Duration, overrides []Override) *time.Duration
Duration creates a duration flag
func FirstLowerCase ¶
FirstLowerCase change first letter to lowerCase
func FirstUpperCase ¶
FirstUpperCase change first letter to UpperCase
func Float64 ¶ added in v1.0.0
func Float64(fs *flag.FlagSet, prefix, docPrefix, name, label string, value float64, overrides []Override) *float64
Float64 creates a float64 flag
func Int ¶ added in v1.0.0
func Int(fs *flag.FlagSet, prefix, docPrefix, name, label string, value int, overrides []Override) *int
Int creates a int flag
func Int64 ¶ added in v1.0.0
func Int64(fs *flag.FlagSet, prefix, docPrefix, name, label string, value int64, overrides []Override) *int64
Int64 creates a int64 flag
func String ¶ added in v1.0.0
func String(fs *flag.FlagSet, prefix, docPrefix, name, label string, value string, overrides []Override) *string
String creates a string flag
Source Files
Directories