@dotenvx/dotenvx 0.10.5 → 0.11.0

package/README.md

@@ -11,10 +11,30 @@
 
 ### Quickstart
 
+Install and use it in code just like `dotenv`.
+
+```sh
+npm install @dotenvx/dotenvx --save
+```
+```js
+// index.js
+require('@dotenvx/dotenvx').config()
+
+console.log(`Hello ${process.env.HELLO}`)
+```
+
+ 
+
+Or install globally
+
 ```sh
 brew install dotenvx/brew/dotenvx
 ```
-> * [other ways to install](https://dotenvx.com/docs/install)
+> * [other global ways to install](https://dotenvx.com/docs/install)
+>
+> Installing globally as a cli unlocks dotenv for ANY language, framework, or platform. 💥
+>
+> I am using (and recommending) this approach going forward. – [motdotla](https://github.com/motdotla)
 
  
 
@@ -134,6 +154,14 @@ More examples
   World
   ```
 
+  </details>
+* <details><summary>Cron ⏰</summary><br>
+
+  ```sh
+  # run every day at 8am
+  0 8 * * * dotenvx run -- /path/to/myscript.sh
+  ```
+
   </details>
 * <details><summary>Frameworks ▲</summary><br>
 
@@ -329,6 +357,33 @@ More examples
   ```
 
   </details>
+* <details><summary>`--quiet` flag</summary><br>
+
+  Use `--quiet` to suppress all output (except errors).
+
+  ```sh
+  $ echo "HELLO=production" > .env.production
+
+  $ dotenvx run --env-file=.env.production --quiet -- node index.js
+  Hello production
+  ```
+
+  </details>
+* <details><summary>`--log-level` flag</summary><br>
+
+  Set `--log-level` to whatever you wish. For example, to supress warnings (risky), set log level to `error`:
+
+  ```sh
+  $ echo "HELLO=production" > .env.production
+
+  $ dotenvx run --env-file=.env.production --log-level=error -- node index.js
+  Hello production
+  ```
+
+  Available log levels are `error, warn, info, verbose, debug, silly`
+
+  </details>
+
 
 &nbsp;
 

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.10.5",
+  "version": "0.11.0",
   "name": "@dotenvx/dotenvx",
   "description": "a better dotenv–from the creator of `dotenv`",
   "author": "@motdotla",
@@ -30,7 +30,7 @@
     "clipboardy": "^2.3.0",
     "commander": "^11.1.0",
     "conf": "^10.2.0",
-    "dotenv": "^16.3.1",
+    "dotenv": "^16.4.0",
     "execa": "^5.1.1",
     "ignore": "^5.3.0",
     "open": "^8.4.2",

package/src/cli/actions/encrypt.js

@@ -4,7 +4,6 @@ const main = require('./../../lib/main')
 const logger = require('./../../shared/logger')
 const helpers = require('./../helpers')
 const createSpinner = require('./../../shared/createSpinner')
-const { AppendToIgnores } = require('./../ignores')
 
 const spinner = createSpinner('encrypting')
 
@@ -12,8 +11,6 @@ const spinner = createSpinner('encrypting')
 const ENCODING = 'utf8'
 
 async function encrypt () {
-  new AppendToIgnores().run()
-
   spinner.start()
   await helpers.sleep(500) // better dx
 

package/src/cli/actions/run.js

@@ -2,13 +2,10 @@ const fs = require('fs')
 const logger = require('./../../shared/logger')
 const helpers = require('./../helpers')
 const main = require('./../../lib/main')
-const { AppendToIgnores } = require('./../ignores')
 
 const ENCODING = 'utf8'
 
 async function run () {
-  new AppendToIgnores().run()
-
   const commandArgs = this.args
   logger.debug(`process command [${commandArgs.join(' ')}]`)
 

package/src/lib/main.js

@@ -6,7 +6,21 @@ const config = function (options) {
 }
 
 const decrypt = function (encrypted, keyStr) {
-  return dotenv.decrypt(encrypted, keyStr)
+  try {
+    return dotenv.decrypt(encrypted, keyStr)
+  } catch (e) {
+    switch (e.code) {
+      case 'DECRYPTION_FAILED':
+        // more helpful error when decryption fails
+        logger.error('[DECRYPTION_FAILED] Unable to decrypt .env.vault with DOTENV_KEY.')
+        logger.help('[DECRYPTION_FAILED] Run with debug flag [dotenvx run --debug -- yourcommand] or manually run [echo $DOTENV_KEY] to compare it to the one in .env.keys.')
+        logger.debug(`[DECRYPTION_FAILED] DOTENV_KEY is ${process.env.DOTENV_KEY}`)
+        process.exit(1)
+        break
+      default:
+        throw e
+    }
+  }
 }
 
 const configDotenv = function (options) {