@dotenvx/dotenvx 0.6.0 → 0.6.2

package/README.md

@@ -2,9 +2,9 @@
 
 *a better dotenv*–from the creator of [`dotenv`](https://github.com/motdotla/dotenv).
 
-* run anywhere (cross-platform)
-* multi-environment
-* encrypted envs
+* [run anywhere](#run-anywhere) (cross-platform)
+* [multi-environment](#multiple-environments)
+* [encrypted envs](#encrypt-your-env-files)
 
  
 
@@ -190,30 +190,109 @@ More examples
 
 ## Multiple Environments
 
-Pass the `--env-file` flag (shorthand `-f`) to run any environment from a `.env.environment` file.
-
+> Create a `.env.production` file and use `--env-file` to load it. It's straightforward, yet flexible.
 ```sh
+$ echo "HELLO=production" > .env.production
+
 $ dotenvx run --env-file=.env.production -- node index.js
-[dotenvx][INFO] injecting 12 environment variables from .env.production
+Hello production
+> ^^
 ```
 
-Combine multiple `.env` files if you like.
+More examples
+
+* <details><summary>multiple `.env` files</summary><br>
 
-```
-$ dotenvx run --env-file=.env.local --env-file=.env -- node index.js
-[dotenvx][INFO] injecting 13 environment variables from .env.local,.env
-```
+  ```sh
+  $ echo "HELLO=local" > .env.local
+
+  $ echo "HELLO=World" > .env
+
+  $ dotenvx run --env-file=.env.local --env-file=.env -- node index.js
+  Hello local
+  ```
+
+  </details>
+
+* <details><summary>`--overload` flag</summary><br>
+
+  ```sh
+  $ echo "HELLO=local" > .env.local
+
+  $ echo "HELLO=World" > .env
+
+  $ dotenvx run --env-file=.env.local --env-file=.env --overload -- node index.js
+  Hello World
+  ```
+
+* <details><summary>`--verbose` flag</summary><br>
+
+  ```sh
+  $ echo "HELLO=production" > .env.production
+
+  $ dotenvx run --env-file=.env.production --verbose -- node index.js
+  [dotenvx][VERBOSE] injecting env from /path/to/.env.production
+  [dotenvx][VERBOSE] HELLO set
+  [dotenvx][INFO] injecting 1 environment variable from .env.production
+  Hello production
+  ```
+
+* <details><summary>`--debug` flag</summary><br>
+
+  ```sh
+  $ echo "HELLO=production" > .env.production
+
+  $ dotenvx run --env-file=.env.production --debug -- node index.js
+  [dotenvx][DEBUG] configuring options
+  [dotenvx][DEBUG] {"envFile":[".env.production"]}
+  [dotenvx][VERBOSE] injecting env from /path/to/.env.production
+  [dotenvx][DEBUG] reading env from /path/to/.env.production
+  [dotenvx][DEBUG] parsing env from /path/to/.env.production
+  [dotenvx][DEBUG] {"HELLO":"production"}
+  [dotenvx][DEBUG] writing env from /path/to/.env.production
+  [dotenvx][VERBOSE] HELLO set
+  [dotenvx][DEBUG] HELLO set to production
+  [dotenvx][INFO] injecting 1 environment variable from .env.production
+  Hello production
+  ```
+
+  </details>
 
 &nbsp;
 
 ## Encrypt Your Env Files
 
+> Encrypt your secrets to a `.env.vault` file.
 ```
+$ echo "HELLO=World" > .env
+
+$ echo "HELLO=production" > .env.production
+
 $ dotenvx encrypt
-```
+[dotenvx][INFO] encrypted .env,.env.production to .env.vault
+[dotenvx][INFO]
+[dotenvx][INFO] try it out:
+[dotenvx][INFO]
+[dotenvx][INFO]     DOTENV_KEY='<DOTENV_KEY_ENVIRONMENT>' dotenvx run -- node index.js
+[dotenvx][INFO]
+[dotenvx][INFO] next:
+[dotenvx][INFO]
+[dotenvx][INFO]     1. commit .env.vault safely to code
+[dotenvx][INFO]     2. set DOTENV_KEY on server (or ci)
+[dotenvx][INFO]     3. push your code
+[dotenvx][INFO]
+[dotenvx][INFO] tips:
+[dotenvx][INFO]
+[dotenvx][INFO]     * .env.keys file holds your decryption DOTENV_KEYs
+[dotenvx][INFO]     * DO NOT commit .env.keys to code
+[dotenvx][INFO]     * share .env.keys file over secure channels only
+
+$ DOTENV_KEY='dotenv://:key_abc123@dotenvx.com/vault/.env.vault?environment=development' dotenvx run -- node index.js
+[dotenvx][INFO] injecting 1 environment variable from encrypted .env.vault
+Hello World
 
-> This will encrypt your `.env` file to a `.env.vault` file. Commit your `.env.vault` file safely to code.
-> This will also generate a `.env.keys` file. Do NOT commit this file to code. Keep your `.env.keys` secret. 🤫
+> :-]
+```
 
 &nbsp;
 
@@ -302,50 +381,41 @@ brew install dotenvx/brew/dotenvx
 
 ### Other Ways to Install
 
-1. After `brew`, installing globally using [`npm`](https://www.npmjs.com/package/@dotenvx/dotenvx) is easiest:
+#### 1. global npm
+
+After `brew`, installing globally using [`npm`](https://www.npmjs.com/package/@dotenvx/dotenvx) is easiest:
 
 ```sh
 npm install @dotenvx/dotenvx --global
 ```
 
-2. Or use with [`npx`](https://www.npmjs.com/package/npx):
-
-```sh
-npx @dotenvx/dotenvx help
-```
+#### 2. local npm
 
-3. Or install in your `package.json`
+Or install in your `package.json`:
 
 ```sh
 npm i @dotenvx/dotenvx --save
 ```
 ```json
-"scripts": {
-  "start": "./node_modules/.bin/dotenvx run -- nodex index.js"
+{
+  "scripts": {
+    "start": "./node_modules/.bin/dotenvx run -- node index.js"
+  },
+  "dependencies": {
+    "@dotenvx/dotenvx": "^0.6.0"
+  }
 }
 ```
 
-3. Or download it directly as a standalone binary:
+#### 3. standalone binary
 
-```sh
-curl -fsS https://dotenvx.sh/ | sh
-```
+Or download it directly as a standalone binary:
 
 ```sh
-# download it to `./dotenvx`
+# download it to `/user/local/bin/dotenvx`
 curl -fsS https://dotenvx.sh/ | sh
 
 # check it works
-./dotenvx help
-
-# move it to `/usr/local/bin/dotenvx`
-sudo install -m 755 dotenvx /usr/local/bin
-
-# check it still works
-/usr/local/bin/dotenvx help
-
-# check it is in your path
-which dotenv
 dotenvx help
 ```
 

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.6.0",
+  "version": "0.6.2",
   "name": "@dotenvx/dotenvx",
   "description": "a better dotenv–from the creator of `dotenv`",
   "author": "@motdotla",

package/src/cli/dotenvx.js

@@ -270,6 +270,22 @@ program.command('encrypt')
     }
 
     logger.info(`encrypted ${optionEnvFile} to .env.vault`)
+    logger.info('')
+    logger.info('try it out:')
+    logger.info('')
+    logger.info('    DOTENV_KEY=\'<DOTENV_KEY_ENVIRONMENT>\' dotenvx run -- node index.js')
+    logger.info('')
+    logger.info('next:')
+    logger.info('')
+    logger.info('    1. commit .env.vault safely to code')
+    logger.info('    2. set DOTENV_KEY on server (or ci)')
+    logger.info('    3. push your code')
+    logger.info('')
+    logger.info('tips:')
+    logger.info('')
+    logger.info('    * .env.keys file holds your decryption DOTENV_KEYs')
+    logger.info('    * DO NOT commit .env.keys to code')
+    logger.info('    * share .env.keys file over secure channels only')
   })
 
 program.parse(process.argv)

package/src/shared/logger.js

@@ -7,14 +7,10 @@ const transports = winston.transports
 
 const packageJson = require('./packageJson')
 
-function pad (word) {
-  return word.padEnd(9, ' ')
-}
-
 const dotenvxFormat = printf(({ level, message, label, timestamp }) => {
   const formattedMessage = typeof message === 'object' ? JSON.stringify(message) : message
 
-  return `[dotenvx@${packageJson.version}]${pad(`[${level.toUpperCase()}]`)} ${formattedMessage}`
+  return `[dotenvx@${packageJson.version}][${level.toUpperCase()}] ${formattedMessage}`
 })
 
 const logger = createLogger({