DOKK / manpages / debian 13 / yq / tomlq.1.en
TOMLQ(1) User Commands TOMLQ(1)

tomlq - Command-line TOML processor - jq wrapper for TOML documents

jq [options] <jq filter> [file...]

usage: tomlq [options] <jq filter> [input file...]

tomlq: Command-line TOML processor - jq wrapper for TOML documents

tomlq transcodes TOML documents to JSON and passes them to jq. See https://github.com/kislyuk/tomlq for more information.

jq_filter files

show this help message and exit
Transcode jq JSON output back into TOML and emit it
Edit files in place (no backup - use caution)
show program's version number and exit

jq - commandline JSON processor [version 1.7]

jq [options] --args <jq filter> [strings...] jq [options] --jsonargs <jq filter> [JSON_TEXTS...]

jq is a tool for processing JSON inputs, applying the given filter to 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. 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
}

use `null` as the single input value;
read each line as string instead of JSON;
read all inputs into an array and use it as the single input value;
compact instead of pretty-printed output;
output strings without escapes and quotes;
implies -r and output NUL after each output;
implies -r and output without newline after each output;
output strings by only ASCII characters using escape sequences;
sort keys of each object on output;
colorize JSON output;
disable colored output;
use tabs for indentation;
use n spaces for indentation (max 7 spaces);
flush output stream after each output;
parse the input value in streaming fashion;
implies --stream and report parse error as an array;
parse input/output as application/json-seq;
load filter from the file;
search modules from the directory;
set $name to the string value;
set $name to the JSON value;
from the file;
set $name to string contents of file;
consume remaining arguments as positional string values;
consume remaining arguments as positional JSON values;
set exit status code based on the output;
show the version;
show jq's build configuration;
show the help;
--
terminates argument processing;

Named arguments are also available as $ARGS.named[], while positional arguments are available as $ARGS.positional[].

The full documentation for tomlq is maintained as a Texinfo manual. If the info and tomlq programs are properly installed at your site, the command

info tomlq

should give you access to the complete manual.

May 2025 tomlq 3.4.3