Primitives¶

JSON primitives (i.e. null, true, and false) and numbers are printed verbatim. Jt does not process them in any way. Numbers can be of arbitrary precision, as long as they conform to the JSON parsing grammar.

If special formatting is required the printf program is your friend:

$ printf %.0f 2.99792458e9
2997924580

Strings¶

Strings are printed verbatim, minus the enclosing double quotes. No unescaping is performed because tabs or newlines in JSON strings would break the tabular output format.

If unescaped values are desired either use the -c flag to enable CSV output (see CSV below) or use the -u option and pass the string as an argument:

$ jt -u ´i love music \u266A´
i love music ♪

Collections¶

Objects and arrays are printed as JSON with whitespace removed. Note that it is only possible to print arrays when the -a option is specified (see the Iteration (Arrays) and Explicit Iteration sections below).

CSV¶

The -c flag enables CSV output conforming to RFC 4180. This format supports strings containing tabs, newlines, etc.:

$ jt -c [ foo % ] [ bar % ] baz % <<EOT
- {
-   "foo": "one\ttwo",
-   "bar": "three\nfour",
-   "baz": "music \"\u266A\""
- }
- EOT
"one    two","three
four","music ""♪"""

Explore¶

The @ command prints information about the item at the top of the data stack. When the item is an object @ prints its keys:

$ jt @ <<EOT
- {
-   "foo": 100,
-   "bar": 200,
-   "baz": 300
- }
- EOT
foo
bar
baz

When the top item is an array @ prints information about the first item in the array:

$ jt @ <<EOT
- [
-   {"foo": 100, "bar": 200},
-   {"baz": 300, "baf": 400}
- ]
- EOT
foo
bar

Otherwise, @ prints the type of the item, or [none] if there is no value:

$ echo ´["hello", "world"]´ | jt @
[string]

$ echo ´[1, 2]´ | jt @
[number]

$ echo ´[true, false]´ | jt @
[boolean]

$ echo ´[null, null]´ | jt @
[null]

$ echo ´[]´ | jt @
[none]

Drill Down¶

Property names are also commands. Use foo here as a command to drill down into the foo property and then use @ to print its keys:

$ jt foo @ <<EOT
- {
-   "foo": {
-     "bar": 100,
-     "baz": 200
-   }
- }
- EOT
bar
baz

A property name that conflicts with a jt command may be wrapped with square brackets to drill down:

$ jt [@] @ <<EOT
- {
-   "@": {
-     "bar": 100,
-     "baz": 200
-   }
- }
- EOT
bar
baz

Note: The property name must be a JSON escaped string, so if the property name in the JSON input contains eg. tab characters they must be escaped in the command, like this:

$ jt ´foo\tbar´ @ <<EOT
- {
-   "foo\tbar": {
-     "bar": 100,
-     "baz": 200
-   }
- }
- EOT
bar
baz

Extract¶

The % command prints the item at the top of the data stack. Note that when the top item is a collection it is printed as JSON (insiginificant whitespace removed):

$ jt % <<EOT
- {
-   "foo": 100,
-   "bar": 200
- }
- EOT
{"foo":100,"bar":200}

Drill down and print:

$ jt foo bar % <<EOT
- {
-   "foo": {
-     "bar": 100
-   }
- }
- EOT
100

The % command can be used multiple times. The printed values will be separated by tabs:

$ jt % foo % bar % <<EOT
- {
-   "foo": {
-     "bar": 100
-   }
- }
- EOT
{"foo":{"bar":100}}     {"bar":100}     100

Save / Restore¶

The [ and ] commands provide a way to save the data stack´s state before performing some operations and restore it afterwards. This makes it possible to drill down into one part of an object and then "rewind" to drill down into another part of the same object.

The [ command saves the state of the data stack and the ] command restores the data stack to the corresponding saved state. It is an error to use the ] command without a corresponding [ command.

$ jt [ foo % ] bar % <<EOT
- {
-   "foo": 100,
-   "bar": 200
- }
- EOT
100     200

The [ and ] commands can be nested:

$ jt [ foo [ bar % ] [ baz % ] ] baf % <<EOT
- {
-   "foo": {
-     "bar": 100,
-     "baz": 200
-   },
-   "baf": "quux"
- }
- EOT
100     200     quux

Iteration (Arrays)¶

Jt automatically iterates over arrays (unless this behavior is disabled — see Explicit Iteration below), producing one tab-delimited record per iteration, records separated by newlines:

$ jt [ foo % ] bar baz % <<EOT
- {
-   "foo": 100,
-   "bar": [
-     {"baz": 200},
-     {"baz": 300},
-     {"baz": 400}
-   ]
- }
- EOT
100     200
100     300
100     400

The ^ command includes the array index as a column in the result:

$ jt [ foo % ] bar ^ baz % <<EOT
- {
-   "foo": 100,
-   "bar": [
-     {"baz": 200},
-     {"baz": 300},
-     {"baz": 400}
-   ]
- }
- EOT
100     0       200
100     1       300
100     2       400

The ^ command is scoped to the innermost enclosing loop:

$ jt foo ^ bar ^ % <<EOT
- {
-   "foo": [
-     {"bar": [100, 200]},
-     {"bar": [300, 400]}
-   ]
- }
- EOT
0       0       100
0       1       200
1       0       300
1       1       400

Iteration (Objects)¶

The . command iterates over the values of an object:

$ jt . % <<EOT
- {
-   "foo": 100,
-   "bar": 200,
-   "baz": 300
- }
- EOT
100
200
300

When iterating over an object the ^ command prints the name of the current property:

$ jt . ^ % <<EOT
- {
-   "foo": 100,
-   "bar": 200,
-   "baz": 300
- }
- EOT
foo     100
bar     200
baz     300

JSON Streams¶

Jt automatically iterates over entities in a JSON stream (optionally delimited by whitespace):

$ jt [ foo % ] bar % <<EOT
- {"foo": 100, "bar": 200}
- {"foo": 200, "bar": 300}
- {"foo": 300, "bar": 400}
- EOT
100     200
200     300
300     400

The ^ command prints the current stream index:

$ jt ^ [ foo % ] bar % <<EOT
- {"foo": 100, "bar": 200}
- {"foo": 200, "bar": 300}
- {"foo": 300, "bar": 400}
- EOT
0       100     200
1       200     300
2       300     400

Nested JSON¶

The + command parses JSON embedded in strings:

$ jt [ foo + bar % ] baz % <<EOT
- {"foo":"{\"bar\":100}","baz":200}
- {"foo":"{\"bar\":200}","baz":300}
- {"foo":"{\"bar\":300}","baz":400}
- EOT
100     200
200     300
300     400

Note: The + command does not modify the original JSON:

$ jt [ foo + bar % ] % <<EOT
- {"foo":"{\"bar\":100}","baz":200}
- {"foo":"{\"bar\":200}","baz":300}
- {"foo":"{\"bar\":300}","baz":400}
- EOT
100     {"foo":"{\"bar\":100}","baz":200}
200     {"foo":"{\"bar\":200}","baz":300}
300     {"foo":"{\"bar\":300}","baz":400}

Column Headings¶

The %=NAME and ^=NAME commands are like % and ^ above, but they also assign column headings, which are printed as the first line of output:

$ jt [ foo %=Foo ] bar ^=Bar baz %=Baz <<EOT
- {
-   "foo": 100,
-   "bar": [
-     {"baz": 200},
-     {"baz": 300},
-     {"baz": 400}
-   ]
- }
- EOT
Foo     Bar     Baz
100     0       200
100     1       300
100     2       400

Note: The heading NAME must be a JSON escaped string (eg. to have a column heading with embedded tab characters use %=foo\tbar instead of "%=foo bar").

Joins¶

Notice the empty column — some objects don´t have the bar key:

$ jt [ foo % ] bar % <<EOT
- {"foo":100,"bar":1000}
- {"foo":200}
- {"foo":300,"bar":3000}
- EOT
100     1000
200
300     3000

Enable inner join mode with the -j flag. This removes output rows when a key in the traversal path doesn´t exist:

$ jt -j [ foo % ] bar % <<EOT
- {"foo":100,"bar":1000}
- {"foo":200}
- {"foo":300,"bar":3000}
- EOT
100     1000
300     3000

Note that this does not remove rows when the key exists and the value is empty:

$ jt -j [ foo % ] bar % <<EOT
- {"foo":100,"bar":1000}
- {"foo":200,"bar":""}
- {"foo":300,"bar":3000}
- EOT
100     1000
200
300     3000

Explicit Iteration¶

Sometimes the implicit iteration over arrays is awkward:

$ jt . ^ . ^ % <<EOT
- {
-   "foo": [
-     {"bar":100},
-     {"bar":200}
-   ]
- }
- EOT
0       bar     100
1       bar     200

Should the first ^ be printing the array index of the implicit iteration (which it does, in this case) or the object key (i.e. foo) of the explicit iteration of the . command?

Another awkward case is printing arrays:

$ jt foo % <<EOT
- {
-   "foo": [
-     {"bar":100},
-     {"bar":200}
-   ]
- }
- EOT
{"bar":100}
{"bar":200}

The array can not be printed with the % command because it is being iterated over implicitly. Instead, the items in the array are printed, which may not be the desired behavior.

The -a flag eliminates the ambiguity by enabling explicit iteration. In this mode the . command must be used to iterate over both objects and arrays — arrays are not automatically iterated over.

Now the array can be printed:

$ jt -a foo % <<EOT
- {
-   "foo": [
-     {"bar":100},
-     {"bar":200}
-   ]
- }
- EOT
[{"bar":100},{"bar":200}]

Or the first ^ can print the array index, as before:

$ jt -a . . ^ . ^ % <<EOT
- {
-   "foo": [
-     {"bar":100},
-     {"bar":200}
-   ]
- }
- EOT
0       bar     100
1       bar     200

Or it can print the object key:

$ jt -a . ^ . . ^ % <<EOT
- {
-   "foo": [
-     {"bar":100},
-     {"bar":200}
-   ]
- }
- EOT
foo     bar     100
foo     bar     200

Or, with the addition of one more ^ command, it can print both:

$ jt -a . ^ . ^ . ^ % <<EOT
- {
-   "foo": [
-     {"bar":100},
-     {"bar":200}
-   ]
- }
- EOT
foo     0       bar     100
foo     1       bar     200