summaryrefslogtreecommitdiffstats
path: root/README.md
blob: 3e701ed1198f1b439680c43832d83f05bc6a23c9 (plain)
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
# jp

Dead simple terminal plots from JSON data. Bar charts and line charts 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)
        - [Y values only (X=index)](#y-values-only-xindex-1)
        - [Array data, separate X and Y values](#array-data-separate-x-and-y-values)
        - [Array data, XY pairs](#array-data-xy-pairs)

<!-- /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.0.1/jp_1.0.1_linux_x86_64.zip
unzip jp_1.0.1_linux_x86_64.zip

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

# Windows
curl -LO https://github.com/sgreben/jp/releases/download/1.0.1/jp_1.0.1_windows_x86_64.zip
unzip jp_1.0.1_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] (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))
```

## Examples

### Screenshots

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

- ![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.0
     █████████████
     █████████████
     █████████████
     █████████████
     █████████████     21.0
     █████████████ █████████████      7.0           2.0           1.0
     █████████████ █████████████ ▁▁▁▁▁▁▁▁▁▁▁▁▁ ▁▁▁▁▁▁▁▁▁▁▁▁▁ ▁▁▁▁▁▁▁▁▁▁▁▁▁

      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.0
     █████████████
     █████████████
     █████████████
     █████████████
     █████████████     21.0
     █████████████ █████████████      7.0           2.0           1.0
     █████████████ █████████████ ▁▁▁▁▁▁▁▁▁▁▁▁▁ ▁▁▁▁▁▁▁▁▁▁▁▁▁ ▁▁▁▁▁▁▁▁▁▁▁▁▁

      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.0
     █████████████
     █████████████
     █████████████
     █████████████
     █████████████     21.0
     █████████████ █████████████      7.0           2.0           1.0
     █████████████ █████████████ ▁▁▁▁▁▁▁▁▁▁▁▁▁ ▁▁▁▁▁▁▁▁▁▁▁▁▁ ▁▁▁▁▁▁▁▁▁▁▁▁▁

           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.0
    ███████████
    ███████████
    ███████████                                                     3.0
    ███████████                                                 ███████████
    ███████████                                         2.0     ███████████
    ███████████     0.0         0.1         1.0     ███████████ ███████████
    ███████████             ▁▁▁▁▁▁▁▁▁▁▁ ███████████ ███████████ ███████████

        -3          -2          -1           0           1           2
```

### Line chart

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

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

59970040.9│                                                                                         
                                                                                                   
                                                                                                   
                                                                                                  
          │██                                                                                       
          │██                                                                                      
          │█                                                                                     
          y█     ██  ██           ███  ███                                                    
            ██ ██ ███  ████ ███ ██    ██  ███  ██    ██  ██     ██      ██  ██           
                                ██               ██ ████ ██  █████  ██████   ██ ████████  ██                                                                                                    
                                                                                                   
                                                                                                   
42167403.0└───────────────────────────────────────x─────────────────────────────────────────────────
           0.0                                                                                  99.0

```

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

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

1.1         ███████                                        ██████
          ███     ███                                    ███     ███
        ███          ██                                ██          ███
       ██             ███                             ██             ██
                       ██                          ██                ███
    │██                   ██                        ██                   ██
    │█                                            ██                     ██
    y                                           ██                                                      ██                ██                           ██
                              ██              ██                             ██
                                ██          ██
                                  ██     ████
                                    ██████
-1.1└───────────────────────────────────x───────────────────────────────────────
     0.0                                                                     9.9
```

#### Array data, XY pairs

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

1.1         ███████                                        ██████
          ███     ███                                    ███     ███
        ███          ██                                ██          ███
       ██             ███                             ██             ██
                       ██                          ██                ███
    │██                   ██                        ██                   ██
    │█                                            ██                     ██
    y                                           ██                                                      ██                ██                           ██
                              ██              ██                             ██
                                ██          ██
                                  ██     ████
                                    ██████
-1.1└───────────────────────────────────x───────────────────────────────────────
     0.0                                                                     9.9
```