suyiiyii/yq
1
0
Fork 0
mirror of https://github.com/mikefarah/yq.git synced 2024-11-14 15:18:06 +00:00
Code Issues Packages Projects Releases Wiki Activity
cc7eb84388
yq/docs/create/index.html

493 lines
14 KiB
HTML
Raw Normal View History

Added doco
2017-04-13 05:36:59 +00:00
<!DOCTYPE html>
Task: Add `merge` command docs Resolves: #35
2017-09-23 19:33:23 +00:00
<html lang="en" class="no-js">
Added doco
2017-04-13 05:36:59 +00:00
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
Task: Add `merge` command docs Resolves: #35
2017-09-23 19:33:23 +00:00
<meta http-equiv="x-ua-compatible" content="ie=edge">
Added doco
2017-04-13 05:36:59 +00:00
<link rel="shortcut icon" href="../assets/images/favicon.png">
Task: Add `merge` command docs Resolves: #35
2017-09-23 19:33:23 +00:00
<meta name="generator" content="mkdocs-0.16.3, mkdocs-material-1.10.1">
Added doco
2017-04-13 05:36:59 +00:00
<title>Create - Yaml</title>
Task: Add `merge` command docs Resolves: #35
2017-09-23 19:33:23 +00:00
<script src="../assets/javascripts/modernizr-e826f8942a.js"></script>
Added doco
2017-04-13 05:36:59 +00:00
Task: Add `merge` command docs Resolves: #35
2017-09-23 19:33:23 +00:00
<link rel="stylesheet" href="../assets/stylesheets/application-a20f419c8e.css">
Added doco
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">
Task: Add `merge` command docs Resolves: #35
2017-09-23 19:33:23 +00:00
<a href=".." title="Yaml" class="md-header-nav__button md-logo">
<i class="md-icon md-icon--home"></i>
</a>
Added doco
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">
<span class="md-flex__ellipsis md-header-nav__title">
Create
</span>
</div>
<div class="md-flex__cell md-flex__cell--shrink">
<label class="md-icon md-icon--search md-header-nav__button" for="search"></label>
Task: Add `merge` command docs Resolves: #35
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>
Added doco
2017-04-13 05:36:59 +00:00
<div class="md-search__inner">
<form class="md-search__form" name="search">
Task: Add `merge` command docs Resolves: #35
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">
Added doco
2017-04-13 05:36:59 +00:00
<label class="md-icon md-search__icon" for="search"></label>
Task: Add `merge` command docs Resolves: #35
2017-09-23 19:33:23 +00:00
<button type="reset" class="md-icon md-search__icon" data-md-component="reset">&#xE5CD;</button>
Added doco
2017-04-13 05:36:59 +00:00
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
Task: Add `merge` command docs Resolves: #35
2017-09-23 19:33:23 +00:00
<div class="md-search-result" data-md-component="result" data-md-lang-search="" data-md-lang-tokenizer="[\s\-]+">
Added doco
2017-04-13 05:36:59 +00:00
<div class="md-search-result__meta" data-md-lang-result-none="No matching documents" data-md-lang-result-one="1 matching document" data-md-lang-result-other="# matching documents">
Type to start searching
</div>
<ol class="md-search-result__list"></ol>
</div>
</div>
</div>
</div>
</div>
</div>
Task: Add `merge` command docs Resolves: #35
2017-09-23 19:33:23 +00:00
<div class="md-flex__cell md-flex__cell--shrink">
<div class="md-header-nav__source">
Added doco
2017-04-13 05:36:59 +00:00
<a href="https://github.com/mikefarah/yaml" 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/yaml
</div>
</a>
Task: Add `merge` command docs Resolves: #35
2017-09-23 19:33:23 +00:00
</div>
Added doco
2017-04-13 05:36:59 +00:00
</div>
Task: Add `merge` command docs Resolves: #35
2017-09-23 19:33:23 +00:00
Added doco
2017-04-13 05:36:59 +00:00
</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">
Task: Add `merge` command docs Resolves: #35
2017-09-23 19:33:23 +00:00
<div class="md-nav__button md-logo">
<i class="md-icon md-icon--home"></i>
</div>
Added doco
2017-04-13 05:36:59 +00:00
Yaml
</label>
<div class="md-nav__source">
<a href="https://github.com/mikefarah/yaml" 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/yaml
</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="../write/" title="Write/Update" class="md-nav__link">
Write/Update
</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">
Create
</label>
<a href="./" title="Create" class="md-nav__link md-nav__link--active">
Create
</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="#creating-a-simple-yaml-file" title="Creating a simple yaml file" class="md-nav__link">
Creating a simple yaml file
</a>
</li>
<li class="md-nav__item">
<a href="#creating-using-a-create-script" title="Creating using a create script" class="md-nav__link">
Creating using a create script
</a>
</li>
Task: Add docs on keys with dots Adds documentation on how to use a key lookup indicator for dealing with keys that have dots when specifying a path as part of create, read, and write commands. Resolves: #22
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>
Added doco
2017-04-13 05:36:59 +00:00
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../convert/" title="Convert" class="md-nav__link">
Convert
</a>
</li>
Task: Add `merge` command docs Resolves: #35
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>
Added doco
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="#creating-a-simple-yaml-file" title="Creating a simple yaml file" class="md-nav__link">
Creating a simple yaml file
</a>
</li>
<li class="md-nav__item">
<a href="#creating-using-a-create-script" title="Creating using a create script" class="md-nav__link">
Creating using a create script
</a>
</li>
Task: Add docs on keys with dots Adds documentation on how to use a key lookup indicator for dealing with keys that have dots when specifying a path as part of create, read, and write commands. Resolves: #22
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>
Added doco
2017-04-13 05:36:59 +00:00
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content">
<article class="md-content__inner md-typeset">
<h1>Create</h1>
<p>Yaml files can be created using the 'new' command. This works in the same way as the write command, but you don't pass in an existing Yaml file.</p>
<pre><code>yaml n &lt;path&gt; &lt;new value&gt;
</code></pre>
Added doco regarding values starting with hyphens
2017-05-02 22:11:26 +00:00
<h3 id="creating-a-simple-yaml-file">Creating a simple yaml file<a class="headerlink" href="#creating-a-simple-yaml-file" title="Permanent link">&para;</a></h3>
Added doco
2017-04-13 05:36:59 +00:00
<pre><code class="bash">yaml n b.c cat
</code></pre>
<p>will output:</p>
<pre><code class="yaml">b:
c: cat
</code></pre>
Added doco regarding values starting with hyphens
2017-05-02 22:11:26 +00:00
<h3 id="creating-using-a-create-script">Creating using a create script<a class="headerlink" href="#creating-using-a-create-script" title="Permanent link">&para;</a></h3>
Added doco
2017-04-13 05:36:59 +00:00
<p>Create scripts follow the same format as the update scripts.</p>
<p>Given a script create_instructions.yaml of:</p>
<pre><code class="yaml">b.c: 3
b.e[0].name: Howdy Partner
</code></pre>
<p>then</p>
<pre><code class="bash">yaml n -s create_instructions.yaml
</code></pre>
<p>will output:</p>
<pre><code class="yaml">b:
c: 3
e:
- name: Howdy Partner
</code></pre>
<p>You can also pipe the instructions in:</p>
<pre><code class="bash">cat create_instructions.yaml | yaml n -s -
</code></pre>
Task: Add docs on keys with dots Adds documentation on how to use a key lookup indicator for dealing with keys that have dots when specifying a path as part of create, read, and write commands. Resolves: #22
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">&para;</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>
<pre><code class="bash">yaml r sample.yaml b[foo.bar]
</code></pre>
<pre><code class="bash">yaml w sample.yaml b[foo.bar] 9
</code></pre>
<p>Any valid yaml key can be specified as part of a key lookup.</p>
Added doco
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="../write/" title="Write/Update" 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>
Write/Update
</span>
</div>
</a>
<a href="../convert/" title="Convert" 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>
Convert
</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="http://www.mkdocs.org" title="MkDocs">MkDocs</a>
and
<a href="http://squidfunk.github.io/mkdocs-material/" title="Material for MkDocs">
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>
Task: Add `merge` command docs Resolves: #35
2017-09-23 19:33:23 +00:00
<script src="../assets/javascripts/application-f3ab9e5ff8.js"></script>
Added doco
2017-04-13 05:36:59 +00:00
<script>app.initialize({url:{base:".."}})</script>
</body>
</html>
Reference in New Issue Copy Permalink