https://github.com/18jad/enveg
Generate your .env example faster with 1 command
https://github.com/18jad/enveg
dotenv dotenv-parser env
Last synced: about 1 month ago
JSON representation
Generate your .env example faster with 1 command
- Host: GitHub
- URL: https://github.com/18jad/enveg
- Owner: 18jad
- License: mit
- Created: 2022-12-08T17:14:35.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-03-19T00:14:56.000Z (about 3 years ago)
- Last Synced: 2025-09-26T14:20:36.819Z (6 months ago)
- Topics: dotenv, dotenv-parser, env
- Language: TypeScript
- Homepage:
- Size: 61.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Enveg (Env Example Generator)
Generate your .env example faster and easier 🚀
# Demo
ㅤㅤㅤㅤㅤㅤㅤㅤㅤ.envㅤㅤㅤㅤㅤㅤㅤㅤㅤ
ㅤㅤㅤㅤㅤㅤ.env.example (after parsing)ㅤㅤㅤㅤㅤㅤ
```env
# VERSION 1 OF API KEY
API_KEY_V1 = "KEY_XXXX_XXX_XXX"
# VERSION 2 OF API KEY
API_KEY_V2 = "KEY2_XXXX_XXX_XXX"
# ONE COMMENT
# DOUBLE COMMENT
# TRIPLE COMMENT
HOW_MANY_COMMENTS = 3
@ignore
IGNORE_ME = "OKAY YOU ARE IGNORED"
```
```env
# VERSION 1 OF API KEY
API_KEY_V1 = YOUR_API_KEY_V1
# VERSION 2 OF API KEY
API_KEY_V2 = YOUR_API_KEY_V2
# ONE COMMENT
# DOUBLE COMMENT
# TRIPLE COMMENT
HOW_MANY_COMMENTS = YOUR_HOW_MANY_COMMENTS
```
Command used
```
enveg -c -l 2
```
# Installation
```sh
npm i -g enveg
```
# Usage
## Simple:
```sh
# Open terminal in the desired directory and run:
enveg
# it will pick current directory .env and run with default options
```
## Advanced:
```sh
# Open terminal in the desired directory and run:
enveg [options]
# e.g
enveg -c -p "./config/.env" -s DEMO_SLUG -l 2
# to ignore a key add `@ignore` before it
```
# Options (optional)
- `-p` OR `--path` followed by the path of your .env file (relative or absolute path support), default is current terminal directory, it will pick the .env file in it if there's any.
- `-c` OR `--comments` to include comments, by default comments are removed after parsing
- `-e` OR `--empty` to replace values by empty space, by default values are replaced by `default_slug (YOUR) + key`
- `-s` OR `--slug` followed by the desired slug that you want to add to the value, default is `YOUR`
- `-l` OR `--linespace` followed by an integer indicating the line-breaks amount between each env variable, default is `1`