pip install yq
Before using yq, you also have to install its dependency, jq. See the jq installation instructions for details and directions specific to your platform.
On macOS, yq is also available on Homebrew: use brew install python-yq.
yq takes YAML input, converts it to JSON, and pipes it to jq:
cat input.yml | yq .foo.bar
Like in jq, you can also specify input filename(s) as arguments:
yq .foo.bar input.yml
By default, no conversion of jq output is done. Use the --yaml-output/-y argument to convert it back into YAML:
cat input.yml | yq -y .foo.bar
Use the --width/-w argument to pass the line wrap width for string literals. All other command line arguments are
forwarded to jq. yq forwards the exit code jq produced, unless there was an error in YAML parsing, in which case
the exit code is 1. See the jq manual for more details on jq features and
options.
YAML tags in the input are ignored (any nested data is treated as untagged). Key order is preserved.
Because YAML treats JSON as a dialect of YAML, you can use yq to convert JSON to YAML: yq -y . < in.json > out.yml.
yq also supports XML. The yq package installs an executable, xq, which
transcodes XML to JSON using
xmltodict and pipes it to jq. Roundtrip transcoding is available with
the xq --xml-output/xq -x option. Multiple XML documents can be passed in separate files/streams as
xq a.xml b.xml. Entity expansion and DTD resolution is disabled to avoid XML parsing vulnerabilities.
Compatibility note
This package's release series available on PyPI begins with version 2.0.0. Versions of yq prior to 2.0.0 are
distributed by https://github.com/abesto/yq and are not related to this package. No guarantees of compatibility are
made between abesto/yq and kislyuk/yq. This package follows the Semantic Versioning 2.0.0
standard. To ensure proper operation, declare dependency version ranges according to SemVer.
- Andrey Kislyuk
- Project home page (GitHub)
- Documentation (Read the Docs)
- Package distribution (PyPI)
- Change log
- jq - the command-line JSON processor utility powering
yq
Please report bugs, issues, feature requests, etc. on GitHub.
Licensed under the terms of the Apache License, Version 2.0.
