abursavich / envflag

envflag

import "github.com/abursavich/envflag"

• Overview
• Index

Overview

Package envflag wraps the parsing of the standard flag package to include environment variables as a source for flag arguments. Arguments passed as command line flags override arguments passed as environment variables.

Clients should call envflag.Parse() instead of flag.Parse().

Index

• func Parse(options ...Option) error
• type Option
  • func Args(arguments []string) Option
  • func FlagSet(set *flag.FlagSet) Option
  • func Prefix(prefix string) Option

Package files

envflag.go

func Parse

func Parse(options ...Option) error

Parse parses flag definitions from the argument list and the environment, giving preference to the argument list over the environment.

type Option

type Option func(o *option)

An Option is an option.

func Args

func Args(arguments []string) Option

Args returns an Option which specifies the argument list to parse, which should not include the command name. If unused, os.Args[1:] is the default.

func FlagSet

func FlagSet(set *flag.FlagSet) Option

FlagSet returns an Option which specifies the set of flags to parse. If unused, flag.CommandLine is the default.

func Prefix

func Prefix(prefix string) Option

Prefix returns an Option which specifies a prefix for flag names when looking up corresponding enviroment variables.

---

Generated by godoc2md