Env Ops!

pkg/yqlib/doc/Env Variable Operators.md

@@ -1,21 +1,76 @@
 
+## Read string environment variable
+Running
+```bash
+myenv="cat meow" yq eval --null-input '.a = env(myenv)'
+```
+will output
+```yaml
+a: cat meow
+```
+
+## Read boolean environment variable
+Running
+```bash
+myenv="true" yq eval --null-input '.a = env(myenv)'
+```
+will output
+```yaml
+a: true
+```
+
+## Read numeric environment variable
+Running
+```bash
+myenv="12" yq eval --null-input '.a = env(myenv)'
+```
+will output
+```yaml
+a: 12
+```
+
+## Read yaml environment variable
+Running
+```bash
+myenv="{b: fish}" yq eval --null-input '.a = env(myenv)'
+```
+will output
+```yaml
+a: {b: fish}
+```
+
 ## Read boolean environment variable as a string
 Running
 ```bash
-myenv="true" yq eval --null-input 'strenv(myenv)'
+myenv="true" yq eval --null-input '.a = strenv(myenv)'
 ```
 will output
 ```yaml
-12
+a: "true"
 ```
 
 ## Read numeric environment variable as a string
 Running
 ```bash
-myenv="12" yq eval --null-input 'strenv(myenv)'
+myenv="12" yq eval --null-input '.a = strenv(myenv)'
 ```
 will output
 ```yaml
-12
+a: "12"
+```
+
+## Dynamic key lookup with environment variable
+Given a sample.yml file of:
+```yaml
+cat: meow
+dog: woof
+```
+then
+```bash
+myenv="cat" yq eval '.[env(myenv)]' sample.yml
+```
+will output
+```yaml
+meow
 ```
 

pkg/yqlib/doc/Traverse.md

@@ -48,6 +48,24 @@ will output
 frog
 ```
 
+## Dynamic keys
+Expressions within [] can be used to dynamically lookup / calculate keys
+
+Given a sample.yml file of:
+```yaml
+b: apple
+apple: crispy yum
+banana: soft yum
+```
+then
+```bash
+yq eval '.[.b]' sample.yml
+```
+will output
+```yaml
+crispy yum
+```
+
 ## Children don't exist
 Nodes are added dynamically while traversing