mirror of
				https://github.com/taigrr/yq
				synced 2025-01-18 04:53:17 -08:00 
			
		
		
		
	
		
			
				
	
	
		
			562 lines
		
	
	
		
			14 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
			
		
		
	
	
			562 lines
		
	
	
		
			14 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| <!doctype html>
 | |
| <html lang="en" class="no-js">
 | |
|   <head>
 | |
|     
 | |
|       <meta charset="utf-8">
 | |
|       <meta name="viewport" content="width=device-width,initial-scale=1">
 | |
|       <meta http-equiv="x-ua-compatible" content="ie=edge">
 | |
|       
 | |
|       
 | |
|       
 | |
|       
 | |
|         <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.pipeline.stopwords" content="True">
 | |
|       
 | |
|         <meta name="lang:search.pipeline.trimmer" content="True">
 | |
|       
 | |
|         <meta name="lang:search.result.none" content="No matching documents">
 | |
|       
 | |
|         <meta name="lang:search.result.one" content="1 matching document">
 | |
|       
 | |
|         <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-1.0.4, mkdocs-material-4.2.0">
 | |
|     
 | |
|     
 | |
|       
 | |
|         <title>Convert - Yq</title>
 | |
|       
 | |
|     
 | |
|     
 | |
|       <link rel="stylesheet" href="../assets/stylesheets/application.750b69bd.css">
 | |
|       
 | |
|       
 | |
|     
 | |
|     
 | |
|       <script src="../assets/javascripts/modernizr.74668098.js"></script>
 | |
|     
 | |
|     
 | |
|       
 | |
|         <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
 | |
|         <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="../assets/fonts/material-icons.css">
 | |
|     
 | |
|     
 | |
|     
 | |
|       
 | |
|     
 | |
|     
 | |
|   </head>
 | |
|   
 | |
|     <body dir="ltr">
 | |
|   
 | |
|     <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 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>
 | |
|         
 | |
|       </defs>
 | |
|     </svg>
 | |
|     <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="#yaml-to-json" tabindex="1" class="md-skip">
 | |
|         Skip to content
 | |
|       </a>
 | |
|     
 | |
|     
 | |
|       <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">
 | |
|         <a href=".." title="Yq" class="md-header-nav__button md-logo">
 | |
|           
 | |
|             <i class="md-icon"></i>
 | |
|           
 | |
|         </a>
 | |
|       </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">
 | |
|         <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
 | |
|           
 | |
|             <span class="md-header-nav__topic">
 | |
|               Yq
 | |
|             </span>
 | |
|             <span class="md-header-nav__topic">
 | |
|               Convert
 | |
|             </span>
 | |
|           
 | |
|         </div>
 | |
|       </div>
 | |
|       <div class="md-flex__cell md-flex__cell--shrink">
 | |
|         
 | |
|           <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
 | |
|           
 | |
| <div class="md-search" data-md-component="search" role="dialog">
 | |
|   <label class="md-search__overlay" for="__search"></label>
 | |
|   <div class="md-search__inner" role="search">
 | |
|     <form class="md-search__form" name="search">
 | |
|       <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>
 | |
|     </form>
 | |
|     <div class="md-search__output">
 | |
|       <div class="md-search__scrollwrap" data-md-scrollfix>
 | |
|         <div class="md-search-result" data-md-component="result">
 | |
|           <div class="md-search-result__meta">
 | |
|             Type to start searching
 | |
|           </div>
 | |
|           <ol class="md-search-result__list"></ol>
 | |
|         </div>
 | |
|       </div>
 | |
|     </div>
 | |
|   </div>
 | |
| </div>
 | |
|         
 | |
|       </div>
 | |
|       
 | |
|         <div class="md-flex__cell md-flex__cell--shrink">
 | |
|           <div class="md-header-nav__source">
 | |
|             
 | |
| 
 | |
| 
 | |
|   
 | |
| 
 | |
| <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>
 | |
|     </div>
 | |
|   
 | |
|   <div class="md-source__repository">
 | |
|     mikefarah/yq
 | |
|   </div>
 | |
| </a>
 | |
