https://github.com/celsodias12/generate-env-example
Generate your .env.example file in a simple and fast way, you will never have to worry about manually updating your example file of environment variables!
https://github.com/celsodias12/generate-env-example
create-env-example-file env env-example generate-env-file
Last synced: 6 months ago
JSON representation
Generate your .env.example file in a simple and fast way, you will never have to worry about manually updating your example file of environment variables!
- Host: GitHub
- URL: https://github.com/celsodias12/generate-env-example
- Owner: celsodias12
- License: mit
- Created: 2022-04-17T02:15:22.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-02-26T20:50:13.000Z (about 2 years ago)
- Last Synced: 2025-08-09T06:47:32.832Z (8 months ago)
- Topics: create-env-example-file, env, env-example, generate-env-file
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/generate-env-example
- Size: 4.45 MB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![MIT License][license-shield]][license-url]
Generate env example
Generate your .env.example file in a simple and fast way, you will never have to worry about manually updating your example file of environment variables!
![Project Screen Shot][project-screenshot]
## Usage
1. Install library as dev dependencies
```sh
npm i generate-env-example -D
```
or
```sh
yarn add generate-env-example -D
```
- If your environment variables file is called .env, use it like this:
```sh
npx generate-env-example
```
- If your file is any other name, use it like this:
```sh
npx generate-env-example env-file-name
```
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the MIT License. See `LICENSE` for more information.
[contributors-shield]: https://img.shields.io/github/contributors/celsodias12/generate-env-example.svg?style=for-the-badge
[license-shield]: https://img.shields.io/github/license/celsodias12/generate-env-example.svg?style=for-the-badge
[contributors-url]: https://github.com/celsodias12/generate-env-example/graphs/contributors
[license-url]: https://github.com/celsodias12/generate-env-example/blob/master/LICENSE
[project-screenshot]: https://raw.githubusercontent.com/celsodias12/generate-env-example/main/docs/usage-example.gif