package godotenv

Import Path
	github.com/joho/godotenv (on go.dev)

Dependency Relation
	imports 11 packages, and imported by one package

Involved Source Files

	  d godotenv.go
		Package godotenv 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")

	    parser.go
Package-Level Functions (total 9)

	 func Exec(filenames []string, cmd string, cmdArgs []string, overload bool) error
		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()`, `Overload()` or `Read()` and the `os/exec` package yourself.

	 func Load(filenames ...string) (err 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(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(filenames ...string) (err 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 forcefully set all vars.

	 func Parse(r io.Reader) (map[string]string, error)
		Parse reads an env file from io.Reader, returning a map of keys and values.

	 func Read(filenames ...string) (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(str string) (envMap map[string]string, err error)
		Unmarshal reads an env file from a string, returning a map of keys and values.

	 func UnmarshalBytes(src []byte) (map[string]string, error)
		UnmarshalBytes parses env file from byte slice of chars, returning a map of keys and values.

	 func Write(envMap map[string]string, filename string) error
		Write serializes the given environment and writes it to a file.

The pages are generated with Golds v0.6.7. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.