README.md


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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305

# jp

Dead simple terminal plots from JSON (or CSV) data. Bar charts, line charts, and scatter plots are supported.

<!-- TOC -->

- [Get it](#get-it)
- [Use it](#use-it)
- [Examples](#examples)
    - [Screenshots](#screenshots)
    - [Bar chart](#bar-chart)
        - [Separate X and Y values](#separate-x-and-y-values)
        - [XY pairs](#xy-pairs)
        - [Y values only (X=index)](#y-values-only-xindex)
        - [Array data](#array-data)
    - [Line chart](#line-chart)
        - [Array data, separate X and Y values](#array-data-separate-x-and-y-values)
        - [Array data, XY pairs](#array-data-xy-pairs)
        - [Y values only (X=index)](#y-values-only-xindex-1)
    - [Scatter plot](#scatter-plot)
    - [CSV input](#csv-input)

<!-- /TOC -->

## Get it

```bash
go get -u github.com/sgreben/jp/cmd/jp
```

Or [download the binary](https://github.com/sgreben/jp/releases/latest) from the releases page. 

```bash
# Linux
curl -LO https://github.com/sgreben/jp/releases/download/1.1.2/jp_1.1.2_linux_x86_64.zip
unzip jp_1.1.2_linux_x86_64.zip

# OS X
curl -LO https://github.com/sgreben/jp/releases/download/1.1.2/jp_1.1.2_osx_x86_64.zip
unzip jp_1.1.2_osx_x86_64.zip

# Windows
curl -LO https://github.com/sgreben/jp/releases/download/1.1.2/jp_1.1.2_windows_x86_64.zip
unzip jp_1.1.2_windows_x86_64.zip
```

## Use it

`jp` reads JSON on stdin and prints plots to stdout.

```text
Usage of jp:
  -type value
    	Plot type. One of [line bar scatter] (default line)
  -x string
    	x values (JSONPath expression)
  -y string
    	y values (JSONPath expression)
  -xy string
    	x,y value pairs (JSONPath expression). Overrides -x and -y if given.
  -height int
    	Plot height (default 0 (auto))
  -width int
    	Plot width (default 0 (auto))
  -canvas value
    	Canvas type. One of [full quarter braille auto] (default auto)
  -input value
        Input type. One of [json csv] (default json)
```

## Examples

### Screenshots

In case you're on mobile, here's some PNGs of what `jp` output looks like:

- ![Scatter plot](docs/scatter_plot.png)
- ![Bar chart](docs/bar_chart.png)
- ![Line chart](docs/line_chart.png)

### Bar chart

#### Separate X and Y values

```bash
$ cat examples/tcp-time.json | jp -x ..Label -y ..Count -type bar

         69                                                                     
    █████████████                                                               
    █████████████                                                               
    █████████████                                                               
    █████████████                                                               
    █████████████                                                               
    █████████████      21                                                       
    █████████████ █████████████       7             2             1             
    █████████████ █████████████ ▄▄▄▄▄▄▄▄▄▄▄▄▄ ▁▁▁▁▁▁▁▁▁▁▁▁▁ ▁▁▁▁▁▁▁▁▁▁▁▁▁       
                                                                                
     46.85267ms    48.38578ms    49.91889ms     51.452ms     52.98511ms         
```


#### XY pairs

```bash
$ cat examples/tcp-time.json | jp -xy "..[Label,Count]" -type bar

         69                                                                     
    █████████████                                                               
    █████████████                                                               
    █████████████                                                               
    █████████████                                                               
    █████████████                                                               
    █████████████      21                                                       
    █████████████ █████████████       7             2             1             
    █████████████ █████████████ ▄▄▄▄▄▄▄▄▄▄▄▄▄ ▁▁▁▁▁▁▁▁▁▁▁▁▁ ▁▁▁▁▁▁▁▁▁▁▁▁▁       
                                                                                
     46.85267ms    48.38578ms    49.91889ms     51.452ms     52.98511ms                
```

#### Y values only (X=index)

```bash
$ cat examples/tcp-time.json | jp -y ..Count -type bar

         69                                                                     
    █████████████                                                               
    █████████████                                                               
    █████████████                                                               
    █████████████                                                               
    █████████████                                                               
    █████████████      21                                                       
    █████████████ █████████████       7             2             1             
    █████████████ █████████████ ▄▄▄▄▄▄▄▄▄▄▄▄▄ ▁▁▁▁▁▁▁▁▁▁▁▁▁ ▁▁▁▁▁▁▁▁▁▁▁▁▁       
                                                                                
          0             1             2             3             4             
```

#### Array data

```bash
$ echo '[[-3, 5], [-2, 0], [-1, 0.1], [0, 1], [1, 2], [2, 3]]' | jp -xy '[*][0, 1]' -type bar

         5                                                                      
    ███████████                                                                 
    ███████████                                                                 
    ███████████                                                      3          
    ███████████                                                 ▄▄▄▄▄▄▄▄▄▄▄     
    ███████████                                          2      ███████████     
    ███████████                              1      ███████████ ███████████     
    ███████████                 0.1     ▄▄▄▄▄▄▄▄▄▄▄ ███████████ ███████████     
    ███████████      0      ▁▁▁▁▁▁▁▁▁▁▁ ███████████ ███████████ ███████████     
                                                                                
        -3          -2          -1           0           1           2          
```

### Line chart

#### Array data, separate X and Y values

```bash
$ jq -n '[range(200)/20 | [., sin]]' | jp -x '[*][0]' -y '[*][1]'

  1.059955│        ▄▄▄▄▖                                    ▄▄▄▄▖               
          │      ▗▀    ▝▚▖                                ▗▛▘   ▝▚▖             
          │     ▟▘       ▀▖                              ▄▘       ▝▖            
          │    ▟          ▝▖                            ▞▘         ▝▖           
          │   ▟            ▝▖                          ▞▘           ▝▖          
          │  ▐              ▐                         ▗▘             ▐▖         
          │ ▐▘               ▚                       ▗▘               ▐         
          │▗▘                 ▚                      ▞                 ▚        
          │▞                  ▝▖                    ▞                   ▌       
          │                    ▝▖                  ▐                    ▝▖      
          │                     ▐                 ▗▘                     ▀▖     
          │                      ▚               ▗▘                       ▚     
          │                       ▚             ▗▞                         ▙    
          │                       ▝▚            ▞                           ▘   
          │                        ▝▄         ▗▞                                
          │                         ▝▙        ▞                                 
          │                           ▚▖    ▄▛                                  
          │                            ▝▀▀▀▀▘                                   
 -1.059955└─────────────────────────────────────────────────────────────────────
          0                                                               10.547
```

#### Array data, XY pairs

```bash
$ jq -n '[range(200)/20 | [., sin]]' | jp -xy '[*][0, 1]'

  1.059955│        ▄▄▄▄▖                                    ▄▄▄▄▖               
          │      ▗▀    ▝▚▖                                ▗▛▘   ▝▚▖             
          │     ▟▘       ▀▖                              ▄▘       ▝▖            
          │    ▟          ▝▖                            ▞▘         ▝▖           
          │   ▟            ▝▖                          ▞▘           ▝▖          
          │  ▐              ▐                         ▗▘             ▐▖         
          │ ▐▘               ▚                       ▗▘               ▐         
          │▗▘                 ▚                      ▞                 ▚        
          │▞                  ▝▖                    ▞                   ▌       
          │                    ▝▖                  ▐                    ▝▖      
          │                     ▐                 ▗▘                     ▀▖     
          │                      ▚               ▗▘                       ▚     
          │                       ▚             ▗▞                         ▙    
          │                       ▝▚            ▞                           ▘   
          │                        ▝▄         ▗▞                                
          │                         ▝▙        ▞                                 
          │                           ▚▖    ▄▛                                  
          │                            ▝▀▀▀▀▘                                   
 -1.059955└─────────────────────────────────────────────────────────────────────
          0                                                               10.547
```

#### Y values only (X=index)

```bash
$ cat examples/tcp-time.json | jp -y ..Duration

 5.342888e+07│▐▌                                                                
             │▐▌                                                                
             │▐▐                                                                
             │▐▐                           ▐                                    
             │▐▐                           ▐                                    
             │▐▐                           ▐                                    
             │▐▐                           ▐                                    
             │▞▐                           ▐▖                                   
             │▌▐                           ▐▌                                   
             │▌▐                           ▐▌                                   
             │▌▐                           ▞▌   ▌                               
             │▌▐             ▗     ▄       ▌▌   ▌                               
             │▘▐           ▗ ▐    ▞▐       ▌▌   ▌                               
             │ ▐      ▗    ▟ █    ▌▐       ▌▌  ▗▌                               
             │ ▐   ▙  ▐▌   █ █    ▌▐   ▟   ▌▌  ▐▌                               
             │  ▌  ▛▖ ▐▐  ▗▜ █    ▌ ▌▗ █   ▌▌  ▐▌                               
             │  ▌ ▟ ▚ ▌▐▗ ▐▝▟▐    ▌ ▌▟▐ ▌  ▌▚  ▐▌                 ▖             
             │  ▌ █ ▐ ▌▐▐▌▐ █ ▌▗ ▐  ▌▛▟ ▌▗ ▌▐  ▐▐                 ▌             
             │  ▌▗▀ ▝▄▘ ▛▐▌ ▛ ▌▟ ▐  ▀ ▌ ▌▐ ▌▐  ▐▐                ▗▚             
             │  ▌▐   ▘  ▌ ▘ ▌ ▌█ ▐    ▘ ▐▛▖▌▐  ▐▐  ▗▌ ▖     ▖    ▐▐             
             │  ▙▐      ▘   ▘ █▐ ▐      ▝▌▌▌▐▄ ▞▐  ▌▌▗▜    ▐▌    ▐▐  ▗▖         
             │  ▜▐            ▌ ▌▟        █   ▌▌▐ ▄▘▚▐▐ ▗▄ ▌▐▖ ▗ ▞▐▐ ▞▚  ▗ ▖▗▌▐▄
             │  ▝▞              ▙▘        ▜   ▐▌▐▐▜ ▐▞ ▌▐▝▟  ▝▄▀▄▘▝▞▀▘▝▖ ▞▄▌▌▌▌ 
             │   ▌              ▛         ▐    ▌▐▌▝ ▝▌ ▚▌          ▌   ▚▞▘▜▐ ▐▘ 
             │   ▘              ▘         ▝            ▝▌          ▘   ▝     ▝  
             │                                                                  
             │                                                                  
             │                                                                  
 4.591664e+07└──────────────────────────────────────────────────────────────────
             0                                                             97.02
```

### Scatter plot

```bash
$ cat examples/mvrnorm.json | jp -xy '..[x,y]' -type scatter

 3.535344│                                 ⠄             ⠄                     
         │                               ⠈⠂   ⠂       ⡀ ⠂                      
         │                          ⠐⡀⡀⡂   ⠁  ⢄  ⠁ ⠠                           
         │                            ⡀    ⠆     ⠈  ⠄⡀        ⠂                
         │           ⡀       ⠠  ⡀ ⡀ ⠄  ⡀⠐⠄⠁⠐ ⠠⢆⠠⠂⠂⠄⣀⢈  ⡀⠈ ⡀                    
         │                     ⡀⠂⠂⠄ ⡀⠂⢔⠠ ⢤⢀⠌⣡⠁⠦⠄⠐⡐⠂⣀⠅⠁⠈ ⠂ ⠈⠁⠁      ⡀     ⠄     
         │  ⡀         ⢀  ⠄     ⠈⠠ ⠡⠑⠈⠈⢢⡁⡄⢈⠂⢡⠈⡄⡀⠈⠰⢉⡠⠘⢄⢃⠉⢀⣄⠢⠠⠄ ⠠ ⡀⠁ ⡀ ⠂          
         │                   ⠈ ⡂⠈⡁⠈⠄⢂⡹⡐⡡⡆⡥⣙⡶⡼⠱⣅⣅⣼⢗⡱⢐⣈⠑⢁⠂ ⢐⢁⠭⠘⡀  ⠈              
         │                ⠁ ⢀⠄⢈⠈⡰⢀⡥⠋⣧⣓⣚⡛⢲⣽⣝⣭⢙⣟⢲⡽⣋⡠⣿⣜⣵⠙⡦⠗ ⣡⠁⠁⠁⠄⠠ ⠄⡂             
         │                  ⠄⠌⠌⠡⠉⡐⢯⣵⡏⢵⡞⠂⢰⣽⣷⢛⣯⡣⣷⢭⣞⣏⠤⣾⢡⡻⠢⢊⢠⡠⠸⢄⣃⡀⢁⠐ ⠐⡀ ⠂    ⠄     
         │              ⠨ ⡈⠂ ⢀⢑⠄⣜⡾⣴⢨⠶⣪⣧⢿⣷⣷⡱⣿⣞⣲⣮⣮⣯⢾⡷⡬⡷⣺⠤⢏⡼⣨⢌⡬⠠⢂⢠⠒⠱⠆⡈            
         │          ⠈  ⠃ ⠄⡐⠂⠐⢀⢈⣂⡈⣳⣷⣜⢺⣿⣹⣷⣼⣯⡿⣃⣽⣿⢾⣟⣾⢵⣻⠯⡼⡃⣼⣗⢲⠪⠇⣉⠺ ⢱⠠⠙⡀⢐⠌           
         │          ⠄   ⠈⠊⠐⠑⠨⠚⢁⡊⢾⡶⢩⢿⣏⣽⢞⣼⣇⣵⣿⣿⣽⣿⢽⣭⠺⣿⣽⣳⢚⣾⣻⣾⣜⠩⡒⣃⠈⢢⠕⢂⢰⡀  ⡔⢀⢀    ⡀   
         │            ⢀⠂⠁⠂⠇ ⠂⠊⢀⠐⡘⡍⡇⣚⢸⢟⣯⢿⣳⡪⣫⣵⣿⣯⣿⢿⣷⣻⣖⣗⣻⣚⢥⡷⣕⣏⠶⠊⠄⣠⠰⠂⡄⠂ ⠄⠁          
         │             ⠠⢂ ⠘⠐⣀ ⣀⢡⢐⠔⢫⠯⢕⠫⠿⣹⢶⣾⡻⣭⣽⢗⠿⣹⣛⣺⣿⠯⢲⡼⣵⢉⣭⢐⣟⡍⠄⠈⠥⠄   ⠁   ⠄       
         │             ⠈⠂  ⠊⡀⡈⠢⡌⡠⠖⢤⠥⡑⣯⣾⣴⣯⡿⣯⣝⣯⣿⠧⣽⣒⢾⣼⣻⣛⣗⡹⡽⢪⠯⠒⡨⠈ ⠈⡐⢄ ⠂⠘⠠        ⠂ 
         │              ⠰  ⡀⠃⠁⠠ ⠉⡈⡨⡱⢍⠌⠷⣯⠫⠬⡙⣴⣯⡣⡟⡮⠩⣫⠿⢞⢵⡰⠞⡂⠴ ⠕⢀⡂⠁ ⢀ ⠤   ⠈         
         │               ⢩⠂ ⠁⡄ ⢀⠲⢂⠑⢁⡘⠄⠵⣣⢑⢻⠨⡩⣌⠕⢮⣮⣋⢹⡁⣊⡃⠈⡕⡘⡠⠨⠄⡘⠨ ⠊⠁   ⠂           
         │          ⠐     ⢀ ⠈⠐⠔⠈  ⠁⢀⣀⡃⣊⢁⡘⠁⠛⠨ ⠒⡑⡀⠵⢙⠄⠡⠢⠃⠄⠋⠅ ⠥⠁⠠⢀ ⠄               
         │                  ⢀⢁ ⠆   ⠉⠁⠐ ⠄⠁⢑⡀⢀⠠⠑⢡⢊⠂⠑⠌⡅⠊⠄⠉⢈⡐  ⡀ ⠠   ⠂             
         │                      ⢀   ⠑ ⠂  ⡁ ⠌⢠⠈⠂⠄⠉⡃⠈⠄   ⠂⠠⠁ ⠄  ⢀ ⠠              
         │                             ⠐ ⠐ ⢁⠂⠂⠢⠠⠄⠔⠐       ⠁                    
         │                         ⠢  ⠁    ⠂⠐  ⠐       ⠐   ⠈                   
         │                           ⢀  ⠄⠈       ⠈                             
         │                                        ⠐                            
         │                                                                     
         │                                                                     
         │                                      ⠈                              
-4.271874└─────────────────────────────────────────────────────────────────────
          -4.08815                                                       3.79083
```

### CSV input

```
$ cat examples/sin.csv | jp -input csv -xy '[*][0,1]'

  1.059955│       ▗▄▛▀▀▚▄▖                                    ▄▄▀▀▀▄▄
          │     ▗▞▘      ▝▚▖                                ▄▀      ▝▀▄
          │    ▟▘          ▝▄                             ▗▀          ▝▀▖
          │  ▗▛              ▚▖                          ▞▘             ▝▙
          │ ▄▘                ▀▖                        ▞                 ▚
          │▞▘                  ▝▌                     ▗▛                   ▚▖
          │                     ▝▚                   ▐▘                     ▝▄
          │                       ▜▖                ▟▘                       ▝▄
          │                        ▐▄             ▗▞                          ▝▚
          │                          ▚▖          ▄▀
          │                           ▀▙▖      ▄▛
          │                             ▀▀▄▄▄▞▀▘
 -1.059955└─────────────────────────────────────────────────────────────────────
          0                                                                 9.95
```