envample/README.md

Generates .env.example from your .env file

# envample

Generates .env.example or .env.* file from your .env file.

This a quick way to keep your .env file and your .env.example file in sync.

## Quick use

```bash
npx envample
```

## Installation

```sh
npm i -g envample
```

or in your project

```sh
npm i -D envample
```

## Usage

```sh
envample

# OR
envample .env .env.example
```

If the arguments are not specified `.env` and `.env.example` will be used

## How it works

Lines preceded with `# example` comment will be copied as is.

Lines preceded with `# example=value` comment will be copied with the value replaced by the specified value

Lines not preceded by an `# example` comment will be copied without the value

Lines preceded with `# ignore` will be ignored

All comments except those marked with `# ignore` will be preserved

## Example

.env

```sh
GIT=true
# example=false
DEBUG=true
SECRET=secret
# just a comment
# ignore
IGNORED=true
```

.env.example

```sh
# example
GIT=true
# example=false
DEBUG=false
SECRET=
# just a comment
```