https://github.com/nicholasjackson/env

Package to provide configuration as environment variables for 12 factor applications
https://github.com/nicholasjackson/env

environment-variables go microservices

Last synced: 23 days ago
JSON representation

Package to provide configuration as environment variables for 12 factor applications

• Host: GitHub
• URL: https://github.com/nicholasjackson/env
• Owner: nicholasjackson
• Created: 2018-10-27T16:24:37.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2023-01-26T18:00:13.000Z (almost 2 years ago)
• Last Synced: 2024-06-18T15:22:03.310Z (5 months ago)
• Topics: environment-variables, go, microservices
• Language: Go
• Size: 12.7 KB
• Stars: 42
• Watchers: 3
• Forks: 24
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Env 

Env is a simple package providing configuration as environment variables for 12 factor applications, inspired by the Go `flag` package.

## Basic usage

```go

package main

var bindAddress = env.String("BIND_ADDRESS",true,"","bind address for server, i.e. localhost")

var bindPort = env.Integer("BIND_Port",true,0,"bind port for server, i.e. 9090")

func main() {

  err := env.Parse()

  if err != nil {

    fmt.Println(err.Error())

    os.Exit(1)

  }

  fmt.Println("bind address:", *bindAddress)

  fmt.Println("bind port:", *bindPort)

}

```

## Showing help menu

Configuring an application with environment variables can be confusing to the user as often the configuration options are listed in the documentation rather than accessible from the command line like flag based configuration.  Env has a built in help menu which can be accessed using the `--help` command line flag.

```go

var bindAddress = env.String("BIND_ADDR", false, "localhost:9090", "Bind address for the server, i.e. localhost:9090")

var cacheURI = env.String("CACHE_URI", true, "", "URI for the cache server, i.e. localhost:9090")

func main() {

  err := env.Parse()

```

```shell

➜ BIND_PORT=9090 BIND_ADDRESS=localhost go run main.go --help

Configuration values are set using environment variables, for info please see the following list.

Environment variables:

  BIND_ADDRESS  default: no default

       bind address for server, i.e. localhost

  BIND_PORT  default: '0'

       bind port for server, i.e. 9090

```