python/jc
1
0
Fork 0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-06-17 00:07:37 +02:00
Code Issues Releases Activity
Files
c2c189f3e6e900e5f3d35df9a9b9d033448baff6
jc/README.md

477 lines
10 KiB
Markdown
Raw Normal View History

First commit
2019-10-15 15:06:09 -07:00
# JC
change netstat pid field to integer
2019-10-17 13:04:34 -07:00
JSON CLI output utility
First commit
2019-10-15 15:06:09 -07:00
readme update
2019-10-22 11:14:19 -07:00
`jc` is used to JSONify the output of many standard linux cli tools for easier parsing in scripts. See the Parsers section for supported commands.
First commit
2019-10-15 15:06:09 -07:00
add acknowledgments
2019-10-18 09:57:10 -07:00
This allows further command line processing of output with tools like `jq` simply by piping commands:
```
fix jq example
2019-10-21 18:11:51 -07:00
$ ls -l /usr/bin | jc --ls | jq '.[] | select(.bytes > 50000000)'
add acknowledgments
2019-10-18 09:57:10 -07:00
{
"filename": "emacs",
"flags": "-r-xr-xr-x",
"links": 1,
"owner": "root",
"group": "wheel",
"bytes": 117164432,
"date": "May 3 22:26"
}
```
documentation enhancements
2019-10-22 07:40:42 -07:00
The `jc` parsers can also be used as python modules:
update doco
2019-10-21 14:13:31 -07:00
```
documentation enhancements
2019-10-22 07:40:42 -07:00
>>> import jc.parsers.ls
>>>
>>> data='''-rwxr-xr-x 1 root wheel 23648 May 3 22:26 cat
... -rwxr-xr-x 1 root wheel 30016 May 3 22:26 chmod
... -rwxr-xr-x 1 root wheel 29024 May 3 22:26 cp
... -rwxr-xr-x 1 root wheel 375824 May 3 22:26 csh
... -rwxr-xr-x 1 root wheel 28608 May 3 22:26 date
... -rwxr-xr-x 1 root wheel 32000 May 3 22:26 dd
... -rwxr-xr-x 1 root wheel 23392 May 3 22:26 df
... -rwxr-xr-x 1 root wheel 18128 May 3 22:26 echo'''
>>>
>>> jc.parsers.ls.parse(data)
[{'filename': 'cat', 'flags': '-rwxr-xr-x', 'links': 1, 'owner': 'root', 'group': 'wheel',
'bytes': 23648, 'date': 'May 3 22:26'}, {'filename': 'chmod', 'flags': '-rwxr-xr-x', 'links': 1,
'owner': 'root', 'group': 'wheel', 'bytes': 30016, 'date': 'May 3 22:26'}, {'filename': 'cp',
'flags': '-rwxr-xr-x', 'links': 1, 'owner': 'root', 'group': 'wheel', 'bytes': 29024,
'date': 'May 3 22:26'}, {'filename': 'csh', 'flags': '-rwxr-xr-x', 'links': 1, 'owner': 'root',
'group': 'wheel', 'bytes': 375824, 'date': 'May 3 22:26'}, {'filename': 'date',
'flags': '-rwxr-xr-x', 'links': 1, 'owner': 'root', 'group': 'wheel', 'bytes': 28608,
'date': 'May 3 22:26'}, {'filename': 'dd', 'flags': '-rwxr-xr-x', 'links': 1, 'owner': 'root',
'group': 'wheel', 'bytes': 32000, 'date': 'May 3 22:26'}, {'filename': 'df', 'flags': '-rwxr-xr-x',
'links': 1, 'owner': 'root', 'group': 'wheel', 'bytes': 23392, 'date': 'May 3 22:26'},
{'filename': 'echo', 'flags': '-rwxr-xr-x', 'links': 1, 'owner': 'root', 'group': 'wheel',
'bytes': 18128, 'date': 'May 3 22:26'}]
update doco
2019-10-21 14:13:31 -07:00
```
readme update
2019-10-21 17:20:12 -07:00
In this case the output will be a python dictionary instead of JSON.
update doco
2019-10-21 14:13:31 -07:00
readme update
2019-10-17 15:03:32 -07:00
## Installation
```
$ pip3 install jc
```
First commit
2019-10-15 15:06:09 -07:00
## Usage
readme update
2019-10-21 13:47:22 -07:00
```
jc [parser] [options]
```
readme update
2019-10-17 15:03:32 -07:00
`jc` accepts piped input from `STDIN` and outputs a JSON representation of the previous command's output to `STDOUT`. The JSON output can be compact or pretty formatted.
First commit
2019-10-15 15:06:09 -07:00
readme update
2019-10-21 13:47:22 -07:00
Parsers:
readme update
2019-10-22 11:14:19 -07:00
- `--df` enables the `df` parser
- `--env` enables the `env` parser
- `--free` enables the `free` parser
First commit
2019-10-15 15:06:09 -07:00
- `--ifconfig` enables the `ifconfig` parser
reorder parsers
2019-10-21 17:26:00 -07:00
- `--ls` enables the `ls` parser
First commit
2019-10-15 15:06:09 -07:00
- `--netstat` enables the `netstat` parser
formatting
2019-10-18 13:34:28 -07:00
- `--ps` enables the `ps` parser
add route documentation
2019-10-18 14:18:34 -07:00
- `--route` enables the `route` parser
First commit
2019-10-15 15:06:09 -07:00
readme update
2019-10-21 13:47:22 -07:00
Options:
- `-p` specifies whether to pretty format the JSON output
First commit
2019-10-15 15:06:09 -07:00
## Examples
add df, env, and free parsers
2019-10-22 11:10:11 -07:00
### df
```
$ df | jc --df -p
[
{
"Filesystem": "/dev/disk1s1",
"512-blocks": "976490576",
"Used": "268326664",
"Available": "702568152",
"Capacity": "28%",
"iused": "1395740",
"ifree": "9223372036853380067",
"%iused": "0%",
"Mounted": "/"
},
{
"Filesystem": "devfs",
"512-blocks": "680",
"Used": "680",
"Available": "0",
"Capacity": "100%",
"iused": "1178",
"ifree": "0",
"%iused": "100%",
"Mounted": "/dev"
},
{
"Filesystem": "map",
"512-blocks": "auto_home",
"Used": "0",
"Available": "0",
"Capacity": "0",
"iused": "100%",
"ifree": "0",
"%iused": "0",
"Mounted": "100%",
"on": "/home"
}
]
```
### env
```
$ env | jc --env -p
[
{
"TERM": "xterm-256color"
},
{
"SHELL": "/bin/bash"
},
{
"USER": "root"
},
{
"PATH": "/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin"
},
{
"PWD": "/bin"
},
{
"LANG": "en_US.UTF-8"
},
{
"HOME": "/root"
},
{
"_": "/usr/bin/env"
}
]
```
add acknowledgments
2019-10-18 09:57:10 -07:00
### ifconfig
readme update
2019-10-17 15:03:32 -07:00
```
readme update
2019-10-15 15:32:23 -07:00
$ ifconfig | jc --ifconfig -p
[
{
"name": "docker0",
"flags": "4099",
"state": "UP,BROADCAST,MULTICAST",
"mtu": "1500",
"ipv4_addr": "172.17.0.1",
"ipv4_mask": "255.255.0.0",
"ipv4_bcast": "0.0.0.0",
"mac_addr": "02:42:53:18:31:cc",
"type": "Ethernet",
"rx_packets": "0",
"rx_errors": "0",
"rx_dropped": "0",
"rx_overruns": "0",
"rx_frame": "0",
"tx_packets": "0",
"tx_errors": "0",
"tx_dropped": "0",
"tx_overruns": "0",
"tx_carrier": "0",
"tx_collisions": "0",
"ipv6_addr": null,
"ipv6_mask": null,
"ipv6_scope": null,
"metric": null
},
{
"name": "ens33",
"flags": "4163",
"state": "UP,BROADCAST,RUNNING,MULTICAST",
"mtu": "1500",
"ipv4_addr": "192.168.71.135",
"ipv4_mask": "255.255.255.0",
"ipv4_bcast": "192.168.71.255",
"ipv6_addr": "fe80::c1cb:715d:bc3e:b8a0",
"ipv6_mask": "64",
"ipv6_scope": "link",
"mac_addr": "00:0c:29:3b:58:0e",
"type": "Ethernet",
"rx_packets": "26348",
"rx_errors": "0",
"rx_dropped": "0",
"rx_overruns": "0",
"rx_frame": "0",
"tx_packets": "5308",
"tx_errors": "0",
"tx_dropped": "0",
"tx_overruns": "0",
"tx_carrier": "0",
"tx_collisions": "0",
"metric": null
},
{
"name": "lo",
"flags": "73",
"state": "UP,LOOPBACK,RUNNING",
"mtu": "65536",
"ipv4_addr": "127.0.0.1",
"ipv4_mask": "255.0.0.0",
"ipv4_bcast": null,
"ipv6_addr": "::1",
"ipv6_mask": "128",
"ipv6_scope": "host",
"mac_addr": null,
"type": "Local Loopback",
"rx_packets": "64",
"rx_errors": "0",
"rx_dropped": "0",
"rx_overruns": "0",
"rx_frame": "0",
"tx_packets": "64",
"tx_errors": "0",
"tx_dropped": "0",
"tx_overruns": "0",
"tx_carrier": "0",
"tx_collisions": "0",
"metric": null
}
]
readme update
2019-10-17 15:03:32 -07:00
```
reorder parsers
2019-10-21 17:26:00 -07:00
### ls
```
$ ls -l /bin | jc --ls -p
[
{
"filename": "bash",
"flags": "-r-xr-xr-x",
"links": 1,
"owner": "root",
"group": "wheel",
"bytes": 618416,
"date": "May 3 22:26"
},
{
"filename": "cat",
"flags": "-rwxr-xr-x",
"links": 1,
"owner": "root",
"group": "wheel",
"bytes": 23648,
"date": "May 3 22:26"
},
{
"filename": "chmod",
"flags": "-rwxr-xr-x",
"links": 1,
"owner": "root",
"group": "wheel",
"bytes": 30016,
"date": "May 3 22:26"
},
...
]
```
add acknowledgments
2019-10-18 09:57:10 -07:00
### netstat
readme update
2019-10-17 15:03:32 -07:00
```
documentation updates
2019-10-17 12:15:27 -07:00
$ netstat -p | jc --netstat -p
readme update
2019-10-21 13:47:22 -07:00
[
{
fix transport protocol
2019-10-21 18:22:51 -07:00
"transport_protocol": "tcp",
readme update
2019-10-21 13:47:22 -07:00
"network_protocol": "ipv4",
"local_address": "localhost.localdo",
"local_port": "34480",
"foreign_address": "lb-192-30-255-113",
"foreign_port": "https",
"state": "ESTABLISHED",
"pid": 53550,
"program_name": "git-remote-ht",
"receive_q": 0,
"send_q": 0
},
{
fix transport protocol
2019-10-21 18:22:51 -07:00
"transport_protocol": "tcp",
readme update
2019-10-21 13:47:22 -07:00
"network_protocol": "ipv4",
"local_address": "localhost.localdo",
"local_port": "34478",
"foreign_address": "lb-192-30-255-113",
"foreign_port": "https",
"state": "ESTABLISHED",
"pid": 53550,
"program_name": "git-remote-ht",
"receive_q": 0,
"send_q": 0
documentation updates
2019-10-17 12:15:27 -07:00
}
readme update
2019-10-21 13:47:22 -07:00
]
readme update
2019-10-17 15:03:32 -07:00
```
```
readme update
2019-10-21 13:47:22 -07:00
$ netstat -lpn | jc --netstat -p
[
{
fix transport protocol
2019-10-21 18:22:51 -07:00
"transport_protocol": "tcp",
readme update
2019-10-21 13:47:22 -07:00
"network_protocol": "ipv4",
"local_address": "127.0.0.1",
"local_port": "42351",
"foreign_address": "0.0.0.0",
"foreign_port": "*",
"state": "LISTEN",
"pid": 1112,
"program_name": "containerd",
"receive_q": 0,
"send_q": 0
},
{
fix transport protocol
2019-10-21 18:22:51 -07:00
"transport_protocol": "tcp",
readme update
2019-10-21 13:47:22 -07:00
"network_protocol": "ipv4",
"local_address": "127.0.0.53",
"local_port": "53",
"foreign_address": "0.0.0.0",
"foreign_port": "*",
"state": "LISTEN",
"pid": 885,
"program_name": "systemd-resolve",
"receive_q": 0,
"send_q": 0
},
{
fix transport protocol
2019-10-21 18:22:51 -07:00
"transport_protocol": "tcp",
readme update
2019-10-21 13:47:22 -07:00
"network_protocol": "ipv4",
"local_address": "0.0.0.0",
"local_port": "22",
"foreign_address": "0.0.0.0",
"foreign_port": "*",
"state": "LISTEN",
"pid": 1127,
"program_name": "sshd",
"receive_q": 0,
"send_q": 0
},
{
fix transport protocol
2019-10-21 18:22:51 -07:00
"transport_protocol": "tcp",
readme update
2019-10-21 13:47:22 -07:00
"network_protocol": "ipv6",
"local_address": "::",
"local_port": "22",
"foreign_address": "::",
"foreign_port": "*",
"state": "LISTEN",
"pid": 1127,
"program_name": "sshd",
"receive_q": 0,
"send_q": 0
},
{
fix transport protocol
2019-10-21 18:22:51 -07:00
"transport_protocol": "udp",
readme update
2019-10-21 13:47:22 -07:00
"network_protocol": "ipv4",
"local_address": "127.0.0.53",
"local_port": "53",
"foreign_address": "0.0.0.0",
"foreign_port": "*",
"pid": 885,
"program_name": "systemd-resolve",
"receive_q": 0,
"send_q": 0
},
{
fix transport protocol
2019-10-21 18:22:51 -07:00
"transport_protocol": "udp",
readme update
2019-10-21 13:47:22 -07:00
"network_protocol": "ipv4",
"local_address": "192.168.71.131",
"local_port": "68",
"foreign_address": "0.0.0.0",
"foreign_port": "*",
"pid": 867,
"program_name": "systemd-network",
"receive_q": 0,
"send_q": 0
documentation updates
2019-10-17 12:15:27 -07:00
}
readme update
2019-10-21 13:47:22 -07:00
]
First commit
2019-10-15 15:06:09 -07:00
```
formatting
2019-10-18 13:34:28 -07:00
### ps
```
$ ps -ef | jc --ps -p
[
{
"UID": "root",
"PID": "1",
"PPID": "0",
"C": "0",
"STIME": "13:58",
"TTY": "?",
"TIME": "00:00:05",
"CMD": "/lib/systemd/systemd --system --deserialize 35"
},
{
"UID": "root",
"PID": "2",
"PPID": "0",
"C": "0",
"STIME": "13:58",
"TTY": "?",
"TIME": "00:00:00",
"CMD": "[kthreadd]"
},
{
"UID": "root",
"PID": "4",
"PPID": "2",
"C": "0",
"STIME": "13:58",
"TTY": "?",
"TIME": "00:00:00",
"CMD": "[kworker/0:0H]"
},
{
"UID": "root",
"PID": "6",
"PPID": "2",
"C": "0",
"STIME": "13:58",
"TTY": "?",
"TIME": "00:00:00",
"CMD": "[mm_percpu_wq]"
},
...
]
```
add route documentation
2019-10-18 14:18:34 -07:00
### route
```
$ route -n | jc --route -p
[
{
"Destination": "0.0.0.0",
"Gateway": "192.168.71.2",
"Genmask": "0.0.0.0",
"Flags": "UG",
"Metric": "100",
"Ref": "0",
"Use": "0",
"Iface": "ens33"
},
{
"Destination": "172.17.0.0",
"Gateway": "0.0.0.0",
"Genmask": "255.255.0.0",
"Flags": "U",
"Metric": "0",
"Ref": "0",
"Use": "0",
"Iface": "docker0"
},
{
"Destination": "192.168.71.0",
"Gateway": "0.0.0.0",
"Genmask": "255.255.255.0",
"Flags": "U",
"Metric": "0",
"Ref": "0",
"Use": "0",
"Iface": "ens33"
},
{
"Destination": "192.168.71.2",
"Gateway": "0.0.0.0",
"Genmask": "255.255.255.255",
"Flags": "UH",
"Metric": "100",
"Ref": "0",
"Use": "0",
"Iface": "ens33"
}
]
```
formatting
2019-10-18 13:34:28 -07:00
## Contributions
Feel free to add/improve code or parsers!
add acknowledgments
2019-10-18 09:57:10 -07:00
## Acknowledgments
- `ifconfig-parser` module from https://github.com/KnightWhoSayNi/ifconfig-parser
formatting
2019-10-18 13:34:28 -07:00
- Parsing code from Conor Heine at https://gist.github.com/cahna/43a1a3ff4d075bcd71f9d7120037a501
Reference in New Issue Copy Permalink