Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nielse63/copy-env
Automate managing example .env files
https://github.com/nielse63/copy-env
cli config dotenv env environment settings utils
Last synced: 11 days ago
JSON representation
Automate managing example .env files
- Host: GitHub
- URL: https://github.com/nielse63/copy-env
- Owner: nielse63
- License: mit
- Created: 2023-03-08T15:34:25.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-13T22:35:19.000Z (3 months ago)
- Last Synced: 2024-08-17T11:11:19.692Z (3 months ago)
- Topics: cli, config, dotenv, env, environment, settings, utils
- Language: TypeScript
- Homepage: https://nielse63.github.io/copy-env/
- Size: 1.7 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @nielse63/copy-env
> Automate managing example .env files
Oftentimes, you'll want to be able to share and check in your `.env` files with your team or to remember which environment variables are necessary for your project. `copy-env` automatically copies your `.env` file, removes the secret values, and saves it to an `.env.sample` file.
## Installation
Install the package globally to use the CLI:
```bash
npm i -g @nielse63/copy-env
```
Or install it in your project for scoped CLI usage, and to use the API:
```bash
npm i -D @nielse63/copy-env
```
## Usage
### CLI
Install the package and simply run `copy-env` from the command line:
```bash
$ copy-env --help
Usage: copy-env [options]
Automate managing example .env files
Options:
--cwd Current working directory (default: ".")
--src Source file to read from (default: ".env")
--dest File to write to (default: ".env.sample")
--ignore-regex Regex string of what to omit from output (default: "^#")
--git-add Stage the output file after update (default: false)
-V, --version output the version number
-h, --help display help for command
```
### API
See the view API on [GitHub Pages](https://nielse63.github.io/copy-env/modules.html).
## 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 scratch/my-feature`)
3. Commit your Changes (`git commit -m 'added new feature'`)
4. Push to the Branch (`git push origin scratch/my-feature`)
5. Open a Pull Request
## License
Distributed under the MIT License. See [`LICENSE`](https://github.com/nielse63/copy-env/blob/main/LICENSE) for more information.
## Contact
Project Link: [https://github.com/nielse63/copy-env](https://github.com/nielse63/copy-env)