dotenv

dotenv Go library for managing environment variables. It provides a set of functions to retrieve environment variables with different types, including string, boolean, integer, float, and duration. It also includes "Must" versions of these functions that panic if the environment variable is not set or cannot be parsed correctly.

Functions

• ClearCache(): Clears the cache of environment variables.
• GetString(key, fallback string) string: Retrieves the value of the environment variable named by the key. If the value is not set, the fallback value is retur ned.
• GetBool(key string, fallback bool) bool: Retrieves the value of the environment variable named by the key. If the value is not set or cannot be parsed as a boolean, the fallback value is returned.
• GetInt(key string, fallback int) int: Retrieves the value of the environment variable named by the key. If the value is not set or cannot be parsed as an integer, the fallback value is returned.
• GetFloat(key string, fallback float64) float64: Retrieves the value of the environment variable named by the key. If the value is not set or cannot be parsed as a float, the fallback value is returned.
• GetDuration(key string, fallback time.Duration) time.Duration: Retrieves the value of the environment variable named by the key. If the value is not set or cannot be parsed as a duration, the fallback value is returned.
• MustGetString(key string) string: Retrieves the value of the environment variable named by the key. If the value is not set, a panic occurs.
• MustGetBool(key string) bool: Retrieves the value of the environment variable named by the key. If the value is not set or cannot be parsed as a boolean, a panic occurs.
• MustGetInt(key string) int: Retrieves the value of the environment variable named by the key. If the value is not set or cannot be parsed as an integer, a panic occurs.
• MustGetFloat(key string) float64: Retrieves the value of the environment variable named by the key. If the value is not set or cannot be parsed as a float, a panic occurs.
• MustGetDuration(key string) time.Duration: Retrieves the value of the environment variable named by the key. If the value is not set or cannot be parsed as a duration, a panic occurs.

Installation

go get github.com/talut/dotenv

Usage

Import the import "github.com/talut/dotenv" package into your Go code using the following import statement:

In addition to accessing environment variables that are already set, you can also load environment variables from .env files.

Loading from Default .env File

// Load from default .env fileerr:=dotenv.Load()
iferr!=nil {
log.Fatal("Error loading .env file")
}
// Load from a specific environment fileerr:=dotenv.Load(".env.development")
iferr!=nil {
log.Fatal("Error loading environment file")
}
// Load multiple files in order (later files override earlier ones)err:=dotenv.Load(".env", ".env.local")
iferr!=nil {
log.Fatal("Error loading environment files")
}

Note: The second parameters in the Get functions are fallback values that will be used if the environment variable is not set. The MustGet functions will panic if the environment variable is not set or cannot be parsed correctly.

package main
import (
"fmt""time""github.com/talut/dotenv"
)
funcmain() {
// Example usage of GetStringfmt.Println(dotenv.GetString("STRING_ENV_VAR", "default"))
// Example usage of GetBoolfmt.Println(dotenv.GetBool("BOOL_ENV_VAR", false))
// Example usage of GetIntfmt.Println(dotenv.GetInt("INT_ENV_VAR", 0))
// Example usage of GetFloatfmt.Println(dotenv.GetFloat("FLOAT_ENV_VAR", 0.0))
// Example usage of GetDurationfmt.Println(dotenv.GetDuration("DURATION_ENV_VAR", 1*time.Second))
// Example usage of MustGetStringfmt.Println(dotenv.MustGetString("MUST_STRING_ENV_VAR"))
// Example usage of MustGetBoolfmt.Println(dotenv.MustGetBool("MUST_BOOL_ENV_VAR"))
// Example usage of MustGetIntfmt.Println(dotenv.MustGetInt("MUST_INT_ENV_VAR"))
// Example usage of MustGetFloatfmt.Println(dotenv.MustGetFloat("MUST_FLOAT_ENV_VAR"))
// Example usage of MustGetDurationfmt.Println(dotenv.MustGetDuration("MUST_DURATION_ENV_VAR"))
// Example usage of ClearCachedotenv.ClearCache()
}

License

This project is licensed under the MIT License - see the LICENSE file for details.