|           </div>
 | |
|         </div>
 | |
|       
 | |
|     </div>
 | |
|   </nav>
 | |
| </header>
 | |
|     
 | |
|     <div class="md-container">
 | |
|       
 | |
|         
 | |
|       
 | |
|       
 | |
|       <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">
 | |
|     <a href=".." title="Yq" class="md-nav__button md-logo">
 | |
|       
 | |
|         <i class="md-icon"></i>
 | |
|       
 | |
|     </a>
 | |
|     Yq
 | |
|   </label>
 | |
|   
 | |
|     <div class="md-nav__source">
 | |
|       
 | |
| 
 | |
| 
 | |
|   
 | |
| 
 | |
| <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>
 | |
|     </div>
 | |
|   
 | |
|   <div class="md-source__repository">
 | |
|     mikefarah/yq
 | |
|   </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">
 | |
|     <a href="../read/" title="Read" class="md-nav__link">
 | |
|       Read
 | |
|     </a>
 | |
|   </li>
 | |
| 
 | |
|     
 | |
|       
 | |
|       
 | |
|       
 | |
| 
 | |
| 
 | |
|   <li class="md-nav__item">
 | |
|     <a href="../path_expressions/" title="Path Expressions" class="md-nav__link">
 | |
|       Path Expressions
 | |
|     </a>
 | |
|   </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="../prefix/" title="Prefix" class="md-nav__link">
 | |
|       Prefix
 | |
|     </a>
 | |
|   </li>
 | |
| 
 | |
|     
 | |
|       
 | |
|       
 | |
|       
 | |
| 
 | |
| 
 | |
|   <li class="md-nav__item">
 | |
|     <a href="../delete/" title="Delete" class="md-nav__link">
 | |
|       Delete
 | |
|     </a>
 | |
|   </li>
 | |
| 
 | |
|     
 | |
|       
 | |
|       
 | |
|       
 | |
| 
 | |
| 
 | |
|   <li class="md-nav__item">
 | |
|     <a href="../create/" title="Create" class="md-nav__link">
 | |
|       Create
 | |
|     </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">
 | |
|         Convert
 | |
|       </label>
 | |
|     
 | |
|     <a href="./" title="Convert" class="md-nav__link md-nav__link--active">
 | |
|       Convert
 | |
|     </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="#yaml-to-json" title="Yaml to Json" class="md-nav__link">
 | |
|     Yaml to Json
 | |
|   </a>
 | |
|   
 | |
| </li>
 | |
|       
 | |
|         <li class="md-nav__item">
 | |
|   <a href="#json-to-yaml" title="Json to Yaml" class="md-nav__link">
 | |
|     Json to Yaml
 | |
|   </a>
 | |
|   
 | |
| </li>
 | |
|       
 | |
|       
 | |
|       
 | |
|       
 | |
|       
 | |
|     </ul>
 | |
|   
 | |
| </nav>
 | |
|     
 | |
|   </li>
 | |
| 
 | |
|     
 | |
|       
 | |
|       
 | |
|       
 | |
| 
 | |
| 
 | |
|   <li class="md-nav__item">
 | |
|     <a href="../merge/" title="Merge" class="md-nav__link">
 | |
|       Merge
 | |
|     </a>
 | |
|   </li>
 | |
| 
 | |
|     
 | |
|   </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="#yaml-to-json" title="Yaml to Json" class="md-nav__link">
 | |
|     Yaml to Json
 | |
|   </a>
 | |
|   
 | |
| </li>
 | |
|       
 | |
|         <li class="md-nav__item">
 | |
|   <a href="#json-to-yaml" title="Json to Yaml" class="md-nav__link">
 | |
|     Json to Yaml
 | |
|   </a>
 | |
|   
 | |
| </li>
 | |
|       
 | |
|       
 | |
|       
 | |
|       
 | |
|       
 | |
|     </ul>
 | |
|   
 | |
| </nav>
 | |
|                   </div>
 | |
|                 </div>
 | |
|               </div>
 | |
|             
 | |
|           
 | |
|           <div class="md-content">
 | |
