Command-line YAML and XML processor - jq wrapper for YAML and XML documents
Project description
Installation
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.
Synopsis
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.
XML support
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.
Links
jq - the command-line JSON processor utility powering yq
Bugs
Please report bugs, issues, feature requests, etc. on GitHub.
License
Licensed under the terms of the Apache License, Version 2.0.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
