Command-line YAML and XML processor - jq wrapper for YAML and XML documents
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.
yq’s mode of operation is simple: it transcodes YAML on standard input to JSON (using the key-order-preserving equivalent of yaml.safe_load_all to avoid dangerous vulnerabilities in YAML/PyYAML design) and pipes it to jq:
cat input.yml | yq .foo.bar
Or specify the filename directly:
yq .foo.bar input.yml
By default, no transcoding of jq output is done. Use the --yaml-output/-y argument to transcode it back into YAML (using the key-order-preserving equivalent of yaml.safe_dump_all):
cat input.yml | yq -y .foo.bar
Use the --width/-w argument to pass the line wrap width for string literals. YAML tags are ignored (any nested data is treated as untagged).
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.
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.
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
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size & hash SHA256 hash help||File type||Python version||Upload date|
|yq-2.6.0-py2.py3-none-any.whl (12.4 kB) Copy SHA256 hash SHA256||Wheel||2.7||Apr 28, 2018|
|yq-2.6.0.tar.gz (11.5 kB) Copy SHA256 hash SHA256||Source||None||Apr 28, 2018|