flagenv

Documentation

Overview

Package flagenv provides the ability to populate flags from environment variables.

Index

• Variables
• func Parse()
• func ParseSet(prefix string, set *flag.FlagSet) error

Examples

• Parse

Variables

var Prefix = ""

Specify a prefix for environment variables.

Functions

func Parse

func Parse()

Parse will set each defined flag from its corresponding environment variable . If dots or dash are presents in the flag name, they will be converted to underscores.

If Parse fails, a fatal error is issued.

Example

package main

import (
	"flag"

	"within.website/x/internal/flagenv"
)

func main() {
	var raz string
	flag.StringVar(&raz, "raz-value", "bar", "set the raz")

	// override default flag value with value found in MY_RAZ_VALUE
	flagenv.Prefix = "my_"
	flagenv.Parse()

	// override value found in MY_RAZ_VALUE with command line flag value -raz-value=foo
	flag.Parse()
}

func ParseSet

func ParseSet(prefix string, set *flag.FlagSet) error

ParseSet parses the given flagset. The specified prefix will be applied to the environment variable names.