Skip to main content

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.

Authors

  • Andrey Kislyuk

License

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

https://img.shields.io/travis/kislyuk/yq.svg https://codecov.io/github/kislyuk/yq/coverage.svg?branch=master https://img.shields.io/pypi/v/yq.svg https://img.shields.io/pypi/l/yq.svg https://readthedocs.org/projects/yq/badge/?version=latest

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

yq-2.0.2.tar.gz (3.7 kB view hashes)

Uploaded Source

Built Distribution

yq-2.0.2-py2.py3-none-any.whl (5.6 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page