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(ctx context.Context, data interface{}) (map[string]interface{}, error)
- func Fill(ctx context.Context, data interface{}, values map[string]interface{}) error
- func Parse(ctx context.Context, data interface{}) error
- func ParseAndPrint(ctx context.Context, data interface{}) error
- func ParseArgs(ctx context.Context, data interface{}, args []string) error
- func ParseEnv(ctx context.Context, data interface{}, environ []string) error
- func Print(ctx context.Context, data interface{}) error
- func ValidateRequired(ctx context.Context, data interface{}) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DefaultValues ¶
DefaultValues returns all default values of the given struct.
func Parse ¶
Parse combines all functionality. It parse env args, fills it the struct, print all arguments and validate required fields are set.
func ParseAndPrint ¶ added in v2.3.0
func Print ¶
Print all configured arguments. Set display:"hidden" to hide or display:"length" to only print the arguments length.
func ValidateRequired ¶
ValidateRequired fields are set and returns an error if not.
Types ¶
This section is empty.
Source Files
¶
Directories
Click to show internal directories.
Click to hide internal directories.