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 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. Specify the --yaml-output/-y option 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.

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.

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.3.3.tar.gz (5.5 kB view details)

Uploaded Source

Built Distribution

yq-2.3.3-py2.py3-none-any.whl (6.9 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file yq-2.3.3.tar.gz.

File metadata

  • Download URL: yq-2.3.3.tar.gz
  • Upload date:
  • Size: 5.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for yq-2.3.3.tar.gz
Algorithm Hash digest
SHA256 a3deeb987b514235efbdf593f3959dd7d79f41c9687dac29c3c87c62486cdc93
MD5 2174dce001cf04aa537c0153d7f1442e
BLAKE2b-256 cb75521f364c23cbf6cee4d5213616c2469b0a1d034a7314547c441c5a3cc1b8

See more details on using hashes here.

Provenance

File details

Details for the file yq-2.3.3-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for yq-2.3.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 75b6babe34f1f17b9fc253445a53558b3a964cd84da182be1c5b403359e57eef
MD5 1a4cbae94fdc68c74fc8847b4010a931
BLAKE2b-256 b1f34c488574c888ad22d251f85025e95db9c7bb4f4f37f32da166869c5615d2

See more details on using hashes here.

Provenance

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