mirror of
https://github.com/mikefarah/yq.git
synced 2026-03-10 15:54:26 +00:00
72 lines
2.4 KiB
Markdown
72 lines
2.4 KiB
Markdown
# yq
|
|
|
|
a lightweight and portable command-line YAML, JSON, INI and XML processor. `yq` uses [jq](https://github.com/stedolan/jq)-like syntax but works with yaml files as well as json, xml, ini, properties, csv and tsv. 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 and Podman, all listed below.
|
|
|
|
## Quick Usage Guide
|
|
|
|
Read a value:
|
|
```bash
|
|
yq '.a.b[0].c' file.yaml
|
|
```
|
|
|
|
Pipe from STDIN:
|
|
```bash
|
|
yq '.a.b[0].c' < file.yaml
|
|
```
|
|
|
|
Update a yaml file, in place
|
|
```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
|
|
```bash
|
|
# merge two files
|
|
yq -n 'load("file1.yaml") * load("file2.yaml")'
|
|
|
|
# merge using globs:
|
|
# note the use of `ea` to evaluate all the files at once
|
|
# instead of in sequence
|
|
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
|
|
```
|
|
|
|
Find and update an item in an array:
|
|
```bash
|
|
yq '(.[] | select(.name == "foo") | .address) = "12 cat st"'
|
|
```
|
|
|
|
Convert JSON to YAML
|
|
```bash
|
|
yq -Poy sample.json
|
|
```
|
|
|
|
See [recipes](https://mikefarah.gitbook.io/yq/recipes) for more examples and the [documentation](https://mikefarah.gitbook.io/yq/) for more information.
|
|
|
|
Take a look at the discussions for [common questions](https://github.com/mikefarah/yq/discussions/categories/q-a), and [cool ideas](https://github.com/mikefarah/yq/discussions/categories/show-and-tell)
|
|
|
|
## 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.
|