python/jc
1
0
Fork 0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-07-13 01:20:24 +02:00
Code Issues Releases Activity

readme update

Browse Source
This commit is contained in:
Kelly Brazil
2019-10-17 15:03:32 -07:00
parent 3b74afc39e
commit 8073d15fe1
1 changed files with 12 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -3,8 +3,13 @@ JSON CLI output utility
`jc` is used to JSONify the output of many standard linux cli tools for easier parsing in scripts. Parsers for `ls`, `ifconfig`, and `netstat` are currently included and more can be added via modules. `jc` is used to JSONify the output of many standard linux cli tools for easier parsing in scripts. Parsers for `ls`, `ifconfig`, and `netstat` are currently included and more can be added via modules.
## Installation
```
$ pip3 install jc
```
## Usage ## Usage
`jc` accepts piped input from `STDIN` and outputs a JSON representation of the previous command to `STDOUT`. The JSON output can be compact or pretty formatted. `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.
The first argument is required and identifies the command that is piping output to `jc` input. For example: The first argument is required and identifies the command that is piping output to `jc` input. For example:
- `--ls` enables the `ls` parser - `--ls` enables the `ls` parser
@ -46,7 +51,8 @@ $ ls -l /bin | jc --ls -p
}, },
... ...
] ]
```
```
$ ifconfig | jc --ifconfig -p $ ifconfig | jc --ifconfig -p
[ [
{ {
@ -128,7 +134,8 @@ $ ifconfig | jc --ifconfig -p
"metric": null "metric": null
} }
] ]
```
```
$ netstat -p | jc --netstat -p $ netstat -p | jc --netstat -p
{ {
"client": { "client": {
@ -160,7 +167,8 @@ $ netstat -p | jc --netstat -p
} }
} }
} }
```
```
$ netstat -lp | jc --netstat -p $ netstat -lp | jc --netstat -p
{ {
"server": { "server": {