|
1 |
| -<h1 align="center">configure-env</h1> |
2 |
| -<p align="center">CLI tool to generate and populate <code>.env</code> files from <code>.env.example</code> templates.</p> |
3 |
| -<p align="center"> |
4 |
| -<a href="https://www.npmjs.com/package/configure-env"><img alt="npm (scoped)" src="https://img.shields.io/npm/v/configure-env.svg?style=flat-square"></a> <a href="https://www.npmjs.com/package/configure-env"><img alt="npm" src="https://img.shields.io/npm/dt/configure-env.svg?style=flat-square"></a> <a href="https://github.com/twilio-labs/configure-env/blob/master/LICENSE"><img alt="GitHub" src="https://img.shields.io/github/license/twilio-labs/configure-env.svg?style=flat-square"></a><a href="https://github.com/twilio-labs/configure-env/blob/master/CODE_OF_CONDUCT.md"><img alt="Code of Conduct" src="https://img.shields.io/badge/%F0%9F%92%96-Code%20of%20Conduct-blueviolet.svg?style=flat-square"></a> <a href="https://github.com/twilio-labs/configure-env/blob/master/CONTRIBUTING.md"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square" alt="PRs Welcome" /></a> |
5 |
| -</p> |
6 |
| -<hr> |
7 |
| - |
8 |
| -<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> |
9 |
| - |
10 |
| -[](#contributors-) |
11 |
| - |
12 |
| -<!-- ALL-CONTRIBUTORS-BADGE:END --> |
13 |
| - |
14 |
| -## About |
15 |
| - |
16 |
| -`configure-env` will read a `.env.example` or any other similar `.env` file and prompt for values for each variable that has a comment header above it. Afterwards it will generate a `.env` file out of it. |
17 |
| - |
18 |
| -It works as a more user-friendly approach to: |
19 |
| - |
20 |
| -``` |
21 |
| -cp .env.example .env |
22 |
| -``` |
23 |
| - |
24 |
| -## Installation |
25 |
| - |
26 |
| -You can install the CLI tool via `npm` or another package manager. Ideally install it as a dev dependency instead of global: |
27 |
| - |
28 |
| -```bash |
29 |
| -# Install it as a dev dependency |
30 |
| -npm install configure-env --save-dev |
31 |
| - |
32 |
| -# Afterwards you can use by using: |
33 |
| -node_modules/.bin/configure-env |
34 |
| - |
35 |
| -npx configure-env |
36 |
| - |
37 |
| -# Or inside your package.json scripts section as "configure-env" |
38 |
| -``` |
39 |
| - |
40 |
| -## Usage |
41 |
| - |
42 |
| -In a project that contains a `.env.example` file, run: |
43 |
| - |
44 |
| -```bash |
45 |
| -$ npx configure-env --help |
46 |
| -Prompts user for environment variables and generates .env files based on a |
47 |
| -.env.example file |
48 |
| - |
49 |
| -Usage: |
50 |
| - configure-env.js -o [outputFile] -i [exampleFile] |
51 |
| - |
52 |
| -Options: |
53 |
| - --help Show help [boolean] |
54 |
| - --version Show version number [boolean] |
55 |
| - --output, -o Location of the .env file that should be written |
56 |
| - [string] [default: ".env"] |
57 |
| - --input, -i Location of input .env.example file for prompts |
58 |
| - [string] [default: ".env.example"] |
59 |
| - --verbose [boolean] [default: false] |
60 |
| - |
61 |
| -Examples: |
62 |
| - npx configure-env Reads a .env.example file in the current directory and |
63 |
| - creates a .env file |
64 |
| - configure-env.js | cat The output can be either written to a file or piped to |
65 |
| - another process |
66 |
| - |
67 |
| -This project is part of Twilio Labs. Please file any issues |
68 |
| -github.com/twilio-labs/configure-env |
69 |
| - |
70 |
| -``` |
71 |
| - |
72 |
| -## Contributing |
73 |
| - |
74 |
| -This project welcomes contributions from the community. Please see the [`CONTRIBUTING.md`](CONTRIBUTING.md) file for more details. |
75 |
| - |
76 |
| -### Code of Conduct |
77 |
| - |
78 |
| -Please be aware that this project has a [Code of Conduct](CODE_OF_CONDUCT.md). The tldr; is to just be excellent to each other ❤️ |
79 |
| - |
80 |
| -## Contributors |
81 |
| - |
82 |
| -Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)): |
83 |
| - |
84 |
| -<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> |
85 |
| -<!-- prettier-ignore-start --> |
86 |
| -<!-- markdownlint-disable --> |
87 |
| -<table> |
88 |
| - <tr> |
89 |
| - <td align="center"><a href="https://dkundel.com"><img src="https://avatars3.githubusercontent.com/u/1505101?v=4" width="80px;" alt="Dominik Kundel"/><br /><sub><b>Dominik Kundel</b></sub></a><br /><a href="https://github.com/twilio-labs/configure-env/commits?author=dkundel" title="Code">💻</a></td> |
90 |
| - </tr> |
91 |
| -</table> |
92 |
| - |
93 |
| -<!-- markdownlint-enable --> |
94 |
| -<!-- prettier-ignore-end --> |
95 |
| - |
96 |
| -<!-- ALL-CONTRIBUTORS-LIST:END --> |
97 |
| - |
98 |
| -This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome! |
99 |
| - |
100 |
| -## License |
101 |
| - |
102 |
| -[MIT](LICENSE) |
| 1 | +This is a Fork Of https://github.com/twilio-labs/configure-env |
0 commit comments