https://github.com/makerxstudio/envolver
.env evolver to improve the dev experience of working on projects with evolving .env files
https://github.com/makerxstudio/envolver
env library nodejs oss
Last synced: 2 months ago
JSON representation
.env evolver to improve the dev experience of working on projects with evolving .env files
- Host: GitHub
- URL: https://github.com/makerxstudio/envolver
- Owner: MakerXStudio
- License: mit
- Created: 2024-02-20T05:39:02.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-10T13:59:35.000Z (about 2 years ago)
- Last Synced: 2025-06-17T11:50:41.620Z (about 1 year ago)
- Topics: env, library, nodejs, oss
- Language: TypeScript
- Homepage:
- Size: 485 KB
- Stars: 0
- Watchers: 10
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Envolver
Envolver is a CLI (Command Line Interface) tool that streamlines the management of environment variables in your local .env file. Developed in TypeScript, it simplifies the task of handling frequently changing environment variables, especially in projects with multiple contributors. For a more detailed explanation of its uses and some real-life scenarios where Envolver shines, check out [our blog post](https://blog.makerx.com.au/envolver-a-cli-tool-for-managing-environment-variables/).
## Environment Variables
Environment variables are key-value pairs typically stored in a .env file. They are used to store sensitive information like API keys and passwords separate from the main codebase. These variables often change, especially in projects with multiple contributors, which can make them difficult to keep updated. Envolver helps manage these changes effectively.
## Check Variables
The `check` command compares your local .env file to the latest changes in the code repository.
```bash
envolver check -o
```
### Options
| Option | Description | Default |
| ----------------------- | ----------------------------------------------------- | --------- |
| `` | The path to your `.env` file. Required argument. | N/A |
| `-o, --output ` | The output method. Can be either 'json' or 'console'. | 'console' |
## Update Variables
The `update` command generates a vars.json file that summarizes your current environment variables. This file can be included in the code repository or added to your .gitignore file if it contains sensitive information.
```bash
envolver update
```
Envolver also organizes the variables into sections for easier management.
## Automating Updates
You can configure Envolver to run automatically as part of a GitHub Actions workflow. This ensures your environment variables are always synchronized with the latest changes in the code repository.
```yaml
name: Update Environment Variables
on:
push:
branches: [prod]
jobs:
build:
runs-on: ubuntu-22.04
steps:
- name: Checkout Repo Code
uses: actions/checkout@v3
- name: Update Variables
run: npx envolver update .env.sample
- name: Commit to repo
uses: actions/github-script@v6
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
script: |
github.rest.git.createCommit({
owner: context.repo.owner,
repo: context.repo.repo,
message: "Updated environment variables",
tree: env.object_tree,
parents: [env.parent]
});
```