https://github.com/acro5piano/dotenv-vault
[deprecated] simple dotenv encrypt & decrypt tool inspired by yaml_vault
https://github.com/acro5piano/dotenv-vault
bash cli dotenv password-manager
Last synced: about 1 year ago
JSON representation
[deprecated] simple dotenv encrypt & decrypt tool inspired by yaml_vault
- Host: GitHub
- URL: https://github.com/acro5piano/dotenv-vault
- Owner: acro5piano
- Created: 2018-06-15T06:22:17.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2020-06-04T02:51:14.000Z (about 6 years ago)
- Last Synced: 2025-03-18T18:21:28.868Z (about 1 year ago)
- Topics: bash, cli, dotenv, password-manager
- Language: Shell
- Homepage: https://dev.to/acro5piano/dotenv-vault-no-dependency-env-encrypt-tool-3h5g
- Size: 974 KB
- Stars: 28
- Watchers: 4
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Use git-crypt https://github.com/AGWA/git-crypt
No more maintained. Use other tools.
[](https://circleci.com/gh/acro5piano/dotenv-vault)
# dotenv-vault
simple dotenv encrypt tool inspired by yaml_vault
Default cipher is aes-256-cbc. Default sign digest is SHA256.
# Install
For MacOS:
```
git clone https://github.com/acro5piano/dotenv-vault ~/.dotenv-vault
ln -sfnv ~/.dotenv-vault/bin/dotenv-vault /usr/local/bin/dotenv-vault
```
For Linux:
```
git clone https://github.com/acro5piano/dotenv-vault ~/.dotenv-vault
sudo ln -sfnv ~/.dotenv-vault/bin/dotenv-vault /usr/bin/dotenv-vault
```
## Requirements
dotenv-vault requires the following:
- Bash >= 2
- Openssl >= 2
- Perl >= 5
Almost all machine does not need any additional installation process.
# Usage
## Encrypt
Input file (.env):
```
NODE_ENV=development
API_KEY=123456789
```
Command:
```
$ dotenv-vault -e API_KEY -k foobarbaz encrypt .env
```
where `-e` specify the key you encrypt.
Output:
```
NODE_ENV=development
API_KEY=U2FsdGVkX186T6zdupR27pXHO0Hdnz9rqZfVdgqBEqk=
```
## Decrypt
Input file (.env.encrypted):
```
NODE_ENV=development
API_KEY=U2FsdGVkX186T6zdupR27pXHO0Hdnz9rqZfVdgqBEqk=
```
Command:
```
$ dotenv-vault -e API_KEY -k foobarbaz decrypt .env
```
Output:
```
NODE_ENV=development
API_KEY=123456789
```
## Create Encrypt env
`dotenv-vault create` command is convenient to create new entry:
```
$ bin/dotenv-vault -k foobarbaz create 'SOME_KEY=123456'
# => SOME_KEY=U2FsdGVkX18tEclKImEV30HSG0b7IOu3dyO3MpceCd4=
```
You can paste or redirect to register new entry like this:
```
$ bin/dotenv-vault -k foobarbaz create 'SOME_KEY=123456' >> .env
```
# Options
- `-k` specify password
- `-e` specify the key to encrypt or decrypt. You can use Regular Expression like `-e 'A_KEY|ANOTHER_KEY|SECRET_.*'`
## Password Option
- If `-k` option present, use it as password.
- If `DOTENV_PASSWORD` environment variable present, use it as password.
- If `.dotenv-password` file present, use the content of the file as password.
- Else, dotenv-vault ask you at runtime.
Note you must not include the `.dotenv-password` file to any repo.
# Update
```
cd ~/.dotenv-vault
git pull origin master
```
# Development
After checking out the repo, run `make` to run all tests.
# TODO
- [x] Add `.dotenv-password` to save the password
- [ ] Add auth methods
- [ ] AWS KMS
- [ ] GCP KMS