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

add options to docs

Browse Source
This commit is contained in:
Kelly Brazil
2019-11-12 07:18:27 -08:00
parent f0b1ab4233
commit cb5729a070
1 changed files with 71 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

124
README.md
View File

@ -45,7 +45,11 @@ The `jc` parsers can also be used as python modules. In this case the output wil
{'filename': 'echo', 'flags': '-rwxr-xr-x', 'links': '1', 'owner': 'root', 'group': 'wheel', {'filename': 'echo', 'flags': '-rwxr-xr-x', 'links': '1', 'owner': 'root', 'group': 'wheel',
'size': '18128', 'date': 'May 3 22:26'}] 'size': '18128', 'date': 'May 3 22:26'}]
``` ```
Two representations of the data are possible. The default representation uses a strict schema per parser and converts known numbers to int/float JSON values. Certain known values of None are converted to JSON Null, and, in some cases, additional semantic context fields are added. To access the raw, pre-processed JSON, use the `-r` or `raw=True` options. Two representations of the data are possible. The default representation uses a strict schema per parser and converts known numbers to int/float JSON values. Certain known values of None are converted to JSON Null, known boolean values are converted, and, in some cases, additional semantic context fields are added.
To access the raw, pre-processed JSON, use the `-r` or `raw=True` options.
Schemas for each parser can be found in the `docs/parsers` folder.
## Installation ## Installation
``` ```
@ -82,7 +86,9 @@ jc PARSER [OPTIONS]
- `--w` enables the `w` parser - `--w` enables the `w` parser
### Options ### Options
- `-d` debug mode. Prints trace messages if parsing issues encountered
- `-p` pretty format the JSON output - `-p` pretty format the JSON output
- `-q` quiet mode. Suppresses warning messages
- `-r` raw output. Provides a more literal JSON output with all values as text and no additional sematic processing - `-r` raw output. Provides a more literal JSON output with all values as text and no additional sematic processing
## Examples ## Examples
@ -183,14 +189,18 @@ $ df | jc --df -p
$ dig cnn.com www.cnn.com @205.251.194.64 | jc --dig -p $ dig cnn.com www.cnn.com @205.251.194.64 | jc --dig -p
[ [
{ {
"id": "28182", "id": 5509,
"opcode": "QUERY", "opcode": "QUERY",
"status": "NOERROR", "status": "NOERROR",
"flags": "qr rd ra", "flags": [
"query_num": "1", "qr",
"answer_num": "4", "rd",
"authority_num": "0", "ra"
"additional_num": "1", ],
"query_num": 1,
"answer_num": 4,
"authority_num": 0,
"additional_num": 1,
"question": { "question": {
"name": "cnn.com.", "name": "cnn.com.",
"class": "IN", "class": "IN",
@ -201,45 +211,49 @@ $ dig cnn.com www.cnn.com @205.251.194.64 | jc --dig -p
"name": "cnn.com.", "name": "cnn.com.",
"class": "IN", "class": "IN",
"type": "A", "type": "A",
"ttl": "5", "ttl": 60,
"data": "151.101.193.67"
},
{
"name": "cnn.com.",
"class": "IN",
"type": "A",
"ttl": "5",
"data": "151.101.1.67"
},
{
"name": "cnn.com.",
"class": "IN",
"type": "A",
"ttl": "5",
"data": "151.101.129.67" "data": "151.101.129.67"
}, },
{ {
"name": "cnn.com.", "name": "cnn.com.",
"class": "IN", "class": "IN",
"type": "A", "type": "A",
"ttl": "5", "ttl": 60,
"data": "151.101.193.67"
},
{
"name": "cnn.com.",
"class": "IN",
"type": "A",
"ttl": 60,
"data": "151.101.1.67"
},
{
"name": "cnn.com.",
"class": "IN",
"type": "A",
"ttl": 60,
"data": "151.101.65.67" "data": "151.101.65.67"
} }
], ],
"query_time": "45 msec", "query_time": 28,
"server": "192.168.71.2#53(192.168.71.2)", "server": "2600",
"when": "Wed Oct 30 03:11:21 PDT 2019", "when": "Tue Nov 12 07:13:03 PST 2019",
"rcvd": "100" "rcvd": 100
}, },
{ {
"id": "23264", "id": 62696,
"opcode": "QUERY", "opcode": "QUERY",
"status": "NOERROR", "status": "NOERROR",
"flags": "qr aa rd", "flags": [
"query_num": "1", "qr",
"answer_num": "1", "aa",
"authority_num": "4", "rd"
"additional_num": "1", ],
"query_num": 1,
"answer_num": 1,
"authority_num": 4,
"additional_num": 1,
"question": { "question": {
"name": "www.cnn.com.", "name": "www.cnn.com.",
"class": "IN", "class": "IN",
@ -250,7 +264,7 @@ $ dig cnn.com www.cnn.com @205.251.194.64 | jc --dig -p
"name": "www.cnn.com.", "name": "www.cnn.com.",
"class": "IN", "class": "IN",
"type": "CNAME", "type": "CNAME",
"ttl": "300", "ttl": 300,
"data": "turner-tls.map.fastly.net." "data": "turner-tls.map.fastly.net."
} }
], ],
@ -259,35 +273,35 @@ $ dig cnn.com www.cnn.com @205.251.194.64 | jc --dig -p
"name": "cnn.com.", "name": "cnn.com.",
"class": "IN", "class": "IN",
"type": "NS", "type": "NS",
"ttl": "3600", "ttl": 3600,
"data": "ns-1086.awsdns-07.org." "data": "ns-1086.awsdns-07.org."
}, },
{ {
"name": "cnn.com.", "name": "cnn.com.",
"class": "IN", "class": "IN",
"type": "NS", "type": "NS",
"ttl": "3600", "ttl": 3600,
"data": "ns-1630.awsdns-11.co.uk." "data": "ns-1630.awsdns-11.co.uk."
}, },
{ {
"name": "cnn.com.", "name": "cnn.com.",
"class": "IN", "class": "IN",
"type": "NS", "type": "NS",
"ttl": "3600", "ttl": 3600,
"data": "ns-47.awsdns-05.com." "data": "ns-47.awsdns-05.com."
}, },
{ {
"name": "cnn.com.", "name": "cnn.com.",
"class": "IN", "class": "IN",
"type": "NS", "type": "NS",
"ttl": "3600", "ttl": 3600,
"data": "ns-576.awsdns-08.net." "data": "ns-576.awsdns-08.net."
} }
], ],
"query_time": "33 msec", "query_time": 29,
"server": "205.251.194.64#53(205.251.194.64)", "server": "205.251.194.64#53(205.251.194.64)",
"when": "Wed Oct 30 03:11:21 PDT 2019", "when": "Tue Nov 12 07:13:03 PST 2019",
"rcvd": "212" "rcvd": 212
} }
] ]
``` ```
@ -295,14 +309,18 @@ $ dig cnn.com www.cnn.com @205.251.194.64 | jc --dig -p
$ dig -x 1.1.1.1 | jc --dig -p $ dig -x 1.1.1.1 | jc --dig -p
[ [
{ {
"id": "27526", "id": 50324,
"opcode": "QUERY", "opcode": "QUERY",
"status": "NOERROR", "status": "NOERROR",
"flags": "qr rd ra", "flags": [
"query_num": "1", "qr",
"answer_num": "1", "rd",
"authority_num": "0", "ra"
"additional_num": "1", ],
"query_num": 1,
"answer_num": 1,
"authority_num": 0,
"additional_num": 1,
"question": { "question": {
"name": "1.1.1.1.in-addr.arpa.", "name": "1.1.1.1.in-addr.arpa.",
"class": "IN", "class": "IN",
@ -310,17 +328,17 @@ $ dig -x 1.1.1.1 | jc --dig -p
}, },
"answer": [ "answer": [
{ {
"name": "1.1.1.1.IN-ADDR.ARPA.", "name": "1.1.1.1.in-addr.arpa.",
"class": "IN", "class": "IN",
"type": "PTR", "type": "PTR",
"ttl": "5", "ttl": 1634,
"data": "one.one.one.one." "data": "one.one.one.one."
} }
], ],
"query_time": "34 msec", "query_time": 36,
"server": "192.168.71.2#53(192.168.71.2)", "server": "2600",
"when": "Wed Oct 30 03:13:48 PDT 2019", "when": "Tue Nov 12 07:13:49 PST 2019",
"rcvd": "98" "rcvd": 78
} }
] ]
``` ```