{"id":17494461,"url":"https://github.com/morkid/goenvi","last_synced_at":"2025-03-28T18:19:29.141Z","repository":{"id":57620590,"uuid":"391840510","full_name":"morkid/goenvi","owner":"morkid","description":"Simple golang environment initializer","archived":false,"fork":false,"pushed_at":"2021-08-02T07:38:12.000Z","size":29,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-02T18:45:03.528Z","etag":null,"topics":["config","configuration","dotenv","environment"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/morkid.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-08-02T06:38:15.000Z","updated_at":"2021-08-02T07:38:15.000Z","dependencies_parsed_at":"2022-09-02T16:35:51.293Z","dependency_job_id":null,"html_url":"https://github.com/morkid/goenvi","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/morkid%2Fgoenvi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/morkid%2Fgoenvi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/morkid%2Fgoenvi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/morkid%2Fgoenvi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/morkid","download_url":"https://codeload.github.com/morkid/goenvi/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246076930,"owners_count":20719894,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["config","configuration","dotenv","environment"],"created_at":"2024-10-19T13:26:23.703Z","updated_at":"2025-03-28T18:19:29.105Z","avatar_url":"https://github.com/morkid.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# goenvi - Simple golang environment initializer\n\n[![Go Reference](https://pkg.go.dev/badge/github.com/morkid/goenvi.svg)](https://pkg.go.dev/github.com/morkid/goenvi)\n[![Github Actions](https://github.com/morkid/goenvi/workflows/Go/badge.svg)](https://github.com/morkid/goenvi/actions)\n[![Go Report Card](https://goreportcard.com/badge/github.com/morkid/goenvi)](https://goreportcard.com/report/github.com/morkid/goenvi)\n[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/morkid/goenvi)](https://github.com/morkid/goenvi/releases)\n\nInitialize your environment variables in one shot. goenvi is built on top of [Viper](https://github.com/spf13/viper).\n\nInstall dependency:\n```bash\ngo get github.com/morkid/goenvi\n```\n\nSupported config file:\n- .env\n- json\n- yaml / yml\n- toml\n- java properties\n- see more about [supported config](https://github.com/spf13/viper#what-is-viper)\n\n## How to use goenvi\n\n`cat .env`\n```bash\nMESSAGE=\"hello world\"\n```\n\n`cat main.go`\n```go\npackage main\n\nimport (\n    \"os\"\n    \"fmt\",\n    \"github.com/morkid/goenvi\"\n    \"github.com/spf13/viper\"\n)\n\nfunc main() {\n    goenvi.Initialize()\n\n    fmt.Println(os.Getenv(\"MESSAGE\"))\n    fmt.Println(viper.GetString(\"MESSAGE\"))\n}\n```\n\n`go run main.go`\n```bash\nhello world\nhello world\n```\n\nBy default goenvi autoload `.env` file in current working directory.\n\n## Load custom config file\n\n`cat config.json`\n```json\n{\n    \"version\": {\n        \"number\": 1,\n        \"name\": \"v1.0.0\"\n    }\n}\n```\n\n`cat main.go`\n```go\npackage main\n\nimport (\n    \"os\"\n    \"fmt\"\n    \"github.com/morkid/goenvi\"\n    \"github.com/spf13/viper\"\n)\n\nfunc main() {\n    goenvi.Add(\"json\", \"config.json\")\n    goenvi.Initialize()\n\n    fmt.Println(os.Getenv(\"VERSION_NUMBER\"))\n    fmt.Println(os.Getenv(\"VERSION_NAME\"))\n    fmt.Println(viper.GetInt(\"version.number\"))\n    fmt.Println(viper.GetInt(\"version.name\"))\n}\n```\n\n## Multiple variations in one shot\n\n`cat main.go`\n```go\npackage main\n\nimport (\n    \"os\"\n    \"fmt\"\n    \"github.com/morkid/goenvi\"\n    ...\n)\n\nfunc main() {\n    goenvi.Add(\"properties\", \"config.properties\")\n    goenvi.Add(\"json\", \"config.json\") // override properties if variable or file does not exists\n    goenvi.Add(\"toml\", \"config.toml\") // override json if variable or file does not exists\n    goenvi.Add(\"yaml\", \"config.yaml\") // override toml if variable or file does not exists\n    goenvi.Add(\"dotenv\", \".env\") // override yaml if variable or file does not exists\n    goenvi.Initialize()\n\n    fmt.Println(os.Getenv(\"VERSION_NUMBER\"))\n    fmt.Println(os.Getenv(\"VERSION_NAME\"))\n    fmt.Println(viper.GetInt(\"version.number\"))\n    fmt.Println(viper.GetInt(\"version.name\"))\n}\n```\n\n## Register custom viper instance\n```go\nfunc main() {\n    myEnv := viper.New()\n    goenvi.Register(myEnv, true) // false if you want to load after .env loaded\n    goenvi.Initialize()\n}\n```\n\n## Register command-line parameters as environment\n\nby implementing `goenvi.FlagSetProvider` interface, you can register command-line parameters as environment variables.\n\n```go\nimport (\n    \"github.com/morkid/goenvi\"\n    \"github.com/spf13/pflag\"\n    \"github.com/spf13/viper\"\n)\n\ntype myFlagSet struct {}\nfunc (myFlagSet) VisitAll(fn func(*pflag.FlagSet)) {\n    defaultValue := viper.GetString(\"message\")\n    pflag.String(\"message\", defaultValue, \"message to show\")\n    pflag.Parse()\n\n    fn(pflag.CommandLine)\n}\n\nfunc main() {\n    goenvi.AddFlagSetProvider(myFlagSet{})\n    goenvi.Initialize()\n}\n```\n\n\u003e Note:  \n\u003e `pflag` will override some environment variables if command-line parameters specified\n\n## License\n\nPublished under the [MIT License](https://github.com/morkid/goenvi/blob/master/LICENSE).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmorkid%2Fgoenvi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmorkid%2Fgoenvi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmorkid%2Fgoenvi/lists"}