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

usage update

This commit is contained in:
Kelly Brazil
2020-02-13 18:19:19 -08:00
parent 13bcdbc6c9
commit 6ba64f1128

View File

@ -71,6 +71,9 @@ $ pip3 install --upgrade jc
``` ```
## Usage ## Usage
`jc` accepts piped input from `STDIN` and outputs a JSON representation of the previous command's output to `STDOUT`.
Alternatively, the "magic" syntax can be used by prepending `jc` to the command to be converted. Options can be passed to `jc` immediately before the command is given.
``` ```
COMMAND | jc PARSER [OPTIONS] COMMAND | jc PARSER [OPTIONS]
``` ```
@ -78,12 +81,12 @@ or
``` ```
COMMAND | jc [OPTIONS] PARSER COMMAND | jc [OPTIONS] PARSER
``` ```
or or using the "magic" syntax
``` ```
jc [OPTIONS] COMMAND jc [OPTIONS] COMMAND
``` ```
`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 JSON output can be compact (default) or pretty formatted with the `-p` option.
### Parsers ### Parsers
- `--arp` enables the `arp` command parser - `--arp` enables the `arp` command parser