Files
cheatsheet-tldr/tldr/yq
2025-06-30 00:22:10 +00:00

42 lines
1.2 KiB
Plaintext

---
syntax: markdown
tags: [tldr, common]
source: https://github.com/tldr-pages/tldr.git
---
# yq
> A lightweight and portable YAML processor.
> More information: <https://mikefarah.gitbook.io/yq/>.
- Output a YAML file, in pretty-print format (v4+):
`yq eval {{path/to/file.yaml}}`
- Output a YAML file, in pretty-print format (v3):
`yq read {{path/to/file.yaml}} {{[-C|--colors]}}`
- Output the first element in a YAML file that contains only an array (v4+):
`yq eval '.[0]' {{path/to/file.yaml}}`
- Output the first element in a YAML file that contains only an array (v3):
`yq read {{path/to/file.yaml}} '[0]'`
- Set (or overwrite) a key to a value in a file (v4+):
`yq eval '.{{key}} = "{{value}}"' {{[-i|--inplace]}} {{path/to/file.yaml}}`
- Set (or overwrite) a key to a value in a file (v3):
`yq write {{[-i|--inplace]}} {{path/to/file.yaml}} '{{key}}' '{{value}}'`
- Merge two files and print to `stdout` (v4+):
`yq eval-all 'select(filename == "{{path/to/file1.yaml}}") * select(filename == "{{path/to/file2.yaml}}")' {{path/to/file1.yaml}} {{path/to/file2.yaml}}`
- Merge two files and print to `stdout` (v3):
`yq merge {{path/to/file1.yaml}} {{path/to/file2.yaml}} {{[-C|--colors]}}`