env

Documentation

Overview

Package env provides environment variable utilities for Buffalo. This package replaces the github.com/gobuffalo/envy dependency.

Index

• func Environ() []string
• func Get(key, fallback string) string
• func GoPath() string
• func Load(filenames ...string) error
• func MustGet(key string) (string, error)
• func Set(key, value string)
• func Temp(f func())

Functions

func Environ

func Environ() []string

Environ returns a copy of the environment variables.

func Get

func Get(key, fallback string) string

Get returns the value of the environment variable named by key. If the variable is not set or is empty, it returns the fallback value.

func GoPath

func GoPath() string

GoPath returns the GOPATH environment variable. If GOPATH is not set, it returns the default GOPATH: $HOME/go

func Load

func Load(filenames ...string) error

Load loads .env file(s) into environment. If no filenames are provided, it loads the .env file in the current directory.

func MustGet

func MustGet(key string) (string, error)

MustGet returns the value of the environment variable named by key. It returns an error if the variable is not set or is empty.

func Set

func Set(key, value string)

Set sets the environment variable named by key to value.

func Temp

func Temp(f func())

Temp executes f with temporarily modified environment variables. After f returns, the environment is restored to its original state.