update yq cheat sheet
authorAJ ONeal <aj@therootcompany.com>
Thu, 7 Jan 2021 10:44:25 +0000 (10:44 +0000)
committerAJ ONeal <aj@therootcompany.com>
Thu, 7 Jan 2021 10:44:25 +0000 (10:44 +0000)
yq/README.md

index da28833af1f01ca4c56c6d62ff4eb1b62f1b619f..d0b5a561848c84ba5fb175c9a04f61a1116ff1ca 100644 (file)
@@ -3,6 +3,28 @@ title: yq
 homepage: https://github.com/mikefarah/yq
 tagline: |
   yq: a lightweight and portable command-line YAML processor
-
 ---
 
+To update or switch versions, run `webi yq@stable` or `webi yq@beta`, etc.
+
+## Cheat Sheet
+
+> `yq` is like [`jq`](../jq), meaning that it's like `sed` for YAML data - you
+> can use it to slice and filter and map and transform structured data with the
+> same ease that `sed`, `awk`, `grep` and friends let you play with text.
+
+Usage: `yq e '<selector>' <filepath>`
+
+Works with YAML:
+
+```bash
+echo 'name: John' | yq  e '.name' -
+```
+
+Works with JSON:
+
+```bash
+echo '[ { "name": "John" }, { "name": "Jane" } ]' | yq e '.[].name' -
+```
+
+See <https://mikefarah.gitbook.io/yq/> for the docs.