This project provides a command-line tool for encrypting and decrypting .env
files, making it easy to protect sensitive configuration data, especially when storing .env
files in less secure environments.
- Encrypt an
.env
file to a.env_enc
file. - Decrypt a
.env_enc
file back to a.env
file. - Convert an encrypted file into a decrypted file.
npm install -g encryptmy-env
- Set the
ENV_ENC_KEY
environment variable to your desired encryption key. You can do this by adding the following line to your.env
file:
ENV_ENC_KEY=<your-desired-encryption-key>
npx encryptmyenv --help
npx encryptmyenv encrypt --file <path-to-env-file> --key <encryption-key>
npx encryptmyenv decrypt --file <path-to-env-file> --key <encryption-key>
Note that the --key
and --file
options are optional. If you do not specify the --key
option and there is no ENV_ENC_KEY in .env file, the tool will generate a random encryption key for you. If you do not specify the --file
option, the tool will look for an .env
file in the root directory.
npx encryptmyenv convert --file '.env' --key 'MYGENERATEDKEY'
import { DecryptEnvFile } from 'encryptmy-env'
DecryptEnvFile({encryptionKey:<your-encryption-key>})