mirror of
https://github.com/mikefarah/yq.git
synced 2024-12-19 20:19:04 +00:00
72 lines
2.2 KiB
Markdown
72 lines
2.2 KiB
Markdown
# yq
|
|
|
|
a lightweight and portable command-line YAML processor. `yq` uses [jq](https://github.com/stedolan/jq) like syntax but works with yaml files as well as json. It doesn't yet support everything `jq` does - but it does support the most common operations and functions, and more is being added continuously.
|
|
|
|
yq is written in go - so you can download a dependency free binary for your platform and you are good to go! If you prefer there are a variety of package managers that can be used as well as docker, all listed below.
|
|
|
|
## Notice for v4.x versions prior to 4.18.1
|
|
Since 4.18.1, yq's 'eval/e' command is the _default_ command and no longers needs to be specified.
|
|
|
|
Older versions will still need to specify 'eval/e'.
|
|
|
|
Similarly, '-' is no longer required as a filename to read from STDIN (unless reading from multiple files).
|
|
|
|
TLDR:
|
|
|
|
Prior to 4.18.1
|
|
```bash
|
|
cat file.yaml | yq e '.cool' -
|
|
```
|
|
|
|
4.18+
|
|
```bash
|
|
cat file.yaml | yq '.cool'
|
|
```
|
|
|
|
When merging multiple files together, `eval-all/ea` is still required to tell `yq` to run the expression again all the document at once.
|
|
|
|
## Quick Usage Guide
|
|
|
|
Read a value:
|
|
```bash
|
|
yq '.a.b[0].c' file.yaml
|
|
```
|
|
|
|
Pipe from STDIN:
|
|
```bash
|
|
cat file.yaml | yq '.a.b[0].c'
|
|
```
|
|
|
|
Update a yaml file, inplace
|
|
```bash
|
|
yq -i '.a.b[0].c = "cool"' file.yaml
|
|
```
|
|
|
|
Update using environment variables
|
|
```bash
|
|
NAME=mike yq -i '.a.b[0].c = strenv(NAME)' file.yaml
|
|
```
|
|
|
|
Merge multiple files
|
|
```
|
|
yq ea '. as $item ireduce ({}; . * $item )' path/to/*.yml
|
|
```
|
|
|
|
Multiple updates to a yaml file
|
|
```bash
|
|
yq -i '
|
|
.a.b[0].c = "cool" |
|
|
.x.y.z = "foobar" |
|
|
.person.name = strenv(NAME)
|
|
' file.yaml
|
|
```
|
|
|
|
## Install
|
|
|
|
See the [github page](https://github.com/mikefarah/yq/#install) for the various ways you can install and use `yq`
|
|
|
|
## Known Issues / Missing Features
|
|
- `yq` attempts to preserve comment positions and whitespace as much as possible, but it does not handle all scenarios (see https://github.com/go-yaml/yaml/tree/v3 for details)
|
|
- Powershell has its own...[opinions on quoting yq](https://mikefarah.gitbook.io/yq/usage/tips-and-tricks#quotes-in-windows-powershell)
|
|
|
|
See [tips and tricks](https://mikefarah.gitbook.io/yq/usage/tips-and-tricks) for more common problems and solutions. |