https://github.com/atrox/sync-dotenv
:twisted_rightwards_arrows: Keep your .env.example in sync with changes to your .env file
https://github.com/atrox/sync-dotenv
dotenv environment environment-variables sync sync-dotenv synchronization
Last synced: 4 days ago
JSON representation
:twisted_rightwards_arrows: Keep your .env.example in sync with changes to your .env file
- Host: GitHub
- URL: https://github.com/atrox/sync-dotenv
- Owner: Atrox
- License: mit
- Created: 2019-05-21T09:44:23.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-05-19T12:57:34.000Z (about 2 years ago)
- Last Synced: 2025-04-22T09:23:32.470Z (2 months ago)
- Topics: dotenv, environment, environment-variables, sync, sync-dotenv, synchronization
- Language: Go
- Homepage:
- Size: 144 KB
- Stars: 6
- Watchers: 2
- Forks: 14
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sync-dotenv
[](https://github.com/atrox/sync-dotenv/releases/latest)
[](https://actions-badge.atrox.dev/atrox/sync-dotenv/goto)
[](https://codecov.io/gh/Atrox/sync-dotenv)
[](https://goreportcard.com/report/github.com/atrox/sync-dotenv)
Keep your `.env.example` in sync with changes to your `.env` file.
## Installation
### macOS (homebrew)
```sh
brew install atrox/tap/sync-dotenv
```
### Windows (scoop)
```ps
scoop bucket add sync-dotenv https://github.com/atrox/scoop-bucket
scoop install sync-dotenv
```
### Linux (deb/rpm)
Download the `.deb` or `.rpm` from the [releases page](https://github.com/atrox/sync-dotenv/releases) and install with `dpkg -i` and `rpm -i` respectively.
### Manually
Download the pre-compiled binaries from the [releases page](https://github.com/atrox/sync-dotenv/releases) and copy to the desired location.
## Usage
`sync-dotenv`, by default, looks for a `.env` file in your working directory and synchronizes those keys with your `.env.example` file. Values will **not** be synchronized but existing ones in your example file will be kept.
If your files have different names, you can use the flags `--env .secrets` and `--example .secrets.example`.
If the flag `--watch` is provided, `sync-dotenv` will watch for changes in your working directory and automatically updates your example file.
## CLI
```sh
sync-dotenv helps you to keep your .env.example in sync with your .env file
Usage:
sync-dotenv [flags]
Flags:
--base string base path for all paths (default ".")
--env string path to your env file (default ".env")
--example string path to your example env file (default ".env.example")
-h, --help help for sync-dotenv
-v, --verbose enable verbose messages
--version version for sync-dotenv
-w, --watch watch for file changes and update the example file automatically
```
## Jetbrains IDE
You can automatically call `sync-dotenv` via [File Watchers](https://plugins.jetbrains.com/plugin/7177-file-watchers). Enable the plugin, import the [following XML](/assets/watchers.xml) and your `.env.example` now automatically updates if you change your `.env` file.
## Contributing
Everyone is encouraged to help improve this project. Here are a few ways you can help:
- [Report bugs](https://github.com/atrox/sync-dotenv/issues)
- Fix bugs and [submit pull requests](https://github.com/atrox/sync-dotenv/pulls)
- Write, clarify, or fix documentation
- Suggest or add new features