datatools/jsonmunge.1.html at main · caltechlibrary/datatools · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
<!DOCTYPE html>
<html lang="en-US">
<head>
    <title>datatools</title>
    <link rel="stylesheet" href="https://caltechlibrary.github.io/css/site.css">
    <link rel="stylesheet" href="https://media.library.caltech.edu/cl-webcomponents/css/code-blocks.css">
    <script type="module" src="https://media.library.caltech.edu/cl-webcomponents/copyToClipboard.js"></script>
    <script type="module" src="https://media.library.caltech.edu/cl-webcomponents/footer-global.js"></script>
</head>
<body>
<header>
<a href="https://library.caltech.edu"><img src="https://media.library.caltech.edu/assets/caltechlibrary-logo.png" alt="Caltech Library logo"></a>
</header>
<nav>
<ul>
    <li><a href="/">Home</a></li>
    <li><a href="index.html">README</a></li>
    <li><a href="LICENSE">LICENSE</a></li>
    <li><a href="INSTALL.html">INSTALL</a></li>
    <li><a href="user_manual.html">User Manual</a></li>
    <li><a href="about.html">About</a></li>
    <li><a href="search.html">Search</a></li>
    <li><a href="https://github.com/caltechlibrary/datatools">GitHub</a></li>
</ul>
</nav>
<section>
<h1 id="name">NAME</h1>
<p>jsonmunge</p>
<h1 id="synopsis">SYNOPSIS</h1>
<p>jsonmunge <a href="#options">OPTIONS</a> TEMPLATE_FILENAME</p>
<h1 id="description">DESCRIPTION</h1>
<p>jsonmunge is a command line tool that takes a JSON document and one
or more Go templates rendering the results. Useful for reshaping a JSON
document, transforming into a new format, or filter for specific
content.</p>
<ul>
<li>TEMPLATE_FILENAME is the name of a Go text tempate file used to
render the outbound JSON document</li>
</ul>
<h1 id="options">OPTIONS</h1>
<dl>
<dt>-help</dt>
<dd>
display help
</dd>
<dt>-license</dt>
<dd>
display license
</dd>
<dt>-version</dt>
<dd>
display version
</dd>
<dt>-E, -expression</dt>
<dd>
use template expression as template
</dd>
<dt>-i, -input</dt>
<dd>
input filename
</dd>
<dt>-nl, -newline</dt>
<dd>
if true add a trailing newline
</dd>
<dt>-o, -output</dt>
<dd>
output filename
</dd>
<dt>-quiet</dt>
<dd>
suppress error messages
</dd>
</dl>
<h1 id="examples">EXAMPLES</h1>
<p>If person.json contained</p>
<pre><code>   {&quot;name&quot;: &quot;Doe, Jane&quot;, &quot;email&quot;:&quot;jd@example.org&quot;, &quot;age&quot;: 42}</code></pre>
<p>and the template, name.tmpl, contained</p>
<pre><code>   {{- .name -}}</code></pre>
<p>Getting just the name could be done with</p>
<pre><code>    cat person.json | jsonmunge name.tmpl</code></pre>
<p>This would yield</p>
<pre><code>    &quot;Doe, Jane&quot;</code></pre>
<p>jsonmunge 1.3.5</p>
</section>
<footer-global></footer-global>
</body>
</html>