Updating docs

pkg/yqlib/doc/operators/headers/Main.md

@@ -5,7 +5,7 @@
 
 yq [eval/eval-all] [expression] files..
 
-eval/e  - Apply the expression to each document in each yaml file in sequence
+eval/e  - (default) Apply the expression to each document in each yaml file in sequence
 
 eval-all/ea - Loads all yaml documents of all yaml files and runs expression once
 
@@ -18,32 +18,33 @@ This documentation is also available at https://mikefarah.gitbook.io/yq/
 
 ## Read a value:
 ```bash
-yq e '.a.b[0].c' file.yaml
+yq '.a.b[0].c' file.yaml
 ```
 
 ## Pipe from STDIN:
 ```bash
-cat file.yaml | yq e '.a.b[0].c' -
+cat file.yaml | yq '.a.b[0].c'
 ```
 
 ## Update a yaml file, inplace
 ```bash
-yq e -i '.a.b[0].c = "cool"' file.yaml
+yq -i '.a.b[0].c = "cool"' file.yaml
 ```
 
 ## Update using environment variables
 ```bash
-NAME=mike yq e -i '.a.b[0].c = strenv(NAME)' file.yaml
+NAME=mike yq -i '.a.b[0].c = strenv(NAME)' file.yaml
 ```
 
 ## Merge multiple files
 ```
 yq ea '. as $item ireduce ({}; . * $item )' path/to/*.yml
 ```
+Note the use of `ea` to evaluate all files at once (instead of in sequence.)
 
 ## Multiple updates to a yaml file
 ```bash
-yq e -i '
+yq -i '
   .a.b[0].c = "cool" |
   .x.y.z = "foobar" |
   .person.name = strenv(NAME)

pkg/yqlib/doc/operators/headers/env-variable-operators.md

@@ -13,6 +13,6 @@ To replace environment variables across all values in a document, `envsubst` can
 as follows:
 
 ```bash
-yq eval '(.. | select(tag == "!!str")) |= envsubst' file.yaml
+yq '(.. | select(tag == "!!str")) |= envsubst' file.yaml
 ```
 

pkg/yqlib/doc/operators/headers/recursive-descent-glob.md

@@ -8,7 +8,7 @@ This will, like the `jq` equivalent, recursively match all _value_ nodes. Use it
 For instance to set the `style` of all _value_ nodes in a yaml doc, excluding map keys:
 
 ```bash
-yq eval '.. style= "flow"' file.yaml
+yq '.. style= "flow"' file.yaml
 ```
 
 ## match values and map keys form `...`
@@ -17,5 +17,5 @@ The also includes map keys in the results set. This is particularly useful in YA
 For instance to set the `style` of all nodes in a yaml doc, including the map keys:
 
 ```bash
-yq eval '... style= "flow"' file.yaml
+yq '... style= "flow"' file.yaml
 ```

pkg/yqlib/doc/operators/headers/sort-keys.md

@@ -5,7 +5,9 @@ The Sort Keys operator sorts maps by their keys (based on their string value). T
 Sort is particularly useful for diffing two different yaml documents:
 
 ```bash
-yq eval -i -P 'sort_keys(..)' file1.yml
-yq eval -i -P 'sort_keys(..)' file2.yml
+yq -i -P 'sort_keys(..)' file1.yml
+yq -i -P 'sort_keys(..)' file2.yml
 diff file1.yml file2.yml
 ```
+
+Note that `yq` does not yet consider anchors when sorting by keys - this may result in invalid yaml documents if your are using merge anchors.

pkg/yqlib/doc/operators/headers/string-operators.md

@@ -17,13 +17,13 @@ a: |
 Using `$( exp )` wont work, as it will trim the trailing new line.
 
 ```
-m=$(echo "cat\n") yq e -n '.a = strenv(m)'
+m=$(echo "cat\n") yq -n '.a = strenv(m)'
 a: cat
 ```
 
 However, using printf works:
 ```
-printf -v m "cat\n" ; m="$m" yq e -n '.a = strenv(m)'
+printf -v m "cat\n" ; m="$m" yq -n '.a = strenv(m)'
 a: |
   cat
 ```
@@ -31,7 +31,7 @@ a: |
 As well as having multiline expressions:
 ```
 m="cat
-"  yq e -n '.a = strenv(m)'
+"  yq -n '.a = strenv(m)'
 a: |
   cat
 ```
@@ -40,5 +40,5 @@ Similarly, if you're trying to set the content from a file, and want a trailing
 
 ```
 IFS= read -rd '' output < <(cat my_file)
-output=$output ./yq e '.data.values = strenv(output)' first.yml
+output=$output ./yq '.data.values = strenv(output)' first.yml
 ```