@dotenvx/dotenvx 0.6.1 → 0.6.3

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](#encryption)
 
  
 
@@ -14,7 +14,7 @@
 ```sh
 brew install dotenvx/brew/dotenvx
 ```
-> * [other ways to install](#other-ways-to-install)
+> * [other ways to install](https://dotenvx.com/docs/install)
 
  
 
@@ -36,7 +36,7 @@ More examples
 * <details><summary>Python 🐍</summary><br>
 
   ```sh
-  $ 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 +46,7 @@ More examples
 * <details><summary>PHP 🐘</summary><br>
 
   ```sh
-  $ 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,7 +56,7 @@ More examples
 * <details><summary>Ruby 💎</summary><br>
 
   ```sh
-  $ 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
@@ -66,7 +66,7 @@ More examples
 * <details><summary>Rust 🦀</summary><br>
 
   ```sh
-  $ 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 +76,7 @@ More examples
 * <details><summary>Java ☕️</summary><br>
 
   ```sh
-  $ 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 +88,7 @@ More examples
   ```sh
   $ dotnet new console -n HelloWorld -o HelloWorld
   $ cd HelloWorld
-  $ 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 && echo "HELLO=World" > .env
 
   $ dotenvx run -- dotnet run
   Hello World
@@ -190,33 +190,220 @@ 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 && echo "console.log('Hello ' + process.env.HELLO)" > index.js
+
 $ 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
 
-```
-$ dotenvx run --env-file=.env.local --env-file=.env -- node index.js
-[dotenvx][INFO] injecting 13 environment variables from .env.local,.env
-```
+* <details><summary>multiple `.env` files</summary><br>
+
+  ```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
+## Encryption
 
+> Encrypt your secrets to a `.env.vault` file.
 ```
+$ echo "HELLO=World" > .env && echo "console.log('Hello ' + process.env.HELLO)" > index.js
+
+$ 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
+> :-]
 ```
 
-> 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;
+
+> 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
+Hello production
+
+> :-]
+```
+
+More examples
+
+* <details><summary>AWS Lambda</summary><br>
+
+  ```sh
+  coming soon
+  ```
+
+  </details>
+
+* <details><summary>Digital Ocean</summary><br>
+
+  ```sh
+  coming soon
+  ```
+
+  </details>
+
+* <details><summary>Docker</summary><br>
+
+  ```sh
+  coming soon
+  ```
+
+  </details>
+
+
+* <details><summary>Fly.io</summary><br>
+
+  ```sh
+  coming soon
+  ```
+
+  </details>
+
+* <details><summary>Heroku</summary><br>
+
+  ```sh
+  coming soon
+  ```
+
+  </details>
+
+* <details><summary>Laravel Forge</summary><br>
+
+  ```sh
+  coming soon
+  ```
+
+  </details>
+
+* <details><summary>Netlify</summary><br>
+
+  ```sh
+  coming soon
+  ```
+
+  </details>
+
+* <details><summary>Railway</summary><br>
+
+  ```sh
+  coming soon
+  ```
+
+  </details>
+
+* <details><summary>Render</summary><br>
+
+  ```sh
+  coming soon
+  ```
+
+  </details>
+
+* <details><summary>Vercel</summary><br>
+
+  ```sh
+  coming soon
+  ```
+
+  </details>
+
+* <details><summary>CircleCI</summary><br>
+
+  ```sh
+  coming soon
+  ```
+
+  </details>
+
+* <details><summary>GitHub Actions</summary><br>
+
+  ```sh
+  coming soon
+  ```
+
+  </details>
 
 &nbsp;
 
+---
+
 ## Usage
 
 ### Guide
@@ -291,58 +478,9 @@ Hello World
 
 &nbsp;
 
-
-## Install
-
-Installing with [`brew`](https://brew.sh) is most straight forward:
-
-```sh
-brew install dotenvx/brew/dotenvx
-```
-
-### Other Ways to Install
-
-#### 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. local npm
-
-Or install in your `package.json`:
-
-```sh
-npm i @dotenvx/dotenvx --save
-```
-```json
-{
-  "scripts": {
-    "start": "./node_modules/.bin/dotenvx run -- node index.js"
-  },
-  "dependencies": {
-    "@dotenvx/dotenvx": "^0.6.0"
-  }
-}
-```
-
-#### 3. standalone binary
-
-Or download it directly as a standalone binary:
-
-```sh
-# download it to `/user/local/bin/dotenvx`
-curl -fsS https://dotenvx.sh/ | sh
-
-# check it works
-dotenvx help
-```
-
 ## Contributing
 
-If you have questions or feedback:
+You can fork this repo and create [pull requests](https://github.com/dotenvx/dotenvx/pulls) or if you have questions or feedback:
 
 * [github.com/dotenvx/dotenvx](https://github.com/dotenvx/dotenvx/issues) - bugs and discussions
 * [@dotenvx 𝕏](https://x.com/dotenvx) (DMs are open)

package/package.json

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

package/src/cli/dotenvx.js

@@ -210,9 +210,9 @@ program.command('encrypt')
       }
 
       let keysData = `#/!!!!!!!!!!!!!!!!!!!.env.keys!!!!!!!!!!!!!!!!!!!!!!/
-  #/   DOTENV_KEYs. DO NOT commit to source control   /
-  #/   [how it works](https://dotenv.org/env-keys)    /
-  #/--------------------------------------------------/\n`
+#/   DOTENV_KEYs. DO NOT commit to source control   /
+#/   [how it works](https://dotenv.org/env-keys)    /
+#/--------------------------------------------------/\n`
 
       for (const key in dotenvKeys) {
         const value = dotenvKeys[key]
@@ -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)