The highest tagged major version is
Documentation
¶
Overview ¶
Package dotenv is a go port of the ruby dotenv library (https://github.com/bkeepers/dotenv)
Examples/readme can be found on the github page at https://github.com/joho/godotenv
The TL;DR is that you make a .env file that looks something like
SOME_ENV_VAR=somevalue
and then in your go code you can call
godotenv.Load()
and all the env vars declared in .env will be available through os.Getenv("SOME_ENV_VAR")
Index ¶
- func Exec(filenames []string, cmd string, cmdArgs []string) error
- func Load(filenames ...string) (err error)
- func Marshal(envMap map[string]string) (string, error)
- func Overload(filenames ...string) (err error)
- func Parse(r io.Reader) (map[string]string, error)
- func ParseWithLookup(r io.Reader, lookupFn LookupFn) (map[string]string, error)
- func Read(filenames ...string) (envMap map[string]string, err error)
- func ReadWithLookup(lookupFn LookupFn, filenames ...string) (envMap map[string]string, err error)
- func Unmarshal(str string) (envMap map[string]string, err error)
- func UnmarshalBytes(src []byte) (map[string]string, error)
- func UnmarshalBytesWithLookup(src []byte, lookupFn LookupFn) (map[string]string, error)
- func Write(envMap map[string]string, filename string) error
- type LookupFn
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Exec ¶
Exec loads env vars from the specified filenames (empty map falls back to default) then executes the cmd specified.
Simply hooks up os.Stdin/err/out to the command and calls Run()
If you want more fine grained control over your command it's recommended that you use `Load()` or `Read()` and the `os/exec` package yourself.
func Load ¶
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 ¶
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 ¶
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 ParseWithLookup ¶
ParseWithLookup reads an env file from io.Reader, returning a map of keys and values.
func Read ¶
Read all env (with same file loading semantics as Load) but return values as a map rather than automatically writing values into env
func ReadWithLookup ¶
ReadWithLookup gets all env vars from the files and/or lookup function and return values as a map rather than automatically writing values into env
func UnmarshalBytes ¶
UnmarshalBytes parses env file from byte slice of chars, returning a map of keys and values.
func UnmarshalBytesWithLookup ¶
UnmarshalBytesWithLookup parses env file from byte slice of chars, returning a map of keys and values.
Source Files