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

add note that the streaming parser outputs JSON Lines

This commit is contained in:
Kelly Brazil
2021-09-27 10:35:08 -07:00
parent b724e0969a
commit 30cff5f281
8 changed files with 17 additions and 3 deletions

View File

@ -3,7 +3,9 @@
# jc.parsers.ls_s
jc - JSON CLI output utility `ls` and `vdir` command output streaming parser
This streaming parser requires the `-l` option to be used on `ls`. If there are newline characters in the filename, then make sure to use the `-b` option on `ls`.
> This streaming parser outputs JSON Lines
Requires the `-l` option to be used on `ls`. If there are newline characters in the filename, then make sure to use the `-b` option on `ls`.
The `jc` `-qq` option can be used to ignore parsing errors. (e.g. filenames with newline characters, but `-b` was not used)

View File

@ -3,6 +3,8 @@
# jc.parsers.ping_s
jc - JSON CLI output utility `ping` command output streaming parser
> This streaming parser outputs JSON Lines
Supports `ping` and `ping6` output.
Usage (cli):

View File

@ -3,6 +3,8 @@
# jc.parsers.vmstat_s
jc - JSON CLI output utility `vmstat` command output streaming parser
> This streaming parser outputs JSON Lines
Options supported: `-a`, `-w`, `-d`, `-t`
The `epoch` calculated timestamp field is naive (i.e. based on the local time of the system the parser is run on)

View File

@ -1,5 +1,7 @@
"""jc - JSON CLI output utility `foo` command output streaming parser
> This streaming parser outputs JSON Lines
<<Short foo description and caveats>>
Usage (cli):

View File

@ -1,6 +1,8 @@
"""jc - JSON CLI output utility `ls` and `vdir` command output streaming parser
This streaming parser requires the `-l` option to be used on `ls`. If there are newline characters in the filename, then make sure to use the `-b` option on `ls`.
> This streaming parser outputs JSON Lines
Requires the `-l` option to be used on `ls`. If there are newline characters in the filename, then make sure to use the `-b` option on `ls`.
The `jc` `-qq` option can be used to ignore parsing errors. (e.g. filenames with newline characters, but `-b` was not used)

View File

@ -1,5 +1,7 @@
"""jc - JSON CLI output utility `ping` command output streaming parser
> This streaming parser outputs JSON Lines
Supports `ping` and `ping6` output.
Usage (cli):

View File

@ -1,5 +1,7 @@
"""jc - JSON CLI output utility `vmstat` command output streaming parser
> This streaming parser outputs JSON Lines
Options supported: `-a`, `-w`, `-d`, `-t`
The `epoch` calculated timestamp field is naive (i.e. based on the local time of the system the parser is run on)

View File

@ -1,4 +1,4 @@
.TH jc 1 2021-09-26 1.17.0 "JSON CLI output utility"
.TH jc 1 2021-09-27 1.17.0 "JSON CLI output utility"
.SH NAME
jc \- JSONifies the output of many CLI tools and file-types
.SH SYNOPSIS