2017-04-13 05:36:59 +00:00
2017-12-19 00:59:27 +00:00
2019-04-29 06:14:33 +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" >
2018-07-10 11:29:41 +00:00
< meta name = "lang:search.pipeline.stopwords" content = "True" >
< meta name = "lang:search.pipeline.trimmer" content = "True" >
2017-12-19 00:59:27 +00:00
< 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" >
2019-04-29 06:14:33 +00:00
< meta name = "generator" content = "mkdocs-1.0.4, mkdocs-material-4.2.0" >
2017-04-13 05:36:59 +00:00
2017-12-19 00:59:27 +00:00
< title > Write/Update - Yq< / title >
2017-04-13 05:36:59 +00:00
2019-04-29 06:14:33 +00:00
< link rel = "stylesheet" href = "../assets/stylesheets/application.750b69bd.css" >
2018-07-10 11:29:41 +00:00
2017-12-19 00:59:27 +00:00
2017-04-13 05:36:59 +00:00
2019-04-29 06:14:33 +00:00
< script src = "../assets/javascripts/modernizr.74668098.js" > < / script >
2017-04-13 05:36:59 +00:00
2018-11-18 17:40:51 +00:00
< link href = "https://fonts.gstatic.com" rel = "preconnect" crossorigin >
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 >
2018-07-10 11:29:41 +00:00
< link rel = "stylesheet" href = "../assets/fonts/material-icons.css" >
2017-04-13 05:36:59 +00:00
2018-11-18 17:40:51 +00:00
2019-04-29 06:14:33 +00:00
2017-04-13 05:36:59 +00:00
< / head >
2018-07-10 11:29:41 +00:00
< body dir = "ltr" >
2017-04-13 05:36:59 +00:00
< svg class = "md-svg" >
< defs >
2018-07-10 11:29:41 +00:00
< 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 19-18 . 125
8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19 18.125-8.5
18.125 8.5 10.75 19 3.125 20.5zM320 304q0 10-3.125 20.5t-10.75
19-18.125 8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19
18.125-8.5 18.125 8.5 10.75 19 3.125 20.5zM360
304q0-30-17.25-51t-46.75-21q-10.25 0-48.75 5.25-17.75 2.75-39.25
2.75t-39.25-2.75q-38-5.25-48.75-5.25-29.5 0-46.75 21t-17.25 51q0 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.75 8-38.375zM416 260q0 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.5-41.75
1.125q-19.5 0-35.5-0.75t-36.875-3.125-38.125-7.5-34.25-12.875-30.25-20.25-21.5-28.75q-15.5-30.75-15.5-82.75
0-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.875q36.75-8.75 77.25-8.75 37 0 70 8 26.25-20.5
46.75-30.25t47.25-9.75q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34
99.5z" />
< / svg >
2017-04-13 05:36:59 +00:00
< / defs >
< / svg >
2018-07-10 11:29:41 +00:00
< input class = "md-toggle" data-md-toggle = "drawer" type = "checkbox" id = "__drawer" autocomplete = "off" >
< input class = "md-toggle" data-md-toggle = "search" type = "checkbox" id = "__search" autocomplete = "off" >
< label class = "md-overlay" data-md-component = "overlay" for = "__drawer" > < / label >
< a href = "#to-stdout" tabindex = "1" class = "md-skip" >
Skip to content
< / a >
2017-04-13 05:36:59 +00:00
< 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" >
2018-07-10 11:29:41 +00:00
< label class = "md-icon md-icon--menu md-header-nav__button" for = "__drawer" > < / label >
2017-04-13 05:36:59 +00:00
< / 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
2019-04-29 06:14:33 +00:00
< span class = "md-header-nav__topic" >
Yq
< / span >
< span class = "md-header-nav__topic" >
Write/Update
< / 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" >
2019-04-29 06:14:33 +00:00
< label class = "md-icon md-icon--search md-header-nav__button" for = "__search" > < / label >
2017-04-13 05:36:59 +00:00
2017-09-23 19:33:23 +00:00
< div class = "md-search" data-md-component = "search" role = "dialog" >
2018-07-10 11:29:41 +00:00
< label class = "md-search__overlay" for = "__search" > < / label >
< div class = "md-search__inner" role = "search" >
2017-04-13 05:36:59 +00:00
< form class = "md-search__form" name = "search" >
2018-07-10 11:29:41 +00:00
< input type = "text" class = "md-search__input" name = "query" placeholder = "Search" autocapitalize = "off" autocorrect = "off" autocomplete = "off" spellcheck = "false" data-md-component = "query" data-md-state = "active" >
< label class = "md-icon md-search__icon" for = "__search" > < / label >
< button type = "reset" class = "md-icon md-search__icon" data-md-component = "reset" tabindex = "-1" >

