diff --git a/docs/parsers/env.md b/docs/parsers/env.md index 096af3e7..04b998a8 100644 --- a/docs/parsers/env.md +++ b/docs/parsers/env.md @@ -2,6 +2,8 @@ # jc.parsers.env jc - JSON CLI output utility `env` command output parser +This parser will output a list of dictionaries each containing `name` and `value` keys. If you would like a simple dictionary output, then use the `-r` command-line option or the `raw=True` argument in the `parse()` function. + Usage (cli): $ env | jc --env diff --git a/docs/parsers/history.md b/docs/parsers/history.md index 77e3459d..98ad35fd 100644 --- a/docs/parsers/history.md +++ b/docs/parsers/history.md @@ -2,6 +2,8 @@ # jc.parsers.history jc - JSON CLI output utility `history` command output parser +This parser will output a list of dictionaries each containing `line` and `command` keys. If you would like a simple dictionary output, then use the `-r` command-line option or the `raw=True` argument in the `parse()` function. + Usage (cli): $ history | jc --history diff --git a/jc/parsers/env.py b/jc/parsers/env.py index acfde3dc..bcfb176d 100644 --- a/jc/parsers/env.py +++ b/jc/parsers/env.py @@ -1,5 +1,7 @@ """jc - JSON CLI output utility `env` command output parser +This parser will output a list of dictionaries each containing `name` and `value` keys. If you would like a simple dictionary output, then use the `-r` command-line option or the `raw=True` argument in the `parse()` function. + Usage (cli): $ env | jc --env diff --git a/jc/parsers/history.py b/jc/parsers/history.py index bb10b5e5..72a8dcdc 100644 --- a/jc/parsers/history.py +++ b/jc/parsers/history.py @@ -1,5 +1,7 @@ """jc - JSON CLI output utility `history` command output parser +This parser will output a list of dictionaries each containing `line` and `command` keys. If you would like a simple dictionary output, then use the `-r` command-line option or the `raw=True` argument in the `parse()` function. + Usage (cli): $ history | jc --history