docs: update CLI options

mrodrig · Jul 8, 2024 · a98653b · a98653b
1 parent e9801d3
commit a98653b
Showing 1 changed file with 36 additions and 20 deletions.
diff --git a/README.md b/README.md
@@ -240,40 +240,56 @@ $ npm install @mrodrig/json-2-csv-cli
 ```
 Usage: json2csv <jsonFile> [options]
 
+Arguments:
+  jsonFile                         JSON file to convert
+
 Options:
   -V, --version                    output the version number
   -o, --output [output]            Path of output file. If not provided, then stdout will be used
-  -f, --field <delimiter>          Optional field delimiter
-  -w, --wrap <delimiter>           Optional wrap delimiter
-  -e, --eol <delimiter>            Optional end of line delimiter
+  -a, --array-indexes-as-keys      Includes array indexes in the generated keys
+  -S, --check-schema               Check for schema differences
+  -f, --field <delimiter>          Field delimiter
+  -w, --wrap <delimiter>           Wrap delimiter
+  -e, --eol <delimiter>            End of Line delimiter
+  -E, --empty-field-value <value>  Empty field value
+  -n, --expand-nested-objects      Expand nested objects to be deep converted to CSV
+  -k, --keys [keys]                Keys of documents to convert to CSV
+  -d, --escape-header-nested-dots  Escape header nested dots
   -b, --excel-bom                  Excel Byte Order Mark character prepended to CSV
+  -x, --exclude-keys [keys]        Comma separated list of keys to exclude
+  -A, --expand-array-objects       Expand array objects
   -W, --without-header             Withhold the prepended header
+  -p, --prevent-csv-injection      Prevent CSV Injection
   -s, --sort-header                Sort the header fields
-  -H, --trim-header                Trim header fields
   -F, --trim-fields                Trim field values
-  -S, --check-schema               Check for schema differences
-  -E, --empty-field-value <value>  Empty field value
-  -A, --expand-array-objects       Expand array objects
-  -k, --keys [keys]                Keys of documents to convert to CSV
-  -h, --help                       output usage information
+  -H, --trim-header                Trim header fields
+  -U, --unwind-arrays              Unwind array values to their own CSV line
+  -I, --iso-date-format            Use ISO 8601 date format
+  -L, --locale-format              Use locale format for values
+  -B, --wrap-booleans              Wrap booleans
+  -h, --help                       display help for command
 ```
 
 #### csv2json
 ```
 Usage: csv2json <csvFile> [options]
 
+Arguments:
+  csvFile                      CSV file to convert
+
 Options:
-  -V, --version            output the version number
-  -c, --csv <csv>          Path of json file to be converted
-  -o, --output [output]    Path of output file. If not provided, then stdout will be used
-  -f, --field <delimiter>  Optional field delimiter
-  -w, --wrap <delimiter>   Optional wrap delimiter
-  -e, --eol <delimiter>    Optional end of line delimiter
-  -b, --excel-bom          Excel Byte Order Mark character prepended to CSV
-  -H, --trim-header        Trim header fields
-  -F, --trim-fields        Trim field values
-  -k, --keys [keys]        Keys of documents to convert to CSV
-  -h, --help               output usage information
+  -V, --version                output the version number
+  -o, --output [output]        Path of output file. If not provided, then stdout will be used
+  -f, --field <delimiter>      Field delimiter
+  -w, --wrap <delimiter>       Wrap delimiter
+  -e, --eol <delimiter>        End of Line delimiter
+  -b, --excel-bom              Excel Byte Order Mark character prepended to CSV
+  -p, --prevent-csv-injection  Prevent CSV Injection
+  -F, --trim-fields            Trim field values
+  -H, --trim-header            Trim header fields
+  -h, --header-fields          Specify the fields names in place a header line in the CSV itself
+  -k, --keys [keys]            Keys of documents to convert to CSV
+  --help                       display help for command
 ```
 
 ## Tests