argument

README

Argument

This library helps to fill command line args and enviroment variable to struct.

var data struct {
	Username string `arg:"username" env:"USERNAME" default:"ben"`
	Password string `arg:"password" env:"PASSWORD"`
}
if err := argument.Parse(&data); err != nil {
	log.Fatalf("parse args failed: %v", err)
}
fmt.Printf("username %s, password %s\n", data.Username, data.Password)
}

Documentation

Index

• func DefaultValues(data interface{}) (map[string]interface{}, error)
• func Fill(data interface{}, values map[string]interface{}) error
• func Parse(data interface{}) error
• func ParseArgs(data interface{}, args []string) error
• func ParseEnv(data interface{}, environ []string) error
• func Print(data interface{}) error
• func ValidateRequired(data interface{}) error

Functions

func DefaultValues

func DefaultValues(data interface{}) (map[string]interface{}, error)

DefaultValues returns all default values of the given struct.

func Fill

func Fill(data interface{}, values map[string]interface{}) error

Fill the given map into the struct.

func Parse

func Parse(data interface{}) error

Parse combines all functionality. It parse env args, fills it the struct, print all arguments and validate required fields are set.

func ParseArgs

func ParseArgs(data interface{}, args []string) error

ParseArgs into the given struct.

func ParseEnv

func ParseEnv(data interface{}, environ []string) error

ParseEnv into the given struct.

func Print

func Print(data interface{}) error

Print all configured arguments. Set display:"hidden" to hide or display:"length" to only print the arguments length.

func ValidateRequired

func ValidateRequired(data interface{}) error

ValidateRequired fields are set and returns an error if not.