@dotenvx/dotenvx

Added

• add help text for dashed values on set. example: dotenvx set KEY -- "- + * ÷" (#293)

Changed

• replace @inquirer/confirm and ora (#285)

Removed

• remove dotenvx ext hub, replace with dotenvx-ext-hub (install there to continue using hub) (#291)

Removed

• remove update notice. let users decide what version they want without nagging them to update (#288)
• remove dotenvx hub. still available at dotenvx ext hub (#290)

Changed

• 🐞 remove risky prepare and postinstall scripts and replace with npm run patch for development and binary building (#286)

Added

• encrypt specified keys with --key option - dotenvx encrypt -k HELLO (#281)

Added

• handle nested dotenvx invocations - dotenvx run -- dotenvx run -- env (#279)

Changed

• replace glob with faster approach (#278)

Added

• add TypeScript type definitions (#272)

Changed

• 🐞 fix expansion when preset on process.env and/or with --overload (#271)

🎉 dotenvx has made it to 1.0.0. There are BREAKING CHANGES ⚠️ .

Added

• added dotenvx set KEY value --plain to set plain text values
• added dotenvx ext 🔌 as a location to place extensions like gititgnore, precommit, ls, and more. better than cluttering up core features like run, get/set, and encrypt.
• added dotenvx pro 🏆 command with coming soon and link to GitHub issue (if you wish to be notified of progress. will provide tooling/features for teams)

Changed

• BREAKING ⚠️
  • turned on encryption by default for dotenvx set (use dotenvx set KEY value --plain to set plain values)
  • renamed dotenvx encrypt to dotenvx ext vault encrypt (for managing .env.vault files)
  • renamed dotenvx convert to dotenvx encrypt
  • moved ls to dotenvx ext ls
  • moved genexample to dotenvx ext genexample
  • moved gitignore to dotenvx ext gitignore
  • moved prebuild to dotenvx ext prebuild
  • moved precommit to dotenvx ext precommit
  • moved scan to dotenvx ext scan
  • moved hub to dotenvx ext hub
  • moved vault to dotenvx ext vault
  • moved settings to dotenvx ext settings

(for many of these moved commands, for example dotenvx genexample, still work in 1.0.0 but with a large deprecated notice - DEPRECATION NOTICE: [genexample] has moved to [dotenvx ext genexample]. Please change your muscle memory to dotenvx ext genexample, as these deprecated command paths will be removed in a later minor version. importantly dotenvx encrypt was not able to be preserved because as it is now in use for encrypted .env files rather than .env.vault files)

This is a BIG release that sets the tone for dotenvx's core offering and features while maintaining room for growth. Thank you everyone for your support and usage of dotenvx 🙏.

blog post: "From dotenv to dotenvx: Next Generation Config Management"

Changed

• Rename dotenvx vault convert to dotenvx vault migrate (#251)
• Update install.sh regex version check to be sh compatible (not just bash)

Added

• Added checksums.txt as part of each release

Changed

• Removed .github folder from published binaries on npm (example: npm code)
• Add help message to install.sh

Changed

• Automated deployment of install.sh along with sanity checks (#250)

Added

• Include CHANGELOG.md in npm release
• Include install.sh in package release

Changed

• Fix license in package.json to match project's license BSD-3.

Changed

• Respect decryption of zero length strings - dotenvx set HELLO '' --encrypt (#236)

Added

• Added options.debug, options.verbose, options.quiet, and options.logLevel to .config() (#233)

Changed

• Patch replace when replacing double, single, or backticked quoted at anywhere in the .env file. (#232)

Changed

• Improved replace function regex - to handle more edge case scenarios with replacing KEY/values (#227)

Added

• Support require('@dotenvx/dotenvx').config() for DOTENV_PRIVATE_KEY decryption (#225)

Added

• Added .env.vault deprecated warning when using DOTENV_KEY. Provide instructions to convert to encrypted .env files. (#224)

Added

• Added vault convert command to list convert instructions for converting .env.vault to encrypted .env files (#222)

To convert your .env.vault file to encrypted .env file(s):

  1. Run [dotenvx vault decrypt]
  2. Run [ls -a .env*]

Lastly, convert each .env(.environment) file:

  3. Run [dotenvx convert -f .env.production]

For example:

  $ dotenvx convert -f .env
  $ dotenvx convert -f .env.ci
  $ dotenvx convert -f .env.production

Afterward:

Update production with your new DOTENV_PRIVATE_KEY_PRODUCTION located in .env.keys

Learn more at [https://dotenvx.com/docs/quickstart#add-encryption]

Changed

• Rename encryptme to convert (#222)

Added

• Added dotenvx encryptme command to convert an entire .env file to an encrypted .env file. (#213)

Changed

• Made precommit smart enough to check if a .env* file is encrypted or not. If fully encrypted, then allow precommit check to pass (#211)

Removed

• Do not warn of missing files for conventions (too noisy) (#216)

Added

• Add --convention flag to get

Removed

• Removed help messages like 'in production' and 'in ci'. Too specific and could lead to confusion.

Changed

• ⚠️ DEPRECATION NOTICE: the following commands are being moved. Please, update any code and muscle memory you have related to these:
  • dotenvx encrypt => dotenvx vault encrypt
  • dotenvx decrypt => dotenvx vault decrypt
  • dotenvx status => dotenvx vault status
• ⚠️ DEPRECATION NOTICE: the beta hub commands are being completely deprecated (they will be fully removed in upcoming 1.0.0 release). We will provide .env.keys tooling at a later time (replacing hub) but in the context of the new --encrypt flag functionality below

Added

• Add encryption to your .env files with a single command. Pass the --encrypt flag. 🎉

$ dotenvx set HELLO World --encrypt
set HELLO with encryption (.env)

A DOTENV_PUBLIC_KEY (encryption key) and a DOTENV_PRIVATE_KEY (decryption key) is generated using the same public-key cryptography as Bitcoin.

Further notes:

• DOTENV_PUBLIC_KEY lives in the .env file. You can safely share this with whomever you wish.
• DOTENV_PRIVATE_KEY lives in your .env.keys file. Share this only with those you trust to decrypt your secrets.
• If using encrypted .env files like this it is safe to commit them to source code. This makes reviewing PRs that contain secrets much easier.
• Tell your contributors to contribute a secret using the command dotenvx set HELLO world --encrypt.
• Set your DOTENV_PRIVATE_KEY on your server to decrypt these values using dotenvx run -- yourcommand
• You can repeat all this per environment by modifying your set command to dotenvx set HELLO production -f .env.production --encrypt (for example)
• In time we will add better tooling for sharing the private keys living in .env.keys, but until then safely share with team members you trust.
• This mechanism should be particularly useful for open source projects that want to permit secrets contributions without handing out the decryption keys. Now anyone can contribute a secret and only you can decrypt it to see what was changed.
• This solution is brand new, but I intend it to be the future for .env files. It has many benefits over .env.vault files. We will be sunsetting the .env.vault mechanism but its tooling will stay around in dotenvx for at least 1 year to come - under dotenvx vault parent command.
• Be patient as we update our documentation to prioritize this improved encryption format for .env files.

• warn when running dotenvx status against any untracked (not in .env.vault) files (#196)

• add --convention nextjs flag to dotenvx run (#193)
• improve status error message when decrypt fails or no .env* files (#192)

• handle SIGTERM (#191)

• add dotenvx status command (#186)
• add dotenvx decrypt [directory] argument option (#186)
• add dotenvx decrypt --environment flag option (#186)
• normalize windows \ paths (#186)

Changed

• exit code 1 if get KEY not found/undefined (#185)

Added

• added set command, and optionally pass --env-file flag(s) to set usage: dotenvx set HELLO World (#182)

Changed

• make hub push more forgiving by permitting full filepath like hub push directory/.env.keys (#180)
• add note on generated .env.example (#181)

Changed

• patch injection around falsy values (#177)

Added

• add .env.vault support for .env.something.something (useful for Next.js pattern of .env.development.local) (#174)

Changed

• quiet exit code 1 message (#173)

Changed

• improve error messages (#171)

Added

• add hub logout command (#170)

Changed

• small fixes for windows users related to hub open and hub push (#169)

Changed

• remove windows warnings related to missing git or git origin (#166 #167)

Added

• dotenvx get --quiet will display the value no matter what (adds a blank0 logger level) (#161)

Changed

• refactor dotenvx get to use run under the hood

Changed

• fix broken hub login and hub open (#160)

Changed

• patch situation where DOTENV_KEY is present and --env-file flag is set. assume to still look for .env.vault file as first in line (#157)

Changed

• respect order for --env-vault-file, --env-file and --env flags (for example: dotenvx run --env "HELLO=one" --env-file=.env will prioritize --env flag. Add --overload here to prioritize --env-file or reverse the order.). you can now mix and match multiple flags in any complex order you wish and dotenvx will respect it. (#155)

Added

• add dotenvx settings command to list your current settings. in the future we'll provide ways to modify these settings as dotenvx's functionality grows (#153)

Added

• add windows postrelease step to check that dotenvx.exe is functional immediately after release (#141)

Changed

• replace package-json with undici (#146)
• prune redundant packages (#148)
• return current version if remote version fails (#149)
• switch to our own update notice mechanism (eliminating multiple deps) (#151)

Added

• provide .zip download option for windows executable (#140)

Removed

• remove got from top level deps (#139)

Changed

• move update-notifier into lib/helpers for more control over got lib (#138)
• move clipboardy into lib/helpers for more control and to support commonjs going forward (sindre has dropped support and many mature systems still require commonjs for their infra and have need of dotenvx). (#137)

Added

• add hub pull command to pull a repo's .env.keys down. (#129)

Changed

• 🐞 patch bug with evaluate commands. do not attempt to evaluate risky preset envs in process.env. evaluate only what's set in a .env* file (#125)

Added

• expand hub push with [directory] option. use for monorepos. for example: dotenvx hub push apps/backend (#121)

Added

• add command substitution. for example DATABASE_URL="postgres://$(whoami)@localhost/my_database" (#113)

Added

• support personal environment variables. anything after the comment # personal.dotenvx.com will be considered personal and will not be encrypted to .env.vault (#110)

Added

• require('@dotenvx/dotenvx').config() expands/interpolates variables. this matches the behavior of run. (note that this behavior differs from the original require('dotenv').config() (#107)

Added

• expose genexample function on lib/main.js for export convenience (#102)

Changed

• rely on which npm module to find system command path for user inputted command(s) (#105)

Removed

• remove main.inject function (#102)

Added

• added support for --env flag on the .env.vault decryption portion of run (#101)

Changed

• use system command path (#98)

Changed

• added --env flag. for example, dotenvx --env="HELLO=World" -- yourcommand (#94)

Changed

• patched up the precommit command (#91)

Added

• added scan command to scan for possible leaked secrets in your code (#90)