python/jc
1
0
Fork 0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-06-17 00:07:37 +02:00
Code Issues Releases Activity

split long and short options

Browse Source
This commit is contained in:
Kelly Brazil
2022-06-05 18:09:44 -07:00
parent 901763fc39
commit 79add35fc1
2 changed files with 30 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -251,21 +251,21 @@ option.
| ` --zipinfo` | `zipinfo` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/zipinfo) |
### Options
| Option | Description |
|-----------------------|--------------------------------------------------------------------------------------------------------------|
| `-a`, `--about` | about `jc`. Prints information about `jc` and the parsers (in JSON or YAML, of course!) |
| `-C`, `--force-color` | force color output even when using pipes (overrides `-m` and the `NO_COLOR` env variable) |
| `-d`, `--debug` | debug mode. Prints trace messages if parsing issues are encountered (use`-dd` for verbose debugging) |
| `-h`, `--help` | help. Use `jc -h --parser_name` for parser documentation |
| `-m`, `--monochrome` | monochrome output |
| `-p`, `--pretty` | pretty format the JSON output |
| `-q`, `--quiet` | quiet mode. Suppresses parser warning messages (use `-qq` to ignore streaming parser errors) |
| `-r`, `--raw` | raw output. Provides more literal output, typically with string values and no additional semantic processing |
| `-u`, `--unbuffer` | unbuffer output |
| `-v`, `--version` | version information |
| `-y`, `--yaml-out` | YAML output |
| `-B`, `--bash-comp` | generate Bash shell completion script |
| `-Z`, `--zsh-comp` | generate Zsh shell completion script |
| Short | Long | Description |
|-------|-----------------|--------------------------------------------------------------------------------------------------------------|
| `-a` | `--about` | about `jc`. Prints information about `jc` and the parsers (in JSON or YAML, of course!) |
| `-C` | `--force-color` | force color output even when using pipes (overrides `-m` and the `NO_COLOR` env variable) |
| `-d` | `--debug` | debug mode. Prints trace messages if parsing issues are encountered (use`-dd` for verbose debugging) |
| `-h` | `--help` | help. Use `jc -h --parser_name` for parser documentation |
| `-m` | `--monochrome` | monochrome output |
| `-p` | `--pretty` | pretty format the JSON output |
| `-q` | `--quiet` | quiet mode. Suppresses parser warning messages (use `-qq` to ignore streaming parser errors) |
| `-r` | `--raw` | raw output. Provides more literal output, typically with string values and no additional semantic processing |
| `-u` | `--unbuffer` | unbuffer output |
| `-v` | `--version` | version information |
| `-y` | `--yaml-out` | YAML output |
| `-B` | `--bash-comp` | generate Bash shell completion script |
| `-Z` | `--zsh-comp` | generate Zsh shell completion script |
### Exit Codes
Any fatal errors within `jc` will generate an exit code of `100`, otherwise the

30
templates/readme_template
View File

@ -149,21 +149,21 @@ option.
| `{{ "{:>15}".format(parser.argument) }}` | {{ "{:<55}".format(parser.description) }} | {{ "{:<70}".format("[📃](https://kellyjonbrazil.github.io/jc/docs/parsers/" + parser.name + ")") }} |{% endfor %}
### Options
| Option | Description |
|-----------------------|--------------------------------------------------------------------------------------------------------------|
| `-a`, `--about` | about `jc`. Prints information about `jc` and the parsers (in JSON or YAML, of course!) |
| `-C`, `--force-color` | force color output even when using pipes (overrides `-m` and the `NO_COLOR` env variable) |
| `-d`, `--debug` | debug mode. Prints trace messages if parsing issues are encountered (use`-dd` for verbose debugging) |
| `-h`, `--help` | help. Use `jc -h --parser_name` for parser documentation |
| `-m`, `--monochrome` | monochrome output |
| `-p`, `--pretty` | pretty format the JSON output |
| `-q`, `--quiet` | quiet mode. Suppresses parser warning messages (use `-qq` to ignore streaming parser errors) |
| `-r`, `--raw` | raw output. Provides more literal output, typically with string values and no additional semantic processing |
| `-u`, `--unbuffer` | unbuffer output |
| `-v`, `--version` | version information |
| `-y`, `--yaml-out` | YAML output |
| `-B`, `--bash-comp` | generate Bash shell completion script |
| `-Z`, `--zsh-comp` | generate Zsh shell completion script |
| Short | Long | Description |
|-------|-----------------|--------------------------------------------------------------------------------------------------------------|
| `-a` | `--about` | about `jc`. Prints information about `jc` and the parsers (in JSON or YAML, of course!) |
| `-C` | `--force-color` | force color output even when using pipes (overrides `-m` and the `NO_COLOR` env variable) |
| `-d` | `--debug` | debug mode. Prints trace messages if parsing issues are encountered (use`-dd` for verbose debugging) |
| `-h` | `--help` | help. Use `jc -h --parser_name` for parser documentation |
| `-m` | `--monochrome` | monochrome output |
| `-p` | `--pretty` | pretty format the JSON output |
| `-q` | `--quiet` | quiet mode. Suppresses parser warning messages (use `-qq` to ignore streaming parser errors) |
| `-r` | `--raw` | raw output. Provides more literal output, typically with string values and no additional semantic processing |
| `-u` | `--unbuffer` | unbuffer output |
| `-v` | `--version` | version information |
| `-y` | `--yaml-out` | YAML output |
| `-B` | `--bash-comp` | generate Bash shell completion script |
| `-Z` | `--zsh-comp` | generate Zsh shell completion script |
### Exit Codes
Any fatal errors within `jc` will generate an exit code of `100`, otherwise the