yq 2.0.1

Command-line YAML processor - jq wrapper for YAML documents

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.

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.

Authors

• Andrey Kislyuk

Links

• Project home page (GitHub)

• Documentation (Read the Docs)

• Package distribution (PyPI)

• Change log

Bugs

Please report bugs, issues, feature requests, etc. on GitHub.

License

Licensed under the terms of the Apache License, Version 2.0.