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

fix hyphens

Browse Source
This commit is contained in:
Kelly Brazil
2022-06-05 18:06:38 -07:00
parent 1034cb1ea2
commit 901763fc39
2 changed files with 26 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -253,19 +253,19 @@ option.
### Options ### Options
| Option | Description | | Option | Description |
|-----------------------|--------------------------------------------------------------------------------------------------------------| |-----------------------|--------------------------------------------------------------------------------------------------------------|
| `‑a`, `‑‑about` | about `jc`. Prints information about `jc` and the parsers (in JSON or YAML, of course!) | | `-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) | | `-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) | | `-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 | | `-h`, `--help` | help. Use `jc -h --parser_name` for parser documentation |
| `‑m`, `‑‑monochrome` | monochrome output | | `-m`, `--monochrome` | monochrome output |
| `‑p`, `‑‑pretty` | pretty format the JSON output | | `-p`, `--pretty` | pretty format the JSON output |
| `‑q`, `‑‑quiet` | quiet mode. Suppresses parser warning messages (use `‑qq` to ignore streaming parser errors) | | `-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 | | `-r`, `--raw` | raw output. Provides more literal output, typically with string values and no additional semantic processing |
| `‑u`, `‑‑unbuffer` | unbuffer output | | `-u`, `--unbuffer` | unbuffer output |
| `‑v`, `‑‑version` | version information | | `-v`, `--version` | version information |
| `‑y`, `‑‑yaml‑out` | YAML output | | `-y`, `--yaml-out` | YAML output |
| `‑B`, `‑‑bash‑comp` | generate Bash shell completion script | | `-B`, `--bash-comp` | generate Bash shell completion script |
| `‑Z`, `‑‑zsh‑comp` | generate Zsh shell completion script | | `-Z`, `--zsh-comp` | generate Zsh shell completion script |
### Exit Codes ### Exit Codes
Any fatal errors within `jc` will generate an exit code of `100`, otherwise the Any fatal errors within `jc` will generate an exit code of `100`, otherwise the

26
templates/readme_template
View File

@ -151,19 +151,19 @@ option.
### Options ### Options
| Option | Description | | Option | Description |
|-----------------------|--------------------------------------------------------------------------------------------------------------| |-----------------------|--------------------------------------------------------------------------------------------------------------|
| `‑a`, `‑‑about` | about `jc`. Prints information about `jc` and the parsers (in JSON or YAML, of course!) | | `-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) | | `-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) | | `-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 | | `-h`, `--help` | help. Use `jc -h --parser_name` for parser documentation |
| `‑m`, `‑‑monochrome` | monochrome output | | `-m`, `--monochrome` | monochrome output |
| `‑p`, `‑‑pretty` | pretty format the JSON output | | `-p`, `--pretty` | pretty format the JSON output |
| `‑q`, `‑‑quiet` | quiet mode. Suppresses parser warning messages (use `‑qq` to ignore streaming parser errors) | | `-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 | | `-r`, `--raw` | raw output. Provides more literal output, typically with string values and no additional semantic processing |
| `‑u`, `‑‑unbuffer` | unbuffer output | | `-u`, `--unbuffer` | unbuffer output |
| `‑v`, `‑‑version` | version information | | `-v`, `--version` | version information |
| `‑y`, `‑‑yaml‑out` | YAML output | | `-y`, `--yaml-out` | YAML output |
| `‑B`, `‑‑bash‑comp` | generate Bash shell completion script | | `-B`, `--bash-comp` | generate Bash shell completion script |
| `‑Z`, `‑‑zsh‑comp` | generate Zsh shell completion script | | `-Z`, `--zsh-comp` | generate Zsh shell completion script |
### Exit Codes ### Exit Codes
Any fatal errors within `jc` will generate an exit code of `100`, otherwise the Any fatal errors within `jc` will generate an exit code of `100`, otherwise the