dotenv

README

DotEnv

Load application environment variables from a .env file into the current process.

// Usage 1: Type Safe Env Config
import (
  dotenv "github.com/go-zoox/dotenv"
)

type Config struct {
  Host string `env:"HOST" default:"0.0.0.0"`
  Port int    `env:"PORT" default:"8080"`
  DatabaseUrl string `env:"DATABASE_URL", required:"true"`
  Email string `env:"EMAIL"`
}

var config Config
if err := dotenv.Load(&config); err != nil {
  panic(err)
}

// Usage 2: Auto Load .env To OS
import (
  "os"
  
  _ "github.com/go-zoox/dotenv"
)

fmt.Println("env:", os.Get("FROM_DOT_ENV"))

Inspired by

• joho/godotenv - dot env file
• ilyakaznacheev/cleanenv - struct tag
• JeremyLoy/config - ci

Documentation

Index

• Variables
• func Get(key string, defaultValue ...string) string
• func Load(value interface{}, filenames ...string) error
• func LoadToEnv(filenames ...string) error
• type EnvDataSource
  • func (EnvDataSource) Get(path, key string) any

Variables

var Version = "1.3.0"

Version is the current version of the package.

Functions

func Get

func Get(key string, defaultValue ...string) string

Get gets the value of the given key from system environment.

func Load

func Load(value interface{}, filenames ...string) error

Load loads the .env file into the environment.

func LoadToEnv

func LoadToEnv(filenames ...string) error

LoadToEnv loads the .env file into environment.

Types

type EnvDataSource

type EnvDataSource struct {
}

EnvDataSource is a data source that loads data from the environment.

func (EnvDataSource) Get

func (EnvDataSource) Get(path, key string) any

Get returns the value of the given key.