diff options
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 10 |
1 files changed, 8 insertions, 2 deletions
@@ -1,5 +1,5 @@ -yq: Command-line YAML processor - jq wrapper for YAML documents -=============================================================== +yq: Command-line YAML processor - jq and JMESPath wrapper for YAML documents +============================================================================ Installation ------------ @@ -26,6 +26,12 @@ JSON output back into fancier-than-JSON YAML; the transformation is one-way only unless there was an error in YAML parsing, in which case the exit code is 1. See the `jq manual <https://stedolan.github.io/jq/manual/>`_ for more details on jq features and options. +JMESPath mode +------------- + +In addition to the default, jq wrapper mode, yq supports `JMESPath <http://jmespath.org/>`_ expressions via the +``--jmespath PATH`` option. + .. admonition:: 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 |