envflag

Documentation

Overview

Package envflag provides a wrapper around the standard flag package that can fall back to environment variables

Index

• func Bool(name string, value bool, usage string) *bool
• func Int(name string, value int, usage string) *int
• func Parse()
• func String(name string, value string, usage string) *string

Functions

func Bool

func Bool(name string, value bool, usage string) *bool

Bool defines a bool flag with specified name, default value, and usage string. If an environment variable with the same name as the flag is set, it will be used instead of the default value. The return value is the address of a bool variable that stores the value of the flag.

func Int

func Int(name string, value int, usage string) *int

Int defines an int flag with specified name, default value, and usage string. If an environment variable with the same name as the flag is set, it will be used instead of the default value. The return value is the address of an int variable that stores the value of the flag.

func Parse

func Parse()

Parse parses the command-line flags from os.Args[1:]. Must be called after all flags are defined and before flags are accessed by the program.

func String

func String(name string, value string, usage string) *string

String defines a string flag with specified name, default value, and usage string. If an environment variable with the same name as the flag is set, it will be used instead of the default value. The return value is the address of a string variable that stores the value of the flag.