README
¶
gotenv
Load environment variables dynamically in Go.
| - | - |
|---|---|
| Build Status |  |
| Coverage |  |
| Documentation | http://godoc.org/github.com/subosito/gotenv |
Installation
$ go get github.com/subosito/gotenv
Usage
Store your configuration to .env file on your root directory of your project:
APP_ID=1234567
APP_SECRET=abcdef
Put the gotenv package on your import statement:
import "github.com/subosito/gotenv"
Then somewhere on your application code, put:
gotenv.Load()
Behind the scene it will then load .env file and export the valid variables to the environment variables. Make sure you call the method as soon as possible to ensure all variables are loaded, say, put it on init() function.
Once loaded you can use os.Getenv() to get the value of the variable.
Here's the final example:
package main
import (
"github.com/subosito/gotenv"
"log"
"os"
)
func init() {
gotenv.Load()
}
func main() {
log.Println(os.Getenv("APP_ID")) // "1234567"
log.Println(os.Getenv("APP_SECRET")) // "abcdef"
}
You can also load other than .env file if you wish. Just supply filenames when calling Load():
gotenv.Load(".env.production", "credentials")
That's it :)
Another Scenario
Just in case you want to parse environment variables from any io.Reader, gotenv keeps its Parse() function as public API so you can utilize that.
// import "strings"
pairs := gotenv.Parse(strings.NewReader("FOO=test\nBAR=$FOO"))
// gotenv.Env{"FOO": "test", "BAR": "test"}
pairs = gotenv.Parse(strings.NewReader(`FOO="bar"`))
// gotenv.Env{"FOO": "bar"}
Parse ignores invalid lines and returns Env of valid environment variables.
Formats
The gotenv supports various format for defining environment variables. You can see more about it on:
Notes
The gotenv package is a Go port of dotenv project. Most logic and regexp pattern is taken from there and aims will be compatible as close as possible.
Documentation
¶
Overview ¶
Package gotenv provides functionality to dynamically load the environment variables
Index ¶
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Load ¶
Load is function to load a file or multiple files and then export the valid variables which found into environment variables. When it's called with no argument, it will load `.env` file on the current path and set the environment variables. Otherwise, it will loop over the filenames parameter and set the proper environment variables.
// processing `.env`
gotenv.Load()
// processing multiple files
gotenv.Load("production.env", "credentials")
Types ¶
type Env ¶
Holds key/value pair of valid environment variable
func Parse ¶
Parse if a function to parse line by line any io.Reader supplied and returns the valid Env key/value pair of valid variables. It expands the value of a variable from environment variable, but does not set the value to the environment itself. This function is skipping any invalid lines and only processing the valid one.
Example ¶
package main
import (
"fmt"
"github.com/ddollar/forego/Godeps/_workspace/src/github.com/subosito/gotenv"
"strings"
)
func main() {
pairs := gotenv.Parse(strings.NewReader("FOO=test\nBAR=$FOO"))
fmt.Printf("%+v\n", pairs) // gotenv.Env{"FOO": "test", "BAR": "test"}
pairs = gotenv.Parse(strings.NewReader(`FOO="bar"`))
fmt.Printf("%+v\n", pairs) // gotenv.Env{"FOO": "bar"}
}
Output:
Source Files