|             <article class="md-content__inner md-typeset">
 | |
|               
 | |
|                 
 | |
|                   <a href="https://github.com/mikefarah/yq/edit/master/docs/convert.md" title="Edit this page" class="md-icon md-content__icon"></a>
 | |
|                 
 | |
|                 
 | |
|                   <h1>Convert</h1>
 | |
|                 
 | |
|                 <h3 id="yaml-to-json">Yaml to Json<a class="headerlink" href="#yaml-to-json" title="Permanent link">¶</a></h3>
 | |
| <p>To convert output to json, use the --tojson (or -j) flag. This is supported by all commands.</p>
 | |
| <p>Each matching yaml node will be converted to json and printed out on a separate line.</p>
 | |
| <p>Given a sample.yaml file of:</p>
 | |
| <pre><code class="yaml">b:
 | |
|   c: 2
 | |
| </code></pre>
 | |
| 
 | |
| <p>then</p>
 | |
| <pre><code class="bash">yq r -j sample.yaml
 | |
| </code></pre>
 | |
| 
 | |
| <p>will output</p>
 | |
| <pre><code class="json">{"b":{"c":2}}
 | |
| </code></pre>
 | |
| 
 | |
| <p>Given a sample.yaml file of:</p>
 | |
| <pre><code class="yaml">bob:
 | |
|   c: 2
 | |
| bab:
 | |
|   c: 5
 | |
| </code></pre>
 | |
| 
 | |
| <p>then</p>
 | |
| <pre><code class="bash">yq r -j sample.yaml b*
 | |
| </code></pre>
 | |
| 
 | |
| <p>will output</p>
 | |
| <pre><code class="json">{"c":2}
 | |
| {"c":5}
 | |
| </code></pre>
 | |
| 
 | |
| <h3 id="json-to-yaml">Json to Yaml<a class="headerlink" href="#json-to-yaml" title="Permanent link">¶</a></h3>
 | |
| <p>To read in json, just pass in a json file instead of yaml, it will just work :)</p>
 | |
| <p>e.g given a json file</p>
 | |
| <pre><code class="json">{"a":"Easy! as one two three","b":{"c":2,"d":[3,4]}}
 | |
| </code></pre>
 | |
| 
 | |
| <p>then</p>
 | |
| <pre><code class="bash">yq r sample.json
 | |
| </code></pre>
 | |
| 
 | |
| <p>will output</p>
 | |
| <pre><code class="yaml">a: Easy! as one two three
 | |
| b:
 | |
|   c: 2
 | |
|   d:
 | |
|   - 3
 | |
|   - 4
 | |
| </code></pre>
 | |
|                 
 | |
|                   
 | |
|                 
 | |
|               
 | |
|               
 | |
|                 
 | |
| 
 | |
| 
 | |
|               
 | |
|             </article>
 | |
|           </div>
 | |
|         </div>
 | |
|       </main>
 | |
|       
 | |
|         
 | |
| <footer class="md-footer">
 | |
|   
 | |
|     <div class="md-footer-nav">
 | |
|       <nav class="md-footer-nav__inner md-grid">
 | |
|         
 | |
|           <a href="../create/" title="Create" 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>
 | |
|                 Create
 | |
|               </span>
 | |
|             </div>
 | |
|           </a>
 | |
|         
 | |
|         
 | |
|           <a href="../merge/" title="Merge" 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>
 | |
|                 Merge
 | |
|               </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
 | |
|         <a href="https://www.mkdocs.org">MkDocs</a>
 | |
|         and
 | |
|         <a href="https://squidfunk.github.io/mkdocs-material/">
 | |
|           Material for MkDocs</a>
 | |
|       </div>
 | |
|       
 | |
|   <div class="md-footer-social">
 | |
|     <link rel="stylesheet" href="../assets/fonts/font-awesome.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>
 | |
|     
 | |
|       <script src="../assets/javascripts/application.39abc4af.js"></script>
 | |
|       
 | |
|       <script>app.initialize({version:"1.0.4",url:{base:".."}})</script>
 | |
|       
 | |
|     
 | |
|   </body>
 | |
| </html> |