< / 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 >
< / 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
2019-04-29 06:14:33 +00:00
< a href = "https://github.com/mikefarah/yq/" title = "Go to repository" class = "md-source" data-md-source = "github" >
< 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 >
2017-04-13 05:36:59 +00:00
< / div >
2019-04-29 06:14:33 +00:00
< div class = "md-source__repository" >
mikefarah/yq
< / 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" >
2018-07-10 11:29:41 +00:00
< label class = "md-nav__title md-nav__title--site" for = "__drawer" >
2018-11-18 17:40:51 +00:00
< a href = ".." title = "Yq" 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
2018-11-18 17:40:51 +00:00
< / a >
2017-12-19 00:59:27 +00:00
Yq
2017-04-13 05:36:59 +00:00
< / label >
< div class = "md-nav__source" >
2019-04-29 06:14:33 +00:00
< a href = "https://github.com/mikefarah/yq/" title = "Go to repository" class = "md-source" data-md-source = "github" >
< 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 >
2017-04-13 05:36:59 +00:00
< / div >
2019-04-29 06:14:33 +00:00
< div class = "md-source__repository" >
mikefarah/yq
< / div >
< / a >
2017-04-13 05:36:59 +00:00
< / 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" >
< a href = "../read/" title = "Read" class = "md-nav__link" >
Read
< / a >
< / li >
< li class = "md-nav__item md-nav__item--active" >
2018-07-10 11:29:41 +00:00
< input class = "md-toggle md-nav__toggle" data-md-toggle = "toc" type = "checkbox" id = "__toc" >
2017-04-13 05:36:59 +00:00
2018-07-10 11:29:41 +00:00
< label class = "md-nav__link md-nav__link--active" for = "__toc" >
2017-04-13 05:36:59 +00:00
Write/Update
< / label >
< a href = "./" title = "Write/Update" class = "md-nav__link md-nav__link--active" >
Write/Update
< / a >
< nav class = "md-nav md-nav--secondary" >
2018-07-10 11:29:41 +00:00
< label class = "md-nav__title" for = "__toc" > Table of contents< / label >
2017-04-13 05:36:59 +00:00
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "#to-stdout" title = "To Stdout" class = "md-nav__link" >
To Stdout
< / 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 = "#adding-new-fields" title = "Adding new fields" class = "md-nav__link" >
Adding new fields
< / a >
2019-05-14 06:05:25 +00:00
< / 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 = "#prefix-splat" title = "Prefix Splat" class = "md-nav__link" >
Prefix Splat
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#array-splat" title = "Array Splat" class = "md-nav__link" >
Array Splat
< / a >
2017-09-24 00:21:16 +00:00
< / li >
< li class = "md-nav__item" >
< a href = "#appending-value-to-an-array-field" title = "Appending value to an array field" class = "md-nav__link" >
Appending value to an array field
< / a >
2018-06-20 03:42:00 +00:00
< / li >
< li class = "md-nav__item" >
< a href = "#multiple-documents-update-a-single-document" title = "Multiple Documents - update a single document" class = "md-nav__link" >
Multiple Documents - update a single document
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#multiple-documents-update-all-documents" title = "Multiple Documents - update all documents" class = "md-nav__link" >
Multiple Documents - update all documents
< / a >
2017-04-13 05:36:59 +00:00
< / li >
< li class = "md-nav__item" >
< a href = "#updating-files-in-place" title = "Updating files in-place" class = "md-nav__link" >
Updating files in-place
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#updating-multiple-values-with-a-script" title = "Updating multiple values with a script" class = "md-nav__link" >
Updating multiple values with a script
< / a >
< / li >
2017-05-02 22:11:26 +00:00
< li class = "md-nav__item" >
< a href = "#values-starting-with-a-hyphen-or-dash" title = "Values starting with a hyphen (or dash)" class = "md-nav__link" >
Values starting with a hyphen (or dash)
< / 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 >
2019-04-29 06:14:33 +00:00
< li class = "md-nav__item" >
< a href = "#keys-and-values-with-leading-dashes" title = "Keys (and values) with leading dashes" class = "md-nav__link" >
Keys (and values) with leading dashes
< / a >
< / li >
2017-04-13 05:36:59 +00:00
2018-07-10 11:29:41 +00:00
2017-04-13 05:36:59 +00:00
< / ul >
< / nav >
< / li >
2018-11-18 17:40:51 +00:00
< li class = "md-nav__item" >
< a href = "../prefix/" title = "Prefix" class = "md-nav__link" >
Prefix
< / a >
< / li >
2018-05-07 06:06:33 +00:00
< li class = "md-nav__item" >
< a href = "../delete/" title = "Delete" class = "md-nav__link" >
Delete
< / a >
< / li >
2017-04-13 05:36:59 +00:00
< 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" >
2018-07-10 11:29:41 +00:00
< label class = "md-nav__title" for = "__toc" > Table of contents< / label >
2017-04-13 05:36:59 +00:00
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "#to-stdout" title = "To Stdout" class = "md-nav__link" >
To Stdout
< / 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 = "#adding-new-fields" title = "Adding new fields" class = "md-nav__link" >
Adding new fields
< / a >
2019-05-14 06:05:25 +00:00
< / 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 = "#prefix-splat" title = "Prefix Splat" class = "md-nav__link" >
Prefix Splat
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#array-splat" title = "Array Splat" class = "md-nav__link" >
Array Splat
< / a >
2017-09-24 00:21:16 +00:00
< / li >
< li class = "md-nav__item" >
< a href = "#appending-value-to-an-array-field" title = "Appending value to an array field" class = "md-nav__link" >
Appending value to an array field
< / a >
2018-06-20 03:42:00 +00:00
< / li >
< li class = "md-nav__item" >
< a href = "#multiple-documents-update-a-single-document" title = "Multiple Documents - update a single document" class = "md-nav__link" >
Multiple Documents - update a single document
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#multiple-documents-update-all-documents" title = "Multiple Documents - update all documents" class = "md-nav__link" >
Multiple Documents - update all documents
< / a >
2017-04-13 05:36:59 +00:00
< / li >
< li class = "md-nav__item" >
< a href = "#updating-files-in-place" title = "Updating files in-place" class = "md-nav__link" >
Updating files in-place
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#updating-multiple-values-with-a-script" title = "Updating multiple values with a script" class = "md-nav__link" >
Updating multiple values with a script
< / a >
< / li >
2017-05-02 22:11:26 +00:00
< li class = "md-nav__item" >
< a href = "#values-starting-with-a-hyphen-or-dash" title = "Values starting with a hyphen (or dash)" class = "md-nav__link" >
Values starting with a hyphen (or dash)
< / 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 >
2019-04-29 06:14:33 +00:00
< li class = "md-nav__item" >
< a href = "#keys-and-values-with-leading-dashes" title = "Keys (and values) with leading dashes" class = "md-nav__link" >
Keys (and values) with leading dashes
< / a >
< / li >
2017-04-13 05:36:59 +00:00
2018-07-10 11:29:41 +00:00
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/write.md" title = "Edit this page" class = "md-icon md-content__icon" >  < / a >
2017-04-13 05:36:59 +00:00
< h1 > Write/Update< / h1 >
2018-06-20 03:42:00 +00:00
< pre > < code > yq w < yaml_file> < path> < new value>
2017-04-13 05:36:59 +00:00
< / code > < / pre >
2017-05-02 22:11:26 +00:00
< h3 id = "to-stdout" > To Stdout< a class = "headerlink" href = "#to-stdout" 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 w sample.yaml b.c cat
2017-04-13 05:36:59 +00:00
< / code > < / pre >
< p > will output:< / p >
< pre > < code class = "yaml" > b:
c: cat
< / code > < / pre >
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-12-19 00:59:27 +00:00
< pre > < code class = "bash" > cat sample.yaml | yq w - b.c blah
2017-04-13 05:36:59 +00:00
< / code > < / pre >
2017-05-02 22:11:26 +00:00
< h3 id = "adding-new-fields" > Adding new fields< a class = "headerlink" href = "#adding-new-fields" title = "Permanent link" > ¶ < / a > < / h3 >
2017-04-13 05:36:59 +00:00
< p > Any missing fields in the path will be created on the fly.< / p >
< 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 w sample.yaml b.d[0] " new thing"
2017-04-13 05:36:59 +00:00
< / code > < / pre >
< p > will output:< / p >
< pre > < code class = "yaml" > b:
c: cat
d:
- new thing
< / code > < / pre >
2019-05-14 06:05:25 +00:00
< h3 id = "splat" > Splat< a class = "headerlink" href = "#splat" title = "Permanent link" > ¶ < / a > < / h3 >
< p > Given a sample.yaml file of:< / p >
< pre > < code class = "yaml" > ---
bob:
item1:
cats: bananas
item2:
cats: apples
thing:
cats: oranges
< / code > < / pre >
< p > then< / p >
< pre > < code class = "bash" > yq w sample.yaml bob.*.cats meow
< / code > < / pre >
< p > will output:< / p >
< pre > < code class = "yaml" > ---
bob:
item1:
cats: meow
item2:
cats: meow
thing:
cats: meow
< / code > < / pre >
< h3 id = "prefix-splat" > Prefix Splat< a class = "headerlink" href = "#prefix-splat" title = "Permanent link" > ¶ < / a > < / h3 >
< p > Given a sample.yaml file of:< / p >
< pre > < code class = "yaml" > ---
bob:
item1:
cats: bananas
item2:
cats: apples
thing:
cats: oranges
< / code > < / pre >
< p > then< / p >
< pre > < code class = "bash" > yq w sample.yaml bob.item*.cats meow
< / code > < / pre >
< p > will output:< / p >
< pre > < code class = "yaml" > ---
bob:
item1:
cats: meow
item2:
cats: meow
thing:
cats: oranges
< / code > < / pre >
< h3 id = "array-splat" > Array Splat< a class = "headerlink" href = "#array-splat" title = "Permanent link" > ¶ < / a > < / h3 >
< p > Given a sample.yaml file of:< / p >
< pre > < code class = "yaml" > ---
bob:
- cats: bananas
- cats: apples
- cats: oranges
< / code > < / pre >
< p > then< / p >
< pre > < code class = "bash" > yq w sample.yaml bob[*].cats meow
< / code > < / pre >
< p > will output:< / p >
< pre > < code class = "yaml" > ---
bob:
- cats: meow
- cats: meow
- cats: meow
< / code > < / pre >
2017-09-24 00:21:16 +00:00
< h3 id = "appending-value-to-an-array-field" > Appending value to an array field< a class = "headerlink" href = "#appending-value-to-an-array-field" title = "Permanent link" > ¶ < / a > < / h3 >
< p > Given a sample.yaml file of:< / p >
< pre > < code class = "yaml" > b:
c: 2
d:
- new thing
- foo thing
< / code > < / pre >
< p > then< / p >
2018-02-27 21:07:34 +00:00
< pre > < code class = "bash" > yq w sample.yaml " b.d[+]" " bar thing"
2017-09-24 00:21:16 +00:00
< / code > < / pre >
< p > will output:< / p >
< pre > < code class = "yaml" > b:
c: cat
d:
- new thing
- foo thing
- bar thing
< / code > < / pre >
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 >
2018-06-20 03:42:00 +00:00
< h3 id = "multiple-documents-update-a-single-document" > Multiple Documents - update a single document< a class = "headerlink" href = "#multiple-documents-update-a-single-document" title = "Permanent link" > ¶ < / a > < / h3 >
< p > Given a sample.yaml file of:< / p >
< pre > < code class = "yaml" > something: else
---
b:
c: 2
< / code > < / pre >
< p > then< / p >
< pre > < code class = "bash" > yq w -d1 sample.yaml b.c 5
< / code > < / pre >
< p > will output:< / p >
< pre > < code class = "yaml" > something: else
---
b:
c: 5
< / code > < / pre >
< h3 id = "multiple-documents-update-all-documents" > Multiple Documents - update all documents< a class = "headerlink" href = "#multiple-documents-update-all-documents" title = "Permanent link" > ¶ < / a > < / h3 >
< p > Given a sample.yaml file of:< / p >
< pre > < code class = "yaml" > something: else
---
b:
c: 2
< / code > < / pre >
< p > then< / p >
< pre > < code class = "bash" > yq w -d'*' sample.yaml b.c 5
< / code > < / pre >
< p > will output:< / p >
< pre > < code class = "yaml" > something: else
b:
c: 5
---
b:
c: 5
< / code > < / pre >
< p > Note that '*' is in quotes to avoid being interpreted by your shell.< / p >
2017-05-02 22:11:26 +00:00
< h3 id = "updating-files-in-place" > Updating files in-place< a class = "headerlink" href = "#updating-files-in-place" 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 w -i sample.yaml b.c cat
2017-04-13 05:36:59 +00:00
< / code > < / pre >
< p > will update the sample.yaml file so that the value of 'c' is cat.< / p >
2017-05-02 22:11:26 +00:00
< h3 id = "updating-multiple-values-with-a-script" > Updating multiple values with a script< a class = "headerlink" href = "#updating-multiple-values-with-a-script" 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
e:
- name: Billy Bob
< / code > < / pre >
< p > and a script update_instructions.yaml of:< / p >
< pre > < code class = "yaml" > b.c: 3
b.e[0].name: Howdy Partner
< / code > < / pre >
< p > then< / p >
2017-12-19 00:59:27 +00:00
< pre > < code class = "bash" > yq w -s update_instructions.yaml sample.yaml
2017-04-13 05:36:59 +00:00
< / code > < / pre >
< p > will output:< / p >
< pre > < code class = "yaml" > b:
c: 3
e:
- name: Howdy Partner
< / code > < / pre >
< p > And, of course, you can pipe the instructions in using '-':< / p >
2017-12-19 00:59:27 +00:00
< pre > < code class = "bash" > cat update_instructions.yaml | yq w -s - sample.yaml
2017-04-13 05:36:59 +00:00
< / code > < / pre >
2017-05-02 22:11:26 +00:00
< h3 id = "values-starting-with-a-hyphen-or-dash" > Values starting with a hyphen (or dash)< a class = "headerlink" href = "#values-starting-with-a-hyphen-or-dash" title = "Permanent link" > ¶ < / a > < / h3 >
2017-05-03 00:42:53 +00:00
< p > The flag terminator needs to be used to stop the app from attempting to parse the subsequent arguments as flags:< / p >
2017-12-19 00:59:27 +00:00
< pre > < code > yq w -- my.path -3
2017-05-02 22:11:26 +00:00
< / code > < / pre >
< p > will output< / p >
< pre > < code class = "yaml" > my:
2017-05-03 00:42:53 +00:00
path: -3
2017-05-02 22:11:26 +00:00
< / code > < / pre >
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 >
2019-04-29 06:14:33 +00:00
< h3 id = "keys-and-values-with-leading-dashes" > Keys (and values) with leading dashes< a class = "headerlink" href = "#keys-and-values-with-leading-dashes" title = "Permanent link" > ¶ < / a > < / h3 >
< p > If a key or value has leading dashes, yq won't know that you are passing a value as opposed to a flag (and you will get a 'bad flag syntax' error).< / p >
< p > To fix that, you will need to tell it to stop processing flags by adding '--' after the last flag like so:< / p >
< pre > < code class = "bash" > yq n -t -- --key --value
< / code > < / pre >
< p > Will result in< / p >
< p > < code > `
--key: --value< / code > < / p >
2017-04-13 05:36:59 +00:00
2018-07-10 11:29:41 +00:00
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 = "../read/" title = "Read" 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 >
Read
< / span >
< / div >
< / a >
2018-11-18 17:40:51 +00:00
< a href = "../prefix/" title = "Prefix" class = "md-flex md-footer-nav__link md-footer-nav__link--next" rel = "next" >
2017-04-13 05:36:59 +00:00
< 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 >
2018-11-18 17:40:51 +00:00
Prefix
2017-04-13 05:36:59 +00:00
< / 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
2018-07-10 11:29:41 +00:00
< a href = "https://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" >
2018-07-10 11:29:41 +00:00
< link rel = "stylesheet" href = "../assets/fonts/font-awesome.css" >
2017-04-13 05:36:59 +00:00
< 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 >
2019-04-29 06:14:33 +00:00
< script src = "../assets/javascripts/application.39abc4af.js" > < / script >
2017-09-23 19:33:23 +00:00
2018-11-18 17:40:51 +00:00
< script > app . initialize ( { version : "1.0.4" , url : { base : ".." } } ) < / script >
2017-04-13 05:36:59 +00:00
< / body >
< / html >
