dotenv

Documentation

Index

• func Load(files ...fs.FileSystem) error
• func Marshal(envMap map[string]string) (string, error)
• func Overload(files ...fs.FileSystem) error
• func Parse(r io.Reader) (envMap map[string]string, err error)
• func Read(files ...fs.FileSystem) (envMap map[string]string, err error)
• func Unmarshal(str string) (envMap map[string]string, err error)
• func Write(envMap map[string]string, file fs.FileSystem) error

Functions

func Load

func Load(files ...fs.FileSystem) error

Load will read your env file(s) and load them into ENV for this process.

Call this function as close as possible to the start of your program (ideally in main)

If you call Load without any args it will default to loading .env in the current path

You can otherwise tell it which files to load (there can be more than one) like

godotenv.Load("fileone", "filetwo")

It's important to note that it WILL NOT OVERRIDE an env variable that already exists - consider the .env file to set dev vars or sensible defaults

func Marshal

func Marshal(envMap map[string]string) (string, error)

Marshal outputs the given environment as a dotenv-formatted environment file. Each line is in the format: KEY="VALUE" where VALUE is backslash-escaped.

func Overload

func Overload(files ...fs.FileSystem) error

Overload will read your env file(s) and load them into ENV for this process.

Call this function as close as possible to the start of your program (ideally in main)

If you call Overload without any args it will default to loading .env in the current path

You can otherwise tell it which files to load (there can be more than one) like

godotenv.Overload("fileone", "filetwo")

It's important to note this WILL OVERRIDE an env variable that already exists - consider the .env file to forcefilly set all vars.

func Parse

func Parse(r io.Reader) (envMap map[string]string, err error)

Parse reads an env file from io.Reader, returning a map of keys and values.

func Read

func Read(files ...fs.FileSystem) (envMap map[string]string, err error)

Read all env (with same file loading semantics as Load) but return values as a map rather than automatically writing values into env

func Unmarshal

func Unmarshal(str string) (envMap map[string]string, err error)

Unmarshal reads an env file from a string, returning a map of keys and values.

func Write

func Write(envMap map[string]string, file fs.FileSystem) error

Write serializes the given environment and writes it to a file