README
¶
Flagx
Golang command line tool with environment supproted, Command line arguments have higher priority than environment variables.
Examples
logFile = flagx.NewString("log.file", "", "the log file")
logLevel = flagx.NewBool("log.level", false, "the log level, default is bool")
serverHost = flagx.NewString("server.addr", ":7070", "the address http will serve on")
serverPort = flagx.NewInt("server.port", 8080, "the tcp port will listen on")
secs = flagx.NewDuration("secs", "30s", "the duration flag, 30 secodns")
secs2 = flagx.NewDuration("days", "30d", "the duration flag, 30 days")
secs3 = flagx.NewDuration("weeks", "2w", "the duration flag, 2 weeks")
bytes = flagx.NewBytes("bytes", 128, "the bytes flag, 128 Byte")
kbs = flagx.NewBytes("kbytes", 64, "the bytes flag, 64KB")
mbs = flagx.NewBytes("mbytes", 64, "the bytes flag, 64KB")
gbs = flagx.NewBytes("gbytes", 64, "the bytes flag, 64KB")
strs = flagx.NewArrayString("array.str", "the string array flag, default is empty")
ints = flagx.NewArrayInt("array.int", "the string array flag, default is empty")
Documentation
¶
Index ¶
- func DurationValue(s string, step int64) (int64, error)
- func IsSecretFlag(s string) bool
- func Lookup(name string) (*flag.Flag, any)
- func NewBool(name string, value bool, usage string, opts ...Option) *bool
- func NewFloat(name string, value float64, usage string, opts ...Option) *float64
- func NewInt(name string, value int, usage string, opts ...Option) *int
- func NewInt64(name string, value int64, usage string, opts ...Option) *int64
- func NewString(name string, value string, usage string, opts ...Option) *string
- func Parse()
- func ParseFlagSet(fs *flag.FlagSet, args []string)
- func PositiveDurationValue(s string, step int64) (int64, error)
- func RegisterSecretFlag(flagName string)
- func Usage(s string)
- func Visit(fn func(string, string))
- func VisitAll(fn func(string, string))
- func WriteFlags(w io.Writer)
- type ArrayBool
- type ArrayBytes
- type ArrayDuration
- type ArrayInt
- type ArrayString
- type ArrayText
- type Bytes
- type Duration
- type Option
- type Text
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DurationValue ¶
DurationValue returns the duration in milliseconds for the given s and the given step.
Duration in s may be combined, i.e. 2h5m, -2h5m or 2h-5m.
The returned duration value can be negative.
func IsSecretFlag ¶
IsSecretFlag returns true of s contains flag name with secret value, which shouldn't be exposed.
func Lookup ¶
Lookup a flag by name. the second return value is the real flag pointer which is returned by flagx.NewXXX. nil, nil will be returned if the flag is not found.
func Parse ¶
func Parse()
Parse parses environment vars(if env.prefix provided) and command-line flags.
Flags set via command-line override flags set via environment vars.
This function must be called instead of flag.Parse() before using any flags in the program.
func ParseFlagSet ¶
ParseFlagSet parses the given args into the given fs.
func PositiveDurationValue ¶
PositiveDurationValue returns positive duration in milliseconds for the given s and the given step.
Duration in s may be combined, i.e. 2h5m or 2h-5m.
Error is returned if the duration in s is negative.
func RegisterSecretFlag ¶
func RegisterSecretFlag(flagName string)
RegisterSecretFlag registers flagName as secret.
This function must be called before starting logging. It cannot be called from concurrent goroutines.
Secret flags aren't exported at `/metrics` page.
func Usage ¶
func Usage(s string)
Usage prints s and optional description for all the flags if -h or -help flag is passed to the app.
Types ¶
type ArrayBool ¶
type ArrayBool []bool
ArrayBool is a flag that holds an array of booleans values.
Has the same api as ArrayString.
func NewArrayBool ¶
NewArrayBool returns new ArrayBool with the given name and description.
func (*ArrayBool) GetOptionalArg ¶
GetOptionalArg returns optional arg under the given argIdx.
func (*ArrayBool) IsBoolFlag ¶
IsBoolFlag implements flag.IsBoolFlag interface
type ArrayBytes ¶
type ArrayBytes []*Bytes
ArrayBytes is flag that holds an array of Bytes.
Has the same api as ArrayString.
func NewArrayBytes ¶
func NewArrayBytes(name, usage string, opts ...Option) *ArrayBytes
NewArrayBytes returns new ArrayBytes with the given name and description.
func (*ArrayBytes) GetOptionalArgOrDefault ¶
func (a *ArrayBytes) GetOptionalArgOrDefault(argIdx int, defaultValue int64) int64
GetOptionalArgOrDefault returns optional arg under the given argIdx.
func (*ArrayBytes) Ints ¶
func (a *ArrayBytes) Ints() []int
func (*ArrayBytes) Set ¶
func (a *ArrayBytes) Set(value string) error
Set implemented flag.Value interface
func (*ArrayBytes) String ¶
func (a *ArrayBytes) String() string
String implements flag.Value interface
type ArrayDuration ¶
ArrayDuration is a flag that holds an array of time.Duration values.
Has the same api as ArrayString.
func NewArrayDuration ¶
func NewArrayDuration(name, usage string, opts ...Option) *ArrayDuration
NewArrayDuration returns new ArrayDuration with the given name and description.
func (*ArrayDuration) GetOptionalArgOrDefault ¶
func (a *ArrayDuration) GetOptionalArgOrDefault(argIdx int, defaultValue time.Duration) time.Duration
GetOptionalArgOrDefault returns optional arg under the given argIdx, or default value, if argIdx not found.
func (*ArrayDuration) Set ¶
func (a *ArrayDuration) Set(value string) error
Set implements flag.Value interface
func (*ArrayDuration) String ¶
func (a *ArrayDuration) String() string
String implements flag.Value interface
type ArrayInt ¶
type ArrayInt []int
ArrayInt is flag that holds an array of ints.
Has the same api as ArrayString.
func NewArrayInt ¶
NewArrayInt returns new ArrayInt with the given name and description.
func (*ArrayInt) GetOptionalArgOrDefault ¶
GetOptionalArgOrDefault returns optional arg under the given argIdx.
type ArrayString ¶
type ArrayString []string
ArrayString is a flag that holds an array of strings.
It may be set either by specifying multiple flags with the given name passed to NewArray or by joining flag values by comma.
The following example sets equivalent flag array with two items (value1, value2):
-foo=value1 -foo=value2 -foo=value1,value2
Each flag value may contain commas inside single quotes, double quotes, [], () or {} braces. For example, -foo=[a,b,c] defines a single command-line flag with `[a,b,c]` value.
Flag values may be quoted. For instance, the following arg creates an array of ("a", "b,c") items:
-foo='a,"b,c"'
func NewArrayString ¶
func NewArrayString(name, usage string, opts ...Option) *ArrayString
NewArrayString returns new ArrayString with the given name and description.
func (*ArrayString) GetOptionalArg ¶
func (a *ArrayString) GetOptionalArg(argIdx int) string
GetOptionalArg returns optional arg under the given argIdx.
func (*ArrayString) Set ¶
func (a *ArrayString) Set(value string) error
Set implements flag.Value interface
func (*ArrayString) String ¶
func (a *ArrayString) String() string
String implements flag.Value interface
type ArrayText ¶
type ArrayText []*Text
ArrayText is a flag that used to hold multiple Text values.
func NewArrayText ¶
NewArrayBytes returns new ArrayText with the given name and description.
type Bytes ¶
type Bytes struct {
// N contains parsed value for the given flag.
N int64
// contains filtered or unexported fields
}
Bytes is a flag for holding size in bytes.
It supports the following optional suffixes for values: KB, MB, GB, TB, KiB, MiB, GiB, TiB.
type Duration ¶
type Duration struct {
// Msecs contains parsed duration in milliseconds.
Msecs int64
// contains filtered or unexported fields
}
Duration is a flag for holding duration.
func NewDuration ¶
NewDuration returns new `duration` flag with the given name, defaultValue and description.
DefaultValue is in months.
type Text ¶
type Text struct {
Value string
}
Text is a flag that used to hold complex content, such as json. the passed value should be base64-encoded string, it will be decoded before assignment.
Source Files
Directories