datatools/jsonobjects2csv.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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
<!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>jsonobjects2csv</p>
<h1 id="synopsis">SYNOPSIS</h1>
<p>jsonobjects2csv <a href="#options">OPTIONS</a> [JSON_FILENAME]
[YAML_FILENAME]</p>
<h1 id="description">DESCRIPTION</h1>
<p>jsonobjects2csv is a tool that converts a JSON list of objects into
CSV output.</p>
<p>jsonobjects2csv will take JSON expressing a list of objects and turn
them into a CSV representation. If the object’s attributes include other
objects or arrays they are rendered as YAML in the cell of the csv
output.</p>
<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>-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>
<dt>-delimiter</dt>
<dd>
set the CSV column delimiter for output
</dd>
<dt>-show-header</dt>
<dd>
set whether or not to output a header row at start of outout.
</dd>
<dt>-i FILENAME</dt>
<dd>
Use FILENAME for input, “-” will be interpreted as standard input
</dd>
<dt>-o FILENAME</dt>
<dd>
Use FILENAME for ouput, “-” will be interpreted as standard output
</dd>
</dl>
<h1 id="examples">EXAMPLES</h1>
<p>Used by typing into standard in (press Ctrl-d to end your input).</p>
<pre class="shell"><code>    jsonobjects2csv
    [
      {&quot;one&quot;: 1, &quot;two&quot;: 2},
      {&quot;one&quot;: 10, &quot;two&quot;: 20},
    ]
    ^D</code></pre>
<p>This should yield the following.</p>
<pre class="text"><code>one,two
1,2
10,20</code></pre>
<p>These would get the file named “my_list.json” and save it as
my.csv</p>
<pre class="shell"><code>    jsonobjects2csv my_list.json &gt; my.csv

    jsonobjects2csv my_list.json my.csv

    cat my_list.json | jsonobjects2csv -i - &gt; my.csv</code></pre>
<p>jsonobjects2csv 1.3.5</p>
</section>
<footer-global></footer-global>
</body>
</html>