Skip to content

Commit

Permalink
Cosmetic Change help message.
Browse files Browse the repository at this point in the history
  • Loading branch information
magicdrive committed Nov 3, 2024
1 parent 66ba5f1 commit 11a7020
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 13 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,8 @@ Environment | Description
`KIRKE_DEFAULT_ROOT_NAME` | Specified default used `<root-name>`. | `AutoGenerated`
`KIRKE_DEFAULT_NULL_AS` | Specified default used `<null-type-name>`. | `interface{}`
`KIRKE_DEFAULT_OUTPUT_MODE` | Specified the default used output mode. Only `outline` and `inline` are valid. | `outline`
`KIRKE_DEFAULT_AUTO_PAGER_MODE` | Specified default `<auto-pager>` option. Only `on` and `off` are valid.(default: "on") | `on`
`KIRKE_DEFAULT_POINTER_STRUCT_MODE` | Specified default `<pointer-struct>` option. Only `on` and `off` are valid.(default: "off") | `off`
`KIRKE_DEFAULT_AUTO_PAGER_MODE` | Specified default `<auto-pager>` option. Only `on` and `off` are valid.(default: "on") | `on`

Examples
--------
Expand Down
23 changes: 11 additions & 12 deletions internal/commandline/help.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,24 +14,23 @@ Options:
-j, --json <json-string> Specify the json string
-p, --pipe Receive JSON from a pipe instead of a direct argument above all else. (default: false)
--pointer, --pointer-struct <on|off> Defines struct and array fields as pointers. Only valid for with --outline. (default: off)
--pager --auto-pager <on|off> Use a pager even if the output size is larger than the terminal. (default: "on")
--pager --auto-pager <on|off> Use a pager even if the output size is larger than the terminal. (default: "on")
-o, --outline Specify output mode. Defines struct and array fields as outline struct. (default: true)
-i, --inline Specify output mode. Defines struct and array fields as inline struct. (default: false)

Arguments:
<root-name> Used as the name of the root struct in the output. Automatically converted to camel case.
<json-file> A file containing a JSON string. It will be read even if the extension is not .json.
<json-string> Direct JSON string input.
<null-type-name> The type name used to replace `null` type from json.

<root-name> Used as the name of the root struct in the output. Automatically converted to camel case.
<json-file> A file containing a JSON string. It will be read even if the extension is not .json.
<json-string> Direct JSON string input.
<null-type-name> The type name used to replace `null` type from json.

Environments:
KIRKE_DEFAULT_ROOT_NAME Specified default used <root-name>. (default: AutoGenerated)
KIRKE_DEFAULT_NULL_AS Specified default used <null-type-name>. (default: interface{})
KIRKE_DEFAULT_OUTPUT_MODE Specified the default used output mode. Only `outline` and `inline` are valid. Used if the `--inline` or `--outline` option is not specified.(default: outline)
KIRKE_DEFAULT_AUTO_PAGER_MODE Specified default `<--auto-mode>` switch. (default: "on")
KIRKE_DEFAULT_POINTER_STRUCT_MODE Specified default `<--pointer-struct>` switch. (default: "off")

KIRKE_DEFAULT_ROOT_NAME Specified default used <root-name>. (default: AutoGenerated)
KIRKE_DEFAULT_NULL_AS Specified default used <null-type-name>. (default: interface{})
KIRKE_DEFAULT_OUTPUT_MODE Specified the default used output mode. Only `outline` and `inline` are valid.
Used if the `--inline` or `--outline` option is not specified.(default: outline)
KIRKE_DEFAULT_POINTER_STRUCT_MODE Specified default `<--pointer-struct>` switch. (default: "off")
KIRKE_DEFAULT_AUTO_PAGER_MODE Specified default `<--auto-mode>` switch. (default: "on")

Examples:
ex1)
Expand Down

0 comments on commit 11a7020

Please sign in to comment.