diff options
Diffstat (limited to 'docs/cli-doc-tomlq.txt')
| -rw-r--r-- | docs/cli-doc-tomlq.txt | 69 |
1 files changed, 42 insertions, 27 deletions
diff --git a/docs/cli-doc-tomlq.txt b/docs/cli-doc-tomlq.txt index 7c29e19..8fdd48f 100644 --- a/docs/cli-doc-tomlq.txt +++ b/docs/cli-doc-tomlq.txt @@ -15,7 +15,7 @@ options: --in-place, -i Edit files in place (no backup - use caution) --version show program's version number and exit -jq - commandline JSON processor [version 1.6] +jq - commandline JSON processor [version 1.7] Usage: jq [options] <jq filter> [file...] jq [options] --args <jq filter> [strings...] @@ -26,39 +26,54 @@ its JSON text inputs and producing the filter's results as JSON on standard output. The simplest filter is ., which copies jq's input to its output -unmodified (except for formatting, but note that IEEE754 is used -for number representation internally, with all that that implies). - -For more advanced filters see the jq(1) manpage ("man jq") -and/or https://stedolan.github.io/jq +unmodified except for formatting. For more advanced filters see +the jq(1) manpage ("man jq") and/or https://jqlang.github.io/jq/. Example: $ echo '{"foo": 0}' | jq . { - "foo": 0 + "foo": 0 } -Some of the options include: - -c compact instead of pretty-printed output; - -n use `null` as the single input value; - -e set the exit status code based on the output; - -s read (slurp) all inputs into an array; apply filter to it; - -r output raw strings, not JSON texts; - -R read raw strings, not JSON texts; - -C colorize JSON; - -M monochrome (don't colorize JSON); - -S sort keys of objects on output; - --tab use tabs for indentation; - --arg a v set variable $a to value <v>; - --argjson a v set variable $a to JSON value <v>; - --slurpfile a f set variable $a to an array of JSON texts read from <f>; - --rawfile a f set variable $a to a string consisting of the contents of <f>; - --args remaining arguments are string arguments, not files; - --jsonargs remaining arguments are JSON arguments, not files; - -- terminates argument processing; +Command options: + -n, --null-input use `null` as the single input value; + -R, --raw-input read each line as string instead of JSON; + -s, --slurp read all inputs into an array and use it as + the single input value; + -c, --compact-output compact instead of pretty-printed output; + -r, --raw-output output strings without escapes and quotes; + --raw-output0 implies -r and output NUL after each output; + -j, --join-output implies -r and output without newline after + each output; + -a, --ascii-output output strings by only ASCII characters + using escape sequences; + -S, --sort-keys sort keys of each object on output; + -C, --color-output colorize JSON output; + -M, --monochrome-output disable colored output; + --tab use tabs for indentation; + --indent n use n spaces for indentation (max 7 spaces); + --unbuffered flush output stream after each output; + --stream parse the input value in streaming fashion; + --stream-errors implies --stream and report parse error as + an array; + --seq parse input/output as application/json-seq; + -f, --from-file file load filter from the file; + -L directory search modules from the directory; + --arg name value set $name to the string value; + --argjson name value set $name to the JSON value; + --slurpfile name file set $name to an array of JSON values read + from the file; + --rawfile name file set $name to string contents of file; + --args consume remaining arguments as positional + string values; + --jsonargs consume remaining arguments as positional + JSON values; + -e, --exit-status set exit status code based on the output; + -V, --version show the version; + --build-configuration show jq's build configuration; + -h, --help show the help; + -- terminates argument processing; Named arguments are also available as $ARGS.named[], while positional arguments are available as $ARGS.positional[]. - -See the manpage for more options. |