@dotenvx/dotenvx 0.6.5 → 0.6.6

package/README.md

@@ -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,7 +59,8 @@ 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
@@ -66,7 +70,8 @@ More examples
 * <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
+  $ 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
@@ -76,7 +81,8 @@ More examples
 * <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
@@ -86,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
@@ -98,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
@@ -276,22 +284,16 @@ 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 to .env.vault (.env,.env.production)
-[dotenvx][info] key added to .env.keys (DOTENV_KEY_PRODUCTION)
-```
+[dotenvx][info] keys added to .env.keys (DOTENV_KEY_PRODUCTION,DOTENV_KEY_PRODUCTION)
 
-&nbsp;
-
-> Then load env from encrypted `.env.vault` file
-
-```sh
 $ DOTENV_KEY='<dotenv_key_production>' dotenvx run -- node index.js
 [dotenvx][info] loading env (1) from encrypted .env.vault
 Hello production

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.6.5",
+  "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('load env 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 () {
@@ -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()

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
+}