2017-04-13 05:36:59 +00:00
2017-12-19 00:59:27 +00:00
2017-04-13 05:36:59 +00:00
<!DOCTYPE html>
2017-09-23 19:33:23 +00:00
< html lang = "en" class = "no-js" >
2017-04-13 05:36:59 +00:00
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width,initial-scale=1" >
2017-09-23 19:33:23 +00:00
< meta http-equiv = "x-ua-compatible" content = "ie=edge" >
2017-04-13 05:36:59 +00:00
2017-12-19 00:59:27 +00:00
< meta name = "lang:clipboard.copy" content = "Copy to clipboard" >
< meta name = "lang:clipboard.copied" content = "Copied to clipboard" >
< meta name = "lang:search.language" content = "en" >
< meta name = "lang:search.result.none" content = "No matching documents" >
< meta name = "lang:search.result.one" content = "1 matching document" >
2017-04-13 05:36:59 +00:00
2017-12-19 00:59:27 +00:00
< meta name = "lang:search.result.other" content = "# matching documents" >
< meta name = "lang:search.tokenizer" content = "[\s\-]+" >
< link rel = "shortcut icon" href = "../assets/images/favicon.png" >
< meta name = "generator" content = "mkdocs-0.17.2, mkdocs-material-2.2.5" >
2017-04-13 05:36:59 +00:00
2017-12-19 00:59:27 +00:00
< title > Read - Yq< / title >
2017-04-13 05:36:59 +00:00
2017-12-19 00:59:27 +00:00
< link rel = "stylesheet" href = "../assets/stylesheets/application.bcabdff3.css" >
2017-04-13 05:36:59 +00:00
2017-12-19 00:59:27 +00:00
< script src = "../assets/javascripts/modernizr.1aa3b519.js" > < / script >
2017-04-13 05:36:59 +00:00
< link rel = "stylesheet" href = "https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono" >
< style > body , input { font-family : "Roboto" , "Helvetica Neue" , Helvetica , Arial , sans-serif } code , kbd , pre { font-family : "Roboto Mono" , "Courier New" , Courier , monospace } < / style >
< link rel = "stylesheet" href = "https://fonts.googleapis.com/icon?family=Material+Icons" >
< / head >
< body >
< svg class = "md-svg" >
< defs >
< svg xmlns = "http://www.w3.org/2000/svg" width = "416" height = "448" viewBox = "0 0 416 448" id = "github" > < path fill = "currentColor" d = "M160 304q0 10-3.125 20.5t-10.75 19T128 352t-18.125-8.5-10.75-19T96 304t3.125-20.5 10.75-19T128 256t18.125 8.5 10.75 19T160 304zm160 0q0 10-3.125 20.5t-10.75 19T288 352t-18.125-8.5-10.75-19T256 304t3.125-20.5 10.75-19T288 256t18.125 8.5 10.75 19T320 304zm40 0q0-30-17.25-51T296 232q-10.25 0-48.75 5.25Q229.5 240 208 240t-39.25-2.75Q130.75 232 120 232q-29.5 0-46.75 21T56 304q0 22 8 38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 37.25-1.75t35-7.375 30.5-15 20.25-25.75T360 304zm56-44q0 51.75-15.25 82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5T212 416q-19.5 0-35.5-.75t-36.875-3.125-38.125-7.5-34.25-12.875T37 371.5t-21.5-28.75Q0 312 0 260q0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 30.875Q171.5 96 212 96q37 0 70 8 26.25-20.5 46.75-30.25T376 64q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 99.5z" / > < / svg >
< / defs >
< / svg >
< input class = "md-toggle" data-md-toggle = "drawer" type = "checkbox" id = "drawer" >
< input class = "md-toggle" data-md-toggle = "search" type = "checkbox" id = "search" >
< label class = "md-overlay" data-md-component = "overlay" for = "drawer" > < / label >
< header class = "md-header" data-md-component = "header" >
< nav class = "md-header-nav md-grid" >
< div class = "md-flex" >
< div class = "md-flex__cell md-flex__cell--shrink" >
2017-12-19 00:59:27 +00:00
< a href = ".." title = "Yq" class = "md-header-nav__button md-logo" >
2017-09-23 19:33:23 +00:00
2017-12-19 00:59:27 +00:00
< i class = "md-icon" > < / i >
2017-09-23 19:33:23 +00:00
< / a >
2017-04-13 05:36:59 +00:00
< / div >
< div class = "md-flex__cell md-flex__cell--shrink" >
< label class = "md-icon md-icon--menu md-header-nav__button" for = "drawer" > < / label >
< / div >
< div class = "md-flex__cell md-flex__cell--stretch" >
2017-12-19 00:59:27 +00:00
< div class = "md-flex__ellipsis md-header-nav__title" data-md-component = "title" >
2017-04-13 05:36:59 +00:00
2017-12-19 00:59:27 +00:00
< span class = "md-header-nav__topic" >
Yq
< / span >
< span class = "md-header-nav__topic" >
Read
< / span >
2017-04-13 05:36:59 +00:00
2017-12-19 00:59:27 +00:00
< / div >
2017-04-13 05:36:59 +00:00
< / div >
< div class = "md-flex__cell md-flex__cell--shrink" >
2017-12-19 00:59:27 +00:00
< label class = "md-icon md-icon--search md-header-nav__button" for = "search" > < / label >
2017-09-23 19:33:23 +00:00
< div class = "md-search" data-md-component = "search" role = "dialog" >
< label class = "md-search__overlay" for = "search" > < / label >
2017-04-13 05:36:59 +00:00
< div class = "md-search__inner" >
< form class = "md-search__form" name = "search" >
2017-09-23 19:33:23 +00:00
< input type = "text" class = "md-search__input" name = "query" required placeholder = "Search" autocapitalize = "off" autocorrect = "off" autocomplete = "off" spellcheck = "false" data-md-component = "query" >
2017-04-13 05:36:59 +00:00
< label class = "md-icon md-search__icon" for = "search" > < / label >
2017-09-23 19:33:23 +00:00
< button type = "reset" class = "md-icon md-search__icon" data-md-component = "reset" >  < / button >
2017-04-13 05:36:59 +00:00
< / form >
< div class = "md-search__output" >
< div class = "md-search__scrollwrap" data-md-scrollfix >
2017-12-19 00:59:27 +00:00
< div class = "md-search-result" data-md-component = "result" >
< div class = "md-search-result__meta" >
2017-04-13 05:36:59 +00:00
Type to start searching
< / div >
< ol class = "md-search-result__list" > < / ol >
< / div >
< / div >
< / div >
< / div >
< / div >
2017-12-19 00:59:27 +00:00
2017-04-13 05:36:59 +00:00
< / div >
2017-09-23 19:33:23 +00:00
< div class = "md-flex__cell md-flex__cell--shrink" >
< div class = "md-header-nav__source" >
2017-04-13 05:36:59 +00:00
2017-12-19 00:59:27 +00:00
< a href = "https://github.com/mikefarah/yq/" title = "Go to repository" class = "md-source" data-md-source = "github" >
2017-04-13 05:36:59 +00:00
< div class = "md-source__icon" >
< svg viewBox = "0 0 24 24" width = "24" height = "24" >
< use xlink:href = "#github" width = "24" height = "24" > < / use >
< / svg >
< / div >
< div class = "md-source__repository" >
2017-12-19 00:59:27 +00:00
mikefarah/yq
2017-04-13 05:36:59 +00:00
< / div >
< / a >
2017-09-23 19:33:23 +00:00
< / div >
2017-04-13 05:36:59 +00:00
< / div >
2017-09-23 19:33:23 +00:00
2017-04-13 05:36:59 +00:00
< / div >
< / nav >
< / header >
< div class = "md-container" >
2017-12-19 00:59:27 +00:00
2017-04-13 05:36:59 +00:00
< main class = "md-main" >
< div class = "md-main__inner md-grid" data-md-component = "container" >
< div class = "md-sidebar md-sidebar--primary" data-md-component = "navigation" >
< div class = "md-sidebar__scrollwrap" >
< div class = "md-sidebar__inner" >
< nav class = "md-nav md-nav--primary" data-md-level = "0" >
< label class = "md-nav__title md-nav__title--site" for = "drawer" >
2017-12-19 00:59:27 +00:00
< span class = "md-nav__button md-logo" >
2017-09-23 19:33:23 +00:00
2017-12-19 00:59:27 +00:00
< i class = "md-icon" > < / i >
2017-09-23 19:33:23 +00:00
2017-12-19 00:59:27 +00:00
< / span >
Yq
2017-04-13 05:36:59 +00:00
< / label >
< div class = "md-nav__source" >
2017-12-19 00:59:27 +00:00
< a href = "https://github.com/mikefarah/yq/" title = "Go to repository" class = "md-source" data-md-source = "github" >
2017-04-13 05:36:59 +00:00
< div class = "md-source__icon" >
< svg viewBox = "0 0 24 24" width = "24" height = "24" >
< use xlink:href = "#github" width = "24" height = "24" > < / use >
< / svg >
< / div >
< div class = "md-source__repository" >
2017-12-19 00:59:27 +00:00
mikefarah/yq
2017-04-13 05:36:59 +00:00
< / div >
< / a >
< / div >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = ".." title = "Install" class = "md-nav__link" >
Install
< / a >
< / li >
< li class = "md-nav__item md-nav__item--active" >
< input class = "md-toggle md-nav__toggle" data-md-toggle = "toc" type = "checkbox" id = "toc" >
< label class = "md-nav__link md-nav__link--active" for = "toc" >
Read
< / label >
< a href = "./" title = "Read" class = "md-nav__link md-nav__link--active" >
Read
< / a >
< nav class = "md-nav md-nav--secondary" >
< label class = "md-nav__title" for = "toc" > Table of contents< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "#basic" title = "Basic" class = "md-nav__link" >
Basic
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#from-stdin" title = "From Stdin" class = "md-nav__link" >
From Stdin
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#splat" title = "Splat" class = "md-nav__link" >
Splat
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#handling-in-the-yaml-key" title = "Handling '.' in the yaml key" class = "md-nav__link" >
Handling '.' in the yaml key
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#arrays" title = "Arrays" class = "md-nav__link" >
Arrays
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#array-splat" title = "Array Splat" class = "md-nav__link" >
Array Splat
< / a >
< / li >
2017-09-26 02:36:49 +00:00
< li class = "md-nav__item" >
< a href = "#keys-with-dots" title = "Keys with dots" class = "md-nav__link" >
Keys with dots
< / a >
< / li >
2017-04-13 05:36:59 +00:00
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "../write/" title = "Write/Update" class = "md-nav__link" >
Write/Update
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../create/" title = "Create" class = "md-nav__link" >
Create
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../convert/" title = "Convert" class = "md-nav__link" >
Convert
< / a >
< / li >
2017-09-23 19:33:23 +00:00
< li class = "md-nav__item" >
< a href = "../merge/" title = "Merge" class = "md-nav__link" >
Merge
< / a >
< / li >
2017-04-13 05:36:59 +00:00
< / ul >
< / nav >
< / div >
< / div >
< / div >
< div class = "md-sidebar md-sidebar--secondary" data-md-component = "toc" >
< div class = "md-sidebar__scrollwrap" >
< div class = "md-sidebar__inner" >
< nav class = "md-nav md-nav--secondary" >
< label class = "md-nav__title" for = "toc" > Table of contents< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "#basic" title = "Basic" class = "md-nav__link" >
Basic
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#from-stdin" title = "From Stdin" class = "md-nav__link" >
From Stdin
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#splat" title = "Splat" class = "md-nav__link" >
Splat
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#handling-in-the-yaml-key" title = "Handling '.' in the yaml key" class = "md-nav__link" >
Handling '.' in the yaml key
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#arrays" title = "Arrays" class = "md-nav__link" >
Arrays
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#array-splat" title = "Array Splat" class = "md-nav__link" >
Array Splat
< / a >
< / li >
2017-09-26 02:36:49 +00:00
< li class = "md-nav__item" >
< a href = "#keys-with-dots" title = "Keys with dots" class = "md-nav__link" >
Keys with dots
< / a >
< / li >
2017-04-13 05:36:59 +00:00
< / ul >
< / nav >
< / div >
< / div >
< / div >
< div class = "md-content" >
< article class = "md-content__inner md-typeset" >
2017-12-19 00:59:27 +00:00
< a href = "https://github.com/mikefarah/yq/edit/master/docs/read.md" title = "Edit this page" class = "md-icon md-content__icon" >  < / a >
2017-04-13 05:36:59 +00:00
< h1 > Read< / h1 >
2017-12-19 00:59:27 +00:00
< pre > < code > yq r < yaml_file|json_file> < path>
2017-04-13 05:36:59 +00:00
< / code > < / pre >
2017-04-19 05:45:45 +00:00
< p > This command can take a json file as input too, and will output yaml unless specified to export as json (-j)< / p >
2017-05-02 22:11:26 +00:00
< h3 id = "basic" > Basic< a class = "headerlink" href = "#basic" title = "Permanent link" > ¶ < / a > < / h3 >
2017-04-13 05:36:59 +00:00
< p > Given a sample.yaml file of:< / p >
< pre > < code class = "yaml" > b:
c: 2
< / code > < / pre >
< p > then< / p >
2017-12-19 00:59:27 +00:00
< pre > < code class = "bash" > yq r sample.yaml b.c
2017-04-13 05:36:59 +00:00
< / code > < / pre >
< p > will output the value of '2'.< / p >
2017-05-02 22:11:26 +00:00
< h3 id = "from-stdin" > From Stdin< a class = "headerlink" href = "#from-stdin" title = "Permanent link" > ¶ < / a > < / h3 >
2017-04-13 05:36:59 +00:00
< p > Given a sample.yaml file of:< / p >
2017-12-19 00:59:27 +00:00
< pre > < code class = "bash" > cat sample.yaml | yq r - b.c
2017-04-13 05:36:59 +00:00
< / code > < / pre >
< p > will output the value of '2'.< / p >
2017-05-02 22:11:26 +00:00
< h3 id = "splat" > Splat< a class = "headerlink" href = "#splat" title = "Permanent link" > ¶ < / a > < / h3 >
2017-04-13 05:36:59 +00:00
< p > Given a sample.yaml file of:< / p >
< pre > < code class = "yaml" > ---
bob:
item1:
cats: bananas
item2:
cats: apples
< / code > < / pre >
< p > then< / p >
2017-12-19 00:59:27 +00:00
< pre > < code class = "bash" > yq r sample.yaml bob.*.cats
2017-04-13 05:36:59 +00:00
< / code > < / pre >
< p > will output< / p >
< pre > < code class = "yaml" > - bananas
- apples
< / code > < / pre >
2017-05-02 22:11:26 +00:00
< h3 id = "handling-in-the-yaml-key" > Handling '.' in the yaml key< a class = "headerlink" href = "#handling-in-the-yaml-key" title = "Permanent link" > ¶ < / a > < / h3 >
2017-04-13 05:36:59 +00:00
< p > Given a sample.yaml file of:< / p >
< pre > < code class = "yaml" > b.x:
c: 2
< / code > < / pre >
< p > then< / p >
2017-12-19 00:59:27 +00:00
< pre > < code class = "bash" > yq r sample.yaml \" b.x\" .c
2017-04-13 05:36:59 +00:00
< / code > < / pre >
< p > will output the value of '2'.< / p >
2017-05-02 22:11:26 +00:00
< h3 id = "arrays" > Arrays< a class = "headerlink" href = "#arrays" title = "Permanent link" > ¶ < / a > < / h3 >
2017-04-13 05:36:59 +00:00
< p > You can give an index to access a specific element:
e.g.: given a sample file of< / p >
< pre > < code class = "yaml" > b:
e:
- name: fred
value: 3
- name: sam
value: 4
< / code > < / pre >
< p > then< / p >
2018-02-27 21:07:34 +00:00
< pre > < code > yq r sample.yaml 'b.e[1].name'
2017-04-13 05:36:59 +00:00
< / code > < / pre >
< p > will output 'sam'< / p >
2018-02-27 21:07:34 +00:00
< p > Note that the path is in quotes to avoid the square brackets being interpreted by your shell.< / p >
2017-05-02 22:11:26 +00:00
< h3 id = "array-splat" > Array Splat< a class = "headerlink" href = "#array-splat" title = "Permanent link" > ¶ < / a > < / h3 >
2017-04-13 05:36:59 +00:00
< p > e.g.: given a sample file of< / p >
< pre > < code class = "yaml" > b:
e:
- name: fred
value: 3
- name: sam
value: 4
< / code > < / pre >
< p > then< / p >
2018-02-27 21:07:34 +00:00
< pre > < code > yq r sample.yaml 'b.e[*].name'
2017-04-13 05:36:59 +00:00
< / code > < / pre >
< p > will output:< / p >
< pre > < code > - fred
- sam
< / code > < / pre >
2017-09-26 02:36:49 +00:00
2018-02-27 21:07:34 +00:00
< p > Note that the path is in quotes to avoid the square brackets being interpreted by your shell.< / p >
2017-09-26 02:36:49 +00:00
< h3 id = "keys-with-dots" > Keys with dots< a class = "headerlink" href = "#keys-with-dots" title = "Permanent link" > ¶ < / a > < / h3 >
< p > When specifying a key that has a dot use key lookup indicator.< / p >
< pre > < code class = "yaml" > b:
foo.bar: 7
< / code > < / pre >
2018-02-27 21:07:34 +00:00
< pre > < code class = "bash" > yaml r sample.yaml 'b[foo.bar]'
2017-09-26 02:36:49 +00:00
< / code > < / pre >
2018-02-27 21:07:34 +00:00
< pre > < code class = "bash" > yaml w sample.yaml 'b[foo.bar]' 9
2017-09-26 02:36:49 +00:00
< / code > < / pre >
< p > Any valid yaml key can be specified as part of a key lookup.< / p >
2018-02-27 21:07:34 +00:00
< p > Note that the path is in quotes to avoid the square brackets being interpreted by your shell.< / p >
2017-04-13 05:36:59 +00:00
< / article >
< / div >
< / div >
< / main >
< footer class = "md-footer" >
< div class = "md-footer-nav" >
< nav class = "md-footer-nav__inner md-grid" >
< a href = ".." title = "Install" class = "md-flex md-footer-nav__link md-footer-nav__link--prev" rel = "prev" >
< div class = "md-flex__cell md-flex__cell--shrink" >
< i class = "md-icon md-icon--arrow-back md-footer-nav__button" > < / i >
< / div >
< div class = "md-flex__cell md-flex__cell--stretch md-footer-nav__title" >
< span class = "md-flex__ellipsis" >
< span class = "md-footer-nav__direction" >
Previous
< / span >
Install
< / span >
< / div >
< / a >
< a href = "../write/" title = "Write/Update" class = "md-flex md-footer-nav__link md-footer-nav__link--next" rel = "next" >
< div class = "md-flex__cell md-flex__cell--stretch md-footer-nav__title" >
< span class = "md-flex__ellipsis" >
< span class = "md-footer-nav__direction" >
Next
< / span >
Write/Update
< / span >
< / div >
< div class = "md-flex__cell md-flex__cell--shrink" >
< i class = "md-icon md-icon--arrow-forward md-footer-nav__button" > < / i >
< / div >
< / a >
< / nav >
< / div >
< div class = "md-footer-meta md-typeset" >
< div class = "md-footer-meta__inner md-grid" >
< div class = "md-footer-copyright" >
powered by
2017-12-19 00:59:27 +00:00
< a href = "http://www.mkdocs.org" > MkDocs< / a >
2017-04-13 05:36:59 +00:00
and
2017-12-19 00:59:27 +00:00
< a href = "https://squidfunk.github.io/mkdocs-material/" >
2017-04-13 05:36:59 +00:00
Material for MkDocs< / a >
< / div >
< div class = "md-footer-social" >
< link rel = "stylesheet" href = "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css" >
< a href = "https://github.com/mikefarah" class = "md-footer-social__link fa fa-github" > < / a >
< a href = "https://www.linkedin.com/in/mike-farah-b5a75b2/" class = "md-footer-social__link fa fa-linkedin" > < / a >
< / div >
< / div >
< / div >
< / footer >
< / div >
2017-12-19 00:59:27 +00:00
< script src = "../assets/javascripts/application.6cdc17f0.js" > < / script >
2017-09-23 19:33:23 +00:00
2017-12-19 00:59:27 +00:00
< script > app . initialize ( { version : "0.17.2" , url : { base : ".." } } ) < / script >
2017-04-13 05:36:59 +00:00
< / body >
< / html >
