# env-sample > Removes your secret values in '.env' file and generate '.env-sample'. It supports multiline values and protects comments. Latest version **2.2.1** (published 2024-02-13) · MIT license · 0 weekly downloads ## Install ```sh npm install env-sample pnpm add env-sample yarn add env-sample bun add env-sample ``` Provides the commands `env-sample`, `env-sample-cli`. ## 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.1 | | Published | 2024-02-13 | | First published | 2023-02-04 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 1 | | Unpacked size | 10.8 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 2 | | Author | MiaJupiter Developer Team | | Maintainers | shamancoders3 | | Keywords | env, dotenv, env-sample, cli, sample-env, .env | ## Links - npm: https://www.npmjs.com/package/env-sample - Repository: https://github.com/miajupiter/env-sample - Homepage: https://github.com/miajupiter/env-sample#readme - Issues: https://github.com/miajupiter/env-sample/issues - npm.io page: https://npm.io/package/env-sample ## Dependencies (1) - [yargs](https://npm.io/package/yargs.md) ^17.6.2 ## 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.1 (latest) — 2024-02-13 - 2.1.5 — 2023-02-10 - 2.1.3 — 2023-02-05 - 2.1.2 — 2023-02-05 - 2.1.1 — 2023-02-05 - 2.1.0 — 2023-02-05 - 2.0.3 — 2023-02-04 - 1.0.7 — 2023-02-04 ## README

[![](https://img.shields.io/badge/%F0%9F%8C%90%20www-miajupiter.com-blueviolet?style=flat&labelColor=%23323232)](https://miajupiter.com) # env-sample [![npm](https://img.shields.io/npm/v/env-sample?label=npm&logo=npm) ](https://www.npmjs.com/package/env-sample) [![download](https://img.shields.io/npm/dt/env-sample?label=downloads&logo=npm)](https://www.npmjs.com/package/env-sample) [![GitHub](https://img.shields.io/github/license/miajupiter/sms-auth)](https://choosealicense.com/licenses/mit/) [![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Fmiajupiter%2Fenv-sample&count_bg=%236495ED&title_bg=%23323232&icon=cliqz.svg&icon_color=%23E7E7E7&title=hits&edge_flat=false)](https://hits.seeyoufarm.com) [![](https://img.shields.io/badge/readme-docs-chocolate.svg)](https://github.com/miajupiter/env-sample#readme) [![](https://img.shields.io/github/stars/miajupiter/env-sample?color=yellow&label=stars&logo=github)](https://github.com/miajupiter/env-sample/stargazers) ## Table of contents - [Introduction](#introduction) - [CLI Installation](#cli--installation) - [Install](#install) - [Usage](#usage) - [Package Installation](#package-installation) - [Install](#installation) - [Usage](#usage) - [default](#default) - [with `option` object parameter](#with-option-object-parameter) - [Before After Example](#before-after-example) - [Before | Source `.env`](#before--source-env) - [After | Target `.env.sample`](#after--target-envsample) - [License - MIT License](#license---mit-license) ## Introduction Removes your secret values in `.env` file and generates `.env.sample` or `.env.dev` or `.env.test` etc. file. Supports multiline values (for example: *RSA PRIVATE KEY*) and protects your comments. ## CLI Installation ### Install ```bash npm install env-sample -g ``` ### Usage ```bash $ env-sample -h ``` ```bash Usage: env-sample [options] Options: -e, --env Source file. default is ".env" -s, --sample Target file. default ".env-sample" -m, --mask Mask character. example: "*", " ", etc. default is "" (empty string) -b, --banner Set your banner to bottom of target. --banner="" Remove default banner. -w, --watch Watch source file. If the source file is deleted, the target file is also deleted. -v, --version output the version number -h, --help output usage information ``` ## Package Installation ### Installation ```bash npm install env-sample ``` ### Usage #### default ```js const envSample = require('env-sample') envSample() ``` #### with `option` object parameter ```javascript const envSample = require('env-sample') const options={ env: '.env', sample: '.env-sample', mask: '', watch: false, banner:`2023-Now (c) MiaJupiter. All rights reserved. https://miajupiter.com` } envSample(options) ``` ## Before After Example ### Before | Source `.env` ```dosini # jwt variables TOKEN_EXPIRES_IN=31536022 # valid for 1 year TOKEN_PHRASE=upper520World # MongoDB variables # password special chars --> : / ? # [ ] @ # they must replace with uri equavalents :=%3A /=%2F ?=%3F #=%23 [=%5B ]=%5D @=%40 # mongodb://[username:password@]host1[:port1][,...hostN[:portN]][/[defaultauthdb][?options]] MONGODB_MAINDB_URI=mongodb://localhost:27017/restApi MONGODB_USERDB_URI='mongodb://localhost:27017/' # user database server # Enable debug mode (true) or disable it (false). DEBUG=false PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY----- ... crt ys 319612719849...589317318614 Kh9NV... ... -----END RSA PRIVATE KEY-----" # Make this variable too, let's see! MY_NAME=shamanCoders USER_ID=319817318 # for all mankind TEST=4445 ########################## TEST 7 7 7 ###################################### ``` ### After | Target `.env.sample` ```dosini # jwt variables TOKEN_EXPIRES_IN= # valid for 1 year TOKEN_PHRASE= # MongoDB variables # password special chars --> : / ? # [ ] @ # they must replace with uri equavalents :=%3A /=%2F ?=%3F #=%23 [=%5B ]=%5D @=%40 # mongodb://[username:password@]host1[:port1][,...hostN[:portN]][/[defaultauthdb][?options]] MONGODB_MAINDB_URI= MONGODB_USERDB_URI= # user database server # Enable debug mode (true) or disable it (false). DEBUG=false PRIVATE_KEY= # Make this variable too, let's see! MY_NAME= USER_ID= # for all mankind TEST= ########################## TEST 7 7 7 ###################################### # -------------------------------------------------------------------- # 2023-Now (c) MiaJupiter. All rights reserved. https://miajupiter.com ``` ## License - MIT License Copyright (c) 2023-**Now** [MiaJupiter Technology Inc.](https://miajupiter.com). All rights reserved. We are proud to be [Open Source](https://opensource.org). For full details about the license, please check the `LICENSE` file in the root directory of the source repository. --- _Source: https://npm.io/package/env-sample · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._