Command-line YAML/XML processor - jq wrapper for YAML/XML documents
pip3 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 option to convert it back into YAML:
cat input.yml | yq -y .foo.bar
Mapping key order is preserved. By default, custom YAML tags and styles in the input are ignored. Use the --yaml-roundtrip/-Y option to preserve YAML tags and styles by representing them as extra items in their enclosing mappings and sequences while in JSON:
yq -Y .foo.bar input.yml
Use the --width/-w option to pass the line wrap width for string literals. With -y/-Y, files can be edited in place like with sed -i: yq -yi .foo=1 *.yml. 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.
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.
yq supports TOML as well. The yq package installs an executable, tomlq, which uses the toml library to transcode TOML to JSON, then pipes it to jq. Roundtrip transcoding is available with the tomlq --toml-output/tomlq -t option.
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.
Licensed under the terms of the Apache License, Version 2.0.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size yq-2.12.0-py2.py3-none-any.whl (15.1 kB)||File type Wheel||Python version py2.py3||Upload date||Hashes View|
|Filename, size yq-2.12.0.tar.gz (20.8 kB)||File type Source||Python version None||Upload date||Hashes View|