# env2
> Environment Variable Loader
Latest version **2.2.2** (published 2018-06-10) · GPL-2.0 license · 0 weekly downloads
## Install
```sh
npm install env2
pnpm add env2
yarn add env2
bun add env2
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 2.2.2 |
| Published | 2018-06-10 |
| First published | 2015-08-07 |
| Weekly downloads | 0 |
| License | GPL-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.10.0 |
| Dependencies | 0 |
| Unpacked size | 35.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 102 |
| Author | Nelson |
| Maintainers | nelsonic, rjmk |
| Keywords | env, environment, variables, config, file, aws, lambda, webpack, universal, fast, secure, easy, tested |
## Links
- npm: https://www.npmjs.com/package/env2
- Repository: https://github.com/dwyl/env2
- Homepage: https://github.com/dwyl/env2#readme
- Issues: https://github.com/dwyl/env2/issues
- npm.io page: https://npm.io/package/env2
## Alternatives
- [replicas-cli](https://npm.io/package/replicas-cli.md) — 3.0K weekly downloads
- [env-contract](https://npm.io/package/env-contract.md) — 133 weekly downloads
- [@openveo/api](https://npm.io/package/@openveo/api.md) — 61 weekly downloads
- [@ryniaubenpm2/cumque-error-reiciendis](https://npm.io/package/@ryniaubenpm2/cumque-error-reiciendis.md) — 54 weekly downloads
- [ts-global-type-extra](https://npm.io/package/ts-global-type-extra.md) — 11 weekly downloads
## Recent versions
- 2.2.2 (latest) — 2018-06-10
- 2.2.1 — 2018-06-10
- 2.2.0 — 2017-05-15
- 2.1.1 — 2016-08-06
- 2.1.0 — 2016-05-19
- 2.0.8 — 2016-05-14
- 2.0.7 — 2016-03-18
- 2.0.6 — 2016-02-15
- 2.0.5 — 2016-02-15
- 2.0.4 — 2015-10-19
- 2.0.2 — 2015-08-28
- 2.0.1 — 2015-08-18
- 2.0.0 — 2015-08-18
- 1.0.6 — 2015-08-17
- 1.0.5 — 2015-08-08
- … 4 more at https://npm.io/package/env2/versions
## README
env2 - environment variable loader
===
[](https://travis-ci.org/dwyl/env2)
[](https://github.com/dwyl/env2)
[](http://codecov.io/github/dwyl/env2?branch=master)
[](https://david-dm.org/dwyl/env2)
[](https://david-dm.org/dwyl/env2?type=dev)
[](https://www.npmjs.com/package/env2)
## Why?
**Environment variables** are the best way of storing sensitive data
like API Keys, Login Credentials and Database Passwords.
> If you are *new* to ***environment variables***
please checkout our ***introduction for complete beginners***:
https://github.com/dwyl/learn-environment-variables
We needed a simple/reliable way of managing **environment variables**;
and being able to share a configuration file among the team
(_without committing it to GitHub_!) **env2** is our *solution*.
## What?
**env2** allows you to store your environment variables in an `env.json` or a
`.env` file which gets loaded when your app starts.
All the entries in the `env` file are exported as environment variables
available as keys in the `process.env` object.
Works fine with build systems like [webpack](https://webpack.github.io/) and [browserify](http://browserify.org/).
If you want to use it on the frontend, you will need some sort of [filesystem shim](https://github.com/substack/brfs)
## How?
> Need help getting started? [](https://gitter.im/dwyl/chat/?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
### Create a `.env` File
We use (*and recommend*) `.env` files for environment configuration.
We call our file `.env` for *cross-project consistency* and `.env` is part of the [official `.gitignore` from GitHub for NodeJS](https://github.com/github/gitignore/blob/9ef1596ac14f77ddd79a74e3f621ee117022e107/Node.gitignore#L55-L56).
(*but you can call your file what ever you like e.g*: `.environment`)
A `.env` file is a very explicit way of listing environment variables
without the extra syntax (_potential human/input error_) of a JSON file.
It also allows for easier copy-pasting into the terminal
(with an `export` keyword prepended to each line).
The format of a `.env` file is:
```sh
export DB_HOST=127.0.0.1
export DB_PORT=9200
export DB_USER=anon
export DB_PASS=password
```
> Note the **lack of _spaces_**. You may leave blank lines and insert comments
(starting with '#') to organise the file if you wish. Follow the **instructions
below** for placing it in your `.gitignore` file.
### *Alternatively* Create an `env.json` Configuration File
If you *prefer* to use `.json` instead of `.env` create a `env.json` file in your repo with the following format:
```js
{
"DB_HOST": "127.0.0.1",
"DB_PORT": 9200,
"DB_USER": "anon",
"DB_PASS": "password"
}
```
### *Always* `.gitignore` your configuration file
***Always*** create your `.env` or `env.json` file
in the ***root directory*** of your project and _don't forget_ to add it to your `.gitignore`to
avoid _accidentally_ committing your keys/passwords to GitHub where bad people can (*will*) steal your secrets!
e.g:
```sh
echo '.env' >> .gitignore
```
***or***
```sh
echo 'env.json' >> .gitignore
```
### Install from NPM
Next **install** `env2` from npm and save it to your `package.json` file:
```sh
npm install env2 --save
```
### Use in your Code
Then in your script/module:
```js
const env = require('env2')('./path-to-your/.env');
// your app goes here
console.log(process.env.DB_HOST); // "127.0.0.1"
```
now all the entries in your `env.json` or `.env` file are available as
keys/values of the `process.env` Object which means you can use
`process.env.API_KEY` or `process.env.DB_PASSWORD` in your script.
(*or what ever you have defined as entries in your* `env.json`)
Env is synchronous; it loads all your configuration variables into the
`process.env` object *before* app/script execution.
## Do you want to Define Priority for Variables?
Do you want the ability to *specify* the priority which
environment variables take precendence?
e.g: if you supply a command-line argument when running your script/app:
```sh
env=PROD API_KEY=token.dwyl.yolo node myapp.js
```
We have an *open discussion* on this: https://github.com/dwyl/env2/issues/1
At present, any environment variable defined in the environment where
your app is running (or via command-line arguments) will take
precendence over the same key in your `env.json` file ... if you prefer
to have the option to *specify* the priority, please add a comment to the isssue:
https://github.com/dwyl/env2/issues/1
## Huh?
[The Twelve Factor App](http://12factor.net/config) section 3 states:
> "**Store config in the environment**"
"*An app’s config is everything that is likely to vary between deploys
(staging, production, developer environments, etc)*".
## Name ?
**Q**: Why is it called "env2"?
**A**: as the digit in the name suggests, there was/is an "env" (version 1):
https://www.npmjs.com/package/env written by [@dshaw](https://github.com/dshaw)
sadly, it was never finished and has not been updated in 4 years ...
We asked Dan if he would accept a Pull Request updating the package:
https://github.com/dshaw/env/issues/6 and he said he *would* accept it ...
But after investing the time and submitting the pull request:
https://github.com/dshaw/env/pull/8 which updated the package to the latest
version of Node/io.js and had tests with 100% coverage, the PR got ignored.
see: https://twitter.com/dshaw/status/628237150253772801
Not that we're "_impatient_" but we need to move on with our code/lives.
That's why we wrote **env2**.
We have since added better error handling and alternative file types,
so **env2** is can be considered the "***New & Improved Version***"
---
_Source: https://npm.io/package/env2 · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._