@dotenvx/dotenvx 0.6.4 → 0.6.6

package/README.md

@@ -2,9 +2,9 @@
 
 *a better dotenv*–from the creator of [`dotenv`](https://github.com/motdotla/dotenv).
 
-* [run anywhere](#run-anywhere) (cross-platform)
-* [multi-environment](#multiple-environments)
-* [encrypted envs](#encryption)
+* run anywhere (cross-platform)
+* multi-environment
+* encrypted envs
 
  
 
@@ -21,7 +21,8 @@ brew install dotenvx/brew/dotenvx
 ## Run Anywhere
 
 ```sh
-$ echo "HELLO=World" > .env && echo "console.log('Hello ' + process.env.HELLO)" > index.js
+$ echo "HELLO=World" > .env
+$ echo "console.log('Hello ' + process.env.HELLO)" > index.js
 
 $ node index.js
 Hello undefined
@@ -36,7 +37,8 @@ More examples
 * <details><summary>Python 🐍</summary><br>
 
   ```sh
-  $ echo "HELLO=World" > .env && echo 'import os;print("Hello " + os.getenv("HELLO", ""))' > index.py
+  $ echo "HELLO=World" > .env
+  $ echo 'import os;print("Hello " + os.getenv("HELLO", ""))' > index.py
 
   $ dotenvx run -- python3 index.py
   Hello World
@@ -46,7 +48,8 @@ More examples
 * <details><summary>PHP 🐘</summary><br>
 
   ```sh
-  $ echo "HELLO=World" > .env && echo '<?php echo "Hello {$_SERVER["HELLO"]}\n";' > index.php
+  $ echo "HELLO=World" > .env
+  $ echo '<?php echo "Hello {$_SERVER["HELLO"]}\n";' > index.php
 
   $ dotenvx run -- php index.php
   Hello World
@@ -56,17 +59,30 @@ More examples
 * <details><summary>Ruby 💎</summary><br>
 
   ```sh
-  $ echo "HELLO=World" > .env && echo 'puts "Hello #{ENV["HELLO"]}"' > index.rb
+  $ echo "HELLO=World" > .env
+  $ echo 'puts "Hello #{ENV["HELLO"]}"' > index.rb
 
   $ dotenvx run -- ruby index.rb
   Hello World
   ```
 
+  </details>
+* <details><summary>Go 🐹</summary><br>
+
+  ```sh
+  $ echo "HELLO=World" > .env
+  $ echo 'package main; import ("fmt"; "os"); func main() { fmt.Printf("Hello %s\n", os.Getenv("HELLO")) }' > main.go
+
+  $ dotenvx run -- go run main.go
+  Hello World
+  ```
+
   </details>
 * <details><summary>Rust 🦀</summary><br>
 
   ```sh
-  $ echo "HELLO=World" > .env && echo 'fn main() {let hello = std::env::var("HELLO").unwrap_or("".to_string());println!("Hello {hello}");}' > src/main.rs
+  $ echo "HELLO=World" > .env
+  $ echo 'fn main() {let hello = std::env::var("HELLO").unwrap_or("".to_string());println!("Hello {hello}");}' > src/main.rs
 
   $ dotenvx run -- cargo run
   Hello World
@@ -76,7 +92,8 @@ More examples
 * <details><summary>Java ☕️</summary><br>
 
   ```sh
-  $ echo "HELLO=World" > .env && echo 'public class Index { public static void main(String[] args) { System.out.println("Hello " + System.getenv("HELLO")); } }' > index.java
+  $ echo "HELLO=World" > .env
+  $ echo 'public class Index { public static void main(String[] args) { System.out.println("Hello " + System.getenv("HELLO")); } }' > index.java
 
   $ dotenvx run -- java index.java
   Hello World
@@ -88,7 +105,8 @@ More examples
   ```sh
   $ dotnet new console -n HelloWorld -o HelloWorld
   $ cd HelloWorld
-  $ echo "HELLO=World" > .env && echo 'Console.WriteLine($"Hello {Environment.GetEnvironmentVariable("HELLO")}");' > Program.cs && echo "HELLO=World" > .env
+  $ echo "HELLO=World" > .env
+  $ echo 'Console.WriteLine($"Hello {Environment.GetEnvironmentVariable("HELLO")}");' > Program.cs
 
   $ dotenvx run -- dotnet run
   Hello World
@@ -169,7 +187,7 @@ More examples
   > start
   > ./node_modules/.bin/dotenvx run -- node index.js
 
-  [dotenvx][INFO] injecting 1 environment variable from .env
+  [dotenvx][info] loading env (1) from .env
   Hello World
   ```
 
@@ -192,9 +210,11 @@ More examples
 
 > Create a `.env.production` file and use `--env-file` to load it. It's straightforward, yet flexible.
 ```sh
-$ echo "HELLO=production" > .env.production && echo "console.log('Hello ' + process.env.HELLO)" > index.js
+$ echo "HELLO=production" > .env.production
+$ echo "console.log('Hello ' + process.env.HELLO)" > index.js
 
 $ dotenvx run --env-file=.env.production -- node index.js
+[dotenvx][info] loading env (1) from .env.production
 Hello production
 > ^^
 ```
@@ -209,6 +229,7 @@ More examples
   $ echo "HELLO=World" > .env
 
   $ dotenvx run --env-file=.env.local --env-file=.env -- node index.js
+  [dotenvx][info] loading env (1) from .env.local,.env
   Hello local
   ```
 
@@ -222,6 +243,7 @@ More examples
   $ echo "HELLO=World" > .env
 
   $ dotenvx run --env-file=.env.local --env-file=.env --overload -- node index.js
+  [dotenvx][info] loading env (1) from .env.local,.env
   Hello World
   ```
 
@@ -231,9 +253,9 @@ More examples
   $ 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
+  [dotenvx][verbose] injecting env from /path/to/.env.production
+  [dotenvx][verbose] HELLO set
+  [dotenvx][info] loading env (1) from .env.production
   Hello production
   ```
 
@@ -243,16 +265,16 @@ More examples
   $ 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
+  [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] loading env (1) from .env.production
   Hello production
   ```
 
@@ -262,43 +284,20 @@ More examples
 
 ## Encryption
 
-> Encrypt your secrets to a `.env.vault` file.
-```
-$ echo "HELLO=World" > .env && echo "console.log('Hello ' + process.env.HELLO)" > index.js
-
+> Encrypt your secrets to a `.env.vault` file and load from it (recommended for production and ci).
+```sh
+$ echo "HELLO=World" > .env
 $ echo "HELLO=production" > .env.production
+$ echo "console.log('Hello ' + process.env.HELLO)" > index.js
 
 $ 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
-> :-]
-```
-
-&nbsp;
+[dotenvx][info] encrypted to .env.vault (.env,.env.production)
+[dotenvx][info] keys added to .env.keys (DOTENV_KEY_PRODUCTION,DOTENV_KEY_PRODUCTION)
 
-> Then load env from encrypted `.env.vault` file
-
-```sh
-$ DOTENV_KEY='dotenv://:key_abc123@dotenvx.com/vault/.env.vault?environment=production' dotenvx run -- node index.js
-[dotenvx][INFO] injecting 1 environment variable from encrypted .env.vault
+$ DOTENV_KEY='<dotenv_key_production>' dotenvx run -- node index.js
+[dotenvx][info] loading env (1) from encrypted .env.vault
 Hello production
-
-> :-]
+^ :-]
 ```
 
 More examples
@@ -402,81 +401,10 @@ More examples
 
 &nbsp;
 
----
-
-## Usage
-
-### Guide
-
-Begin by creating a simple 'hello world' program.
-
-```js
-// index.js
-console.log(`Hello ${process.env.HELLO}`)
-```
-
-Run it.
-
-```js
-$ node index.js
-Hello undefined
-```
-
-Run it with `dotenvx`.
-
-```sh
-$ dotenvx run -- node index.js
-[dotenvx][WARN] ENOENT: no such file or directory, open '/../../.env'
-Hello undefined
-```
-
-It warns you when there is no `.env` file (pass the `--quiet` flag to suppress these warnings).
-
-Create the `.env` file.
-
-```ini
-# env
-JELLO="World"
-```
-
-Run it again.
-
-```sh
-$ dotenvx run -- node index.js
-[dotenvx][INFO] injecting 0 environment variables from .env
-Hello undefined
-```
+## Guides
 
-Hrm, still undefined. Pass the `--debug` flag to debug the issue. I'll give you a hint: 🍮
-
-```sh
-$ dotenvx run --debug -- node index.js
-[dotenvx][VERBOSE] Loading env from /../../.env
-[dotenvx][DEBUG] Reading env from /../../.env
-[dotenvx][DEBUG] Parsing env from /../../.env
-[dotenvx][DEBUG] {"JELLO":"World"}
-
-# Oops, HELLO not JELLO ^^
-```
-
-Fix your `.env` file.
-
-```ini
-# .env
-HELLO="World"
-```
-
-One last time. [Le tired](https://youtu.be/kCpjgl2baLs?t=45).
-
-```sh
-$ dotenvx run -- node index.js
-[dotenvx][INFO] injecting 1 environment variable from .env
-Hello World
-```
-
-🎉 It worked!
-
-&nbsp;
+* [dotenvx/docs](https://dotenvx.com/docs)
+* [quickstart guide](https://dotenvx.com/docs/quickstart)
 
 ## Contributing
 

package/package.json

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

package/src/cli/dotenvx.js

@@ -9,6 +9,7 @@ const ENCODING = 'utf8'
 
 const logger = require('./../shared/logger')
 const helpers = require('./helpers')
+const examples = require('./examples')
 const { AppendToIgnores } = require('./ignores')
 const packageJson = require('./../shared/packageJson')
 const main = require('./../lib/main')
@@ -53,7 +54,8 @@ program
 
 // dotenvx run -- node index.js
 program.command('run')
-  .description('inject env variables into your application process')
+  .description('inject env at runtime (example: `dotenvx run -- your-cmd`)')
+  .addHelpText('after', examples.run)
   .option('-f, --env-file <paths...>', 'path(s) to your env file(s)', '.env')
   .option('-o, --overload', 'override existing env variables')
   .action(function () {
@@ -68,7 +70,7 @@ program.command('run')
       if (!fs.existsSync(filepath)) {
         logger.error(`you set DOTENV_KEY but your .env.vault file is missing: ${filepath}`)
       } else {
-        logger.verbose(`injecting encrypted env from ${filepath}`)
+        logger.verbose(`loading env from encrypted ${filepath}`)
 
         try {
           logger.debug(`reading encrypted env from ${filepath}`)
@@ -112,7 +114,7 @@ program.command('run')
           logger.debug(`writing decrypted env from ${filepath}`)
           const result = main.write(process.env, parsed, options.overload)
 
-          logger.info(`injecting ${result.written.size} environment ${helpers.pluralize('variable', result.written.size)} from encrypted .env.vault`)
+          logger.info(`loading env (${result.written.size}) from encrypted .env.vault`)
         } catch (e) {
           logger.error(e)
         }
@@ -130,7 +132,7 @@ program.command('run')
       for (const envFilepath of optionEnvFile) {
         const filepath = helpers.resolvePath(envFilepath)
 
-        logger.verbose(`injecting env from ${filepath}`)
+        logger.verbose(`loading env from ${filepath}`)
 
         try {
           logger.debug(`reading env from ${filepath}`)
@@ -150,7 +152,7 @@ program.command('run')
       }
 
       if (readableFilepaths.size > 0) {
-        logger.info(`injecting ${written.size} environment ${helpers.pluralize('variable', written.size)} from ${[...readableFilepaths]}`)
+        logger.info(`loading env (${written.size}) from ${[...readableFilepaths]}`)
       }
     }
 
@@ -169,6 +171,7 @@ program.command('run')
 // dotenvx encrypt
 program.command('encrypt')
   .description('encrypt .env.* to .env.vault')
+  .addHelpText('after', examples.encrypt)
   .option('-f, --env-file <paths...>', 'path(s) to your env file(s)', helpers.findEnvFiles('./'))
   .action(function () {
     const options = this.opts()
@@ -180,6 +183,8 @@ program.command('encrypt')
       optionEnvFile = [optionEnvFile]
     }
 
+    const addedKeys = new Set()
+
     try {
       logger.verbose(`generating .env.keys from ${optionEnvFile}`)
 
@@ -203,6 +208,8 @@ program.command('encrypt')
           logger.debug(`generating ${key} as ${value}`)
 
           dotenvKeys[key] = value
+
+          addedKeys.add(key) // for info logging to user
         } else {
           logger.verbose(`existing ${key}`)
           logger.debug(`existing ${key} as ${value}`)
@@ -269,23 +276,26 @@ program.command('encrypt')
       process.exit(1)
     }
 
-    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')
+    logger.info(`encrypted to .env.vault (${optionEnvFile})`)
+    if (addedKeys.size > 0) {
+      logger.info(`${helpers.pluralize('key', addedKeys.size)} added to .env.keys (${[...addedKeys]})`)
+    }
+    logger.verbose('')
+    logger.verbose('try it out:')
+    logger.verbose('')
+    logger.verbose('    DOTENV_KEY=\'<DOTENV_KEY_ENVIRONMENT>\' dotenvx run -- node index.js')
+    logger.verbose('')
+    logger.verbose('next:')
+    logger.verbose('')
+    logger.verbose('    1. commit .env.vault safely to code')
+    logger.verbose('    2. set DOTENV_KEY on server (or ci)')
+    logger.verbose('    3. push your code')
+    logger.verbose('')
+    logger.verbose('tips:')
+    logger.verbose('')
+    logger.verbose('    * .env.keys file holds your decryption DOTENV_KEYs')
+    logger.verbose('    * DO NOT commit .env.keys to code')
+    logger.verbose('    * share .env.keys file over secure channels only')
   })
 
 program.parse(process.argv)

package/src/cli/examples.js

@@ -0,0 +1,51 @@
+const run = function () {
+  return `
+Example:
+
+  \`\`\`sh
+  $ dotenvx run -- your-cmd
+  \`\`\`
+
+Try it:
+
+  \`\`\`sh
+  $ echo "HELLO=World" > .env
+  $ echo "console.log('Hello ' + process.env.HELLO)" > index.js
+
+  $ dotenvx run -- node index.js
+  [dotenvx][info] loading env (1) from .env
+  Hello World
+  \`\`\`
+  `
+}
+
+const encrypt = function () {
+  return `
+Example:
+
+  \`\`\`sh
+  $ dotenvx encrypt
+  \`\`\`
+
+Try it:
+
+  \`\`\`sh
+  $ echo "HELLO=World" > .env
+  $ echo "HELLO=production" > .env.production
+  $ echo "console.log('Hello ' + process.env.HELLO)" > index.js
+
+  $ dotenvx encrypt
+  [dotenvx][info] encrypted to .env.vault (.env,.env.production)
+  [dotenvx][info] keys added to .env.keys (DOTENV_KEY_PRODUCTION,DOTENV_KEY_PRODUCTION)
+
+  $ DOTENV_KEY='<dotenv_key_production>' dotenvx run -- node index.js
+  [dotenvx][info] loading env (1) from encrypted .env.vault
+  Hello production
+  \`\`\`
+  `
+}
+
+module.exports = {
+  run,
+  encrypt
+}

package/src/shared/logger.js

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