Command-line YAML processor - jq wrapper for YAML 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 yaml.safe_load to avoid dangerous vulnerabilities in YAML/PyYAML design) and pipes it to jq, while passing all of its command line options to jq.
cat input.yml | yq .foo.bar
There is no support for specifying input filenames on the command line. There is also no support for transcoding jq’s JSON output back into fancier-than-JSON YAML; the transformation is one-way only. 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.
Links
Bugs
Please report bugs, issues, feature requests, etc. on GitHub.
License
Licensed under the terms of the Apache License, Version 2.0.
Project details
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.