env-prompt/README.md

A dependency-free utility that prompts you for your project's environment variables.

# env-prompt
Env-prompt is a Node.js utility that enables teams to seamlessly keep their environment variables in sync.

You simply provide two **.env** files:
 - a **distributed file** (default: **`.env.dist`**) committed to version control
 - a git ignored **local file** (default: **`.env`**)

As new variables are added to the **distributed file**, your team is prompted for their values.

## Getting started
1) Install env-prompt:
```sh
npm install -D env-prompt
```

2) Add the `env-prompt` command to a script in your `package.json` file:
```diff
{
  "name": "test",
  "main": "index.js",
+ "scripts": {
+   "postinstall": "env-prompt"
+ },
  "devDependencies": {
    "env-prompt": "^2.0.0"
  }
}
```

3) Create a `.env.dist` file in the same directory as your `package.json` file:
```
API_HOSTNAME=https://example.com
API_USER=api_user
API_PASS=myP4$$w0rd
```

Env-prompt is now set up to diff your `.env` and `.env.dist` files, and will be triggered when you run `npm install`.

## Command-line interface
### Synopsis
```sh
[CI=<true|false>] npx env-prompt
    [-d|--distFile <path>]
    [-l|--localFile <path>]
    [-p|--prompts <true|false>]
    [-a|--allowDuplicates]
    [-n|--newlineType <unix|windows>]
```

### Arguments
#### `-d <path>`
#### `--distFile <path>`
_Default: `.env.dist`_\
This is the .env file that env-prompt will scan for new environment variables. It is recommended that you commit this file to version control.


#### `-l <path>`
#### `--localFile <path>`
_Default: `.env`_\
This is the .env file for your local environment. When prompted for new variables, the input values will be written here. It is recommended that you add this file to the `.gitignore` of your project.

#### `-p <true|false>`
#### `--prompts <true|false>`
_Default: `true`_\
When setting `--prompts false`, env-prompt will run headlessly and will not prompt the user when new variables are detected.
The default value from the distributed file will be written for new variables.

#### `-a`
#### `--allowDuplicates`
By default, an error is raised when duplicate variable declarations are found. The presence of this flag supresses this error.

#### `-n <unix|windows>`
#### `--newlineType <unix|windows>`
_Default (on non-windows systems): `unix`_\
_Default (on windows): `windows`_\
Determines how newlines will be written to disk. For `unix`, `\n` will be used. For `windows`, `\r\n` will be used.
This argument only impacts how newlines are _written_ to disk. Regardless of this value, `\n`, `\r\n`, and `\r` are all _read_ from disk as newlines.

### Variables
#### `CI=<true|false>`
_Default: `false`_\
Indicates whether or not env-prompt is being run by continous integration. Setting `CI=true` is equivalent to `--prompts false`.