37 KiB
Basic usage
fq tries to behave the same way as jq as much as possible, so you can do:
fq . file
fq < file
cat file | fq
fq . < file
fq . *.png *.mp3
fq '.frames[0]' *.mp3
fq '.frames[-1] | tobytes' file.mp3 > last_frame
Common usages
# recursively display decode tree but truncate long arrays
fq d file
# same as
fq display file
# display all bytes for each value
fq dd file
# same as
fq 'd({display_bytes: 0})' file
# display 200 bytes for each value
fq 'd({display_bytes: 200})' file
# recursively display decode tree without truncating
fq da file
# same as
fq 'd({array_truncate: 0})' file
# display a specific decode tree one level
fq '.path[1].to.value' file
# display a specific decode tree all levels
fq '.path[1].to.value | d' file
fq '.path[1].to.value | dd' file
fq '.path[1].to.value | da' file
# recursively and verbosely display decode tree
fq dv file
# same as
fq 'd({verbose: true})' file
# JSON representation for whole file
fq tovalue file
# or use -V (--value-output) that does tovalue automatically
fq -V . file
# or -Vr if the value is a string and you want a "raw" string
fq -Vr .path.to.string file
# JSON but raw bit fields truncated
fq -o bits_format=truncate tovalue file
# JSON but raw bit fields as md5 hex string
fq -o bits_format=md5 tovalue file
# look up a path
fq '.some[1].path' file
# look up a path and output JSON
fq -V '.some[1].path' file
# can be a query that outputs multiple values
# this outputs first and last value in .same array and .path, three values in total
fq -V '.some[0,-1], .path' file
# grep whole tree by value
fq 'grep("^prefix")' file
fq 'grep(123)' file
# grep whole tree by condition
fq 'grep_by(. >= 100 and . =< 100)' file
# recursively look for values fulfilling some condition
fq '.. | select(.type=="trak")?' file
fq 'grep_by(.type=="trak")' file
# grep_by(f) is alias for .. | select(f)?, that is: recurse, select and ignore errors
# recursively look for decode value roots for a format
fq '.. | select(format=="jpeg")' file
# can also use grep_by
fq 'grep_by(format=="jpeg")' file
# recursively look for first decode value root for a format
fq 'first(.. | select(format=="jpeg"))' file
fq 'first(grep_by(format=="jpeg"))' file
# decode file as mp4 and return a result even if there are some errors
fq -d mp4 file.mp4
# decode file as mp4 and also ignore validity assertions
fq -o force=true -d mp4 file.mp4
CLI arguments
Most of jq's CLI arguments work with fq. But here are some additional ones specific to fq:
Decode format --decode
, -d NAME
Force format to decode instead of probing.
NAME
is a name of a format, ex -d mp4
, see -h formats
for list of formats.
Interactive REPL --repl
,-i
Start interactive REPL.
Can be used with no input, one and multiple inputs, for example just fq -i
starts a REPL with null
input, fq -i 123
with the number 123 as input, fq -i . a b
with two files as input. This also works with --slurp
. In the REPL it is also possible to start a sub-REPLs by ending a query with <query> | repl
, use ctrl-D to exit the sub-REPL. The sub-REPL will evaluate separately on each output from the query it was started. Use [<query>] | repl
if you want to "slurp" into an array.
Set option --options
,-o KEY=VALUE|@PATH
KEY
is name of option
VALUE
will be interpreted as a JSON value if possible otherwise a string, ex -o name=abc
and -o name='"abc"'
is the same.
@PATH
will read string from file at PATH
.
Specify a global option or a format option, ex: -o decode_samples=false
would for some container decoders like mp4
and matroska
disable decoding of samples.
Value output --value-output
, -V
Output JSON value instead of decode tree. Use -Vr
if you want raw string (no quotes).
Display output
display
or d
is the main function for displaying values and is also the function that will be used if no other output function is explicitly used. If its input is a decode value it will output a dump and tree structure or otherwise it will output as JSON.
Below demonstrates some usages:
First and second example does the same thing, inputs "hello"
to display
.
In the next few examples we select out the first "edit list" box in an mp4 file, it's a list of which part of the media track to be included during playback, and displays it in various ways.
Default if not explicitly used display
will only show the root level:
First row shows a ruler with byte offset into the line and jq path for the value.
The columns are:
- Start address for the line. For example we see that
type
starts at0xd60
+0x09
. - Hex representation of input bits for value. Will show the whole byte even if the value only partially uses bits from it.
- ASCII representation of input bits for value. Will show the whole byte even if the value only partially uses bits from it.
- Tree structure of decoded value, symbolic value and description.
Notation:
{}
value is an object that might have nested values.[start:end]
value is an array with index starting atstart
and ending atend
(exclusive).
With display
or d
it will recursively show the whole tree:
Same but verbose dv
:
In verbose mode bit ranges and array element names as shown.
Bit range uses bytes.bits
notation. For example type
starts at byte 0xd69
bit 0
(left out if zero) and ends at 0xd6c
bit 7
(inclusive) and have byte size of 4
.
There are also some other display
aliases:
da
same asdisplay({array_truncate: 0})
which will not truncate long arrays.dd
same asdisplay({array_truncate: 0, display_bytes: 0})
which will not truncate long ranges.dv
same asdisplay({array_truncate: 0, verbose: true})
ddv
same asdisplay({array_truncate: 0, display_bytes: 0 verbose: true})
which will not truncate long and also display verbosely.
Interactive REPL
The interactive REPL has auto completion and nested REPL support:
# start REPL with null input
$ fq -i
null>
# same as
$ fq -ni
null>
# in the REPL you will see a prompt indicating current input and you can type jq expression to evaluate.
# start REPL with one file as input
$ fq -i . doc/file.mp3
mp3>
$ fq -i . doc/file.mp3
# basic arithmetic and jq expressions
mp3> 1+1
2
mp3> 1, 2, 3 | . * 2
2
4
6
mp3> [1, 2, 3] | add
6
# "." is the identity function which just returns current input, the mp3 file.
mp3> .
# access the first frame in the mp3 file
mp3> .frames[0]
# start a new nested REPL with first frame as input
mp3> .frames[0] | repl
# prompt shows "path" to current input and that it's an mp3_frame.
# Ctrl-D to exit REPL or to shell if last REPL
> .frames[0] mp3_frame> ^D
# "jq" value of layer in first frame
mp3> .frames[0].header.layer | tovalue
3
mp3> .frames[0].header.layer * 2
6
# symbolic value, same as "jq" value
mp3> .frames[0].header.layer | tosym
3
# actual underlying decoded value
mp3> .frames[0].header.layer | toactual
1
# description of value
mp3> .frames[0].header.layer | todescription
"MPEG Layer 3"
mp3> ^D
$
Use Ctrl-D to exit and Ctrl-C to interrupt current evaluation.
Example usages
Second mp3 frame header as JSON
fq '.frames[1].header | tovalue' file.mp3
Byte start position for the first 10 mp3 frames in an array
fq '.frames[0:10] | map(tobytesrange.start)' file.mp3
Decode at range
# decode byte range 100 to end as mp3_frame
fq -d bytes '.[100:] | mp3_frame | d' file.mp3
# decode byte range 10 bytes from .somefield and preserve relative position in file
fq '.somefield | tobytesrange[10:] | mp3_frame | d' file.mp3
Show AVC SPS difference between two mp4 files
-n
tells fq to not have an implicit input
, f
is a function to select out some interesting value, call diff
with two arguments,
decoded value for a.mp4
and b.mp4
filtered thru f
.
fq -n 'def f: .. | select(format=="avc_sps"); diff(input|f; input|f)' a.mp4 b.mp4
Extract first JPEG found in file
Recursively look for the first value that is a jpeg
decode value root. Use tobytes
to get bytes for value. Redirect bytes to a file.
fq 'first(.. | select(format=="jpeg")) | tobytes' file > file.jpeg
Sample size histogram
Recursively look for a all sample size boxes "stsz" and use ?
to ignore errors when doing .type
on arrays etc. Save reference to box, count unique values, save the max, output the path to the box and output a histogram scaled to 0-100.
fq '.. | select(.type=="stsz")? as $stsz | .entries | count | max_by(.[1])[1] as $m | ($stsz | topath | path_to_expr), (.[] | "\(.[0]): \((100*.[1]/$m)*"=") \(.[1])") | println' file.mp4
Find TCP streams that looks like HTTP GET requests in a PCAP file
Use grep
to recursively find strings matching a regexp.
fq '.tcp_connections | grep("GET /.* HTTP/1.?")' file.pcap
Use representation of a format
Some formats like msgpack
, bson
etc are used to represent some data structure. In those cases the torepr
function can be used to get the representation.
# whole represented value
fq -d msgpack torepr file.msgpack
# value of the key "field" from the represented value
fq -d msgpack `torepr.field` file.msgpack
# query or transform represented value
fq -d msgpack 'torepr | ...' file.msgpack
Widest PNG in a directory
$ fq -rn '[inputs | [input_filename, first(.chunks[] | select(.type=="IHDR") | .width)]] | max_by(.[1]) | .[0]' *.png
What values include the byte at position 0x123
$ fq '.. | select(scalars and in_bytes_range(0x123))' file
Support formats
See formats
The jq language
fq is based on the jq language and for basic usage its syntax
is similar to how object and array access looks in JavaScript or JSON path, .food[10]
etc. but
it can do much more and is a very expressive language.
To get the most out of fq it's recommended to learn more about jq, here are some good starting points:
- jq manual
- Peter Koppstein's A Stream oriented Introduction to jq
- jq wiki: Language Description
- jq wiki: page Cookbook
- jq wiki: Pitfalls
- FAQ
For a more convenient jq experience these might be interesting:
Common beginner gotchas are:
- jq's use of
;
and,
. jq uses;
as argument separator and,
as output separator. To call a functionf
with two arguments usef(1; 2)
. If you dof(1, 2)
you pass a single argument1, 2
(a lambda expression that outputs1
and then outputs2
) tof
. - Expressions can return or "output" zero or more values. This is how loops, foreach etc is achieved.
- Expressions have one implicit input and output value. This how pipelines like
1 | . * 2
work.
Types specific to fq
fq has two additional types compared to jq, decode value and binary. In standard jq expressions they will in most cases behave as some standard jq type.
Decode value
This type is returned by decoders and it is used to represent parts of the decoded input. It can act as all standard jq types, object, array, number, string etc.
Each decode value has these properties:
- A bit range in the input
- Can be accessed as a binary using
tobits
/tobytes
. Use thestart
andsize
keys to access position and size. .name
as bytes.name | tobytes
- Bit 4-8 of
.name
as bits.name | tobits[4:8]
- Can be accessed as a binary using
Each non-compound decode value has these properties:
- An actual value:
- This is the decoded representation of the bits, a number, string, bool etc.
- Can be accessed using
toactual
.
- An optional symbolic value:
- Is usually a mapping of the actual to symbolic value, ex: map number to a string value.
- Can be accessed using
tosym
.
- An optional description:
- Can be accessed using
todescription
- Can be accessed using
parent
is the parent decode valueparents
is the all parent decode valuestopath
is the jq path for the decode valuetorepr
convert decode value to its representation if possible
The value of a decode value is the symbolic value if available and otherwise the actual value. To explicitly access the value use tovalue
. In most expressions this is not needed as it will be done automatically.
Binary
Binaries are raw bits with a unit size, 1 (bits) or 8 (bytes), that can have a non-byte aligned size. Will act as byte padded strings in standard jq expressions.
Use tobits
and tobytes
to create them from decode values, strings, numbers or binary arrays. tobytes
will, if needed zero pad most significant bits to be byte aligned.
There is also tobitsrange
and tobytesrange
which does the same thing but will preserve its source range when displayed.
"string" | tobytes
produces a binary with UTF8 codepoint bytes.1234 | tobits
produces a binary with the unsigned big-endian integer 1234 with enough bits to represent the number. Usetobytes
to get the same but with enough bytes to represent the number. This is different to how numbers work inside binary arrays where they are limited to 0-255.["abc", 123, ...] | tobytes
produce a binary from a binary array. See binary array below..[index]
access bit or byte at indexindex
. Index is in units.[0x12, 0x34, 0x56] | tobytes[1]
is0x35
[0x12, 0x34, 0x56] | tobits[3]
is1
.[start:]
,.[start:end]
or.[:end]
is normal jq slice syntax and will slice the binary fromstart
toend
.start
andend
is in units.[0x12, 0x34, 0x56] | tobytes[1:2]
will be a binary with the byte0x34
[0x12, 0x34, 0x56] | tobits[4:12]
will be a binary with the byte0x23
[0x12, 0x34, 0x56] | tobits[4:20]
will be a binary with the byte0x23
,0x45
[0x12, 0x34, 0x56] | tobits[4:20] | tobytes[1:]
will be a binary with the byte0x45
,
Both .[index]
and .[start:end]
support negative indices to index from end.
TODO: tobytesrange, padding
Binary array
Is an array of numbers, strings, binaries or other nested binary arrays. When used as input to tobits
/tobytes
the following rules are used:
- Number is a byte with value be 0-255
- String it's UTF8 codepoint bytes
- Binary as is
- Binary array used recursively
Binary arrays are similar to and inspired by Erlang iolist.
Some examples:
[0, 123, 255] | tobytes
will be binary with 3 bytes 0, 123 and 255
[0, [123, 255]] | tobytes
same as above
[0, 1, 1, 0, 0, 1, 1, 0 | tobits]
will be binary with 1 byte, 0x66 an "f"
[(.a | tobytes[-10:]), 255, (.b | tobits[:10])] | tobytes
the concatenation of the last 10 bytes of .a
, a byte with value 255 and the first 10 bits of .b
.
The difference between tobits
and tobytes
is
TODO: padding and alignment
Functions
All decode functions are available in two forms, just <format>
(like mp3
) that returns a decode value on error and from_<format>
which throws error on decode error.
Note that jq sometimes uses the notation name/0
, name/1
etc in error messages and documentation which means <function-name>/<arity>
. Same function names with different arity are treated as separate functions, but are usually related in some way in practice.
Function added in fq
- All standard library functions from jq
- Adds a few new general functions:
print
,println
,printerr
,printerrln
prints to stdout and stderr.group
group values, same asgroup_by(.)
.streaks
,streaks_by(f)
likegroup
but groups streaks based on condition.count
,count_by(f)
likegroup
but counts groups lengths.debug(f)
likedebug
but uses arg to produce a debug message.{a: 123} | debug({a}) | ...
.path_to_expr
from["key", 1]
to".key[1]"
.expr_to_path
from".key[1]"
to["key", 1]
.diff($a; $b)
produce diff object between two values.delta
,delta_by(f)
, array with difference between all consecutive pairs.chunk(f)
, split array or string into even chunks
- Bitwise functions
band
,bor
,bxor
,bsl
,bsr
andbnot
. Works the same as jq math functions, unary uses input and if more than one argument all as arguments ignoring the input. Ex:1 | bnot
bsl(1; 3)
- Adds some decode value specific functions:
root
tree root for valuebuffer_root
root value of buffer for valueformat_root
root value of format for valueparent
parent valueparents
output parents of valuetopath
path of value. Usepath_to_expr
to get a string representation.tovalue
,tovalue($opts)
symbolic value if available otherwise actual valuetoactual
,toactual($opts)
actual value (usually the decoded value)tosym
,tosym($opts)
symbolic value (mapped etc)todescription
description of valuetorepr
converts decode value into what it represents. For example convert msgpack decode value into a value representing its JSON representation.- All regexp functions work with binary as input and pattern argument with these differences
compared to when using string input:
- All offset and length will be in bytes.
- For
capture
the.string
value is a binary. - If pattern is a binary it will be matched literally and not as a regexp.
- If pattern is a binary or flags include "b" each input byte will be read as separate code points
- String functions are not overloaded to support binary for now as some of them might have behaviors that might be confusing.
explode
is overloaded to work with binary. Will explode into array of the unit of the binary. end of binary. instead of possibly multi-byte UTF-8 codepoints. This allows to match raw bytes. Ex:match("\u00ff"; "b")
will match the byte0xff
and not the UTF-8 encoded codepoint for 255,match("[^\u00ff]"; "b")
will match all non-0xff
bytes.grep
functions take 1 or 2 arguments. First is a scalar to match, where a string is treated as a regexp. A binary will match exact bytes. Second argument are regexp flags with addition that "b" will treat each byte in the input binary as a code point, this makes it possible to match exact bytes.grep($v)
,grep($v; $flags)
recursively match value and binaryvgrep($v)
,vgrep($v; $flags)
recursively match valuebgrep($v)
,bgrep($v; $flags)
recursively match binaryfgrep($v)
,fgrep($v; $flags)
recursively match field name
grep_by(f)
recursively match using a filter. Ex:grep_by(. > 180 and . < 200)
,first(grep_by(format == "id3v2"))
.- Binary:
tobits
- Transform input to binary with bit as unit, does not preserve source range, will start at zero.tobitsrange
- Transform input to binary with bit as unit, preserves source range if possible.tobytes
- Transform input to binary with byte as unit, does not preserve source range, will start at zero.tobytesrange
- Transform input binary with byte as unit, preserves source range if possible..[start:end]
,.[:end]
,.[start:]
- Slice binary from start to end preserve source range.
open
open file for reading- All decode functions take an optional option argument. The only option currently is
force
to ignore decoder asserts. For example to decode as mp3 and ignore assets domp3({force: true})
ordecode("mp3"; {force: true})
, from command line you currently have to dofq -d bytes 'mp3({force: true})' file
. decode
,decode("<format>")
,decode("<format>"; $opts)
decode formatprobe
,probe($opts)
probe and decode formatmp3
,mp3($opts)
, ...,<format>
,<format>($opts)
same asdecode("<format>")
,decode("<format>"; $opts)
decode as format and return decode value even on decode error.from_mp3
,from_mp3($opts)
, ...,from_<format>
,from_<format>($opts)
same asdecode("<format>")
,decode("<format>"; $opts)
decode as format but throw error on decode error.- Display shows hexdump/ASCII/tree for decode values and jq value for other types.
d
/d($opts)
display value and truncate long arrays and binariesda
/da($opts)
display value and don't truncate arraysdd
/dd($opts)
display value and don't truncate arrays or binariesdv
/dv($opts)
verbosely display value and don't truncate arrays but truncate binariesddv
/ddv($opts)
verbosely display value and don't truncate arrays or binaries
hd
/hexdump
hexdump valuerepl
/repl($opts)
nested REPL, must be last in a pipeline.1 | repl
, can "slurp" outputs. Ex:1, 2, 3 | repl
,[1,2,3] | repl({compact: true})
.slurp("<name>")
slurp outputs and save them to$name
, must be last in the pipeline. Will be available as a global array$name
. Ex1,2,3 | slurp("a")
,$a[]
same asspew("a")
.spew
/spew("<name>")
output previously slurped values.spew
outputs all slurps as an object,spew("<name>")
outputs one slurp. Ex:spew("a")
.paste
read string from stdin until ^D. Useful for pasting text.- Ex:
paste | from_pem | asn1_ber | repl
read from stdin then decode and start a new sub-REPL with result.
- Ex:
Naming inconsistencies
jq's naming conversion is a bit inconsistent, some standard library functions are named tojson
while others from_entries
. fq follows this tradition a bit by but tries to use snake_case unless there is a good reason.
Here are all the non-snake_case functions added by. Most of them deal with decode and binary values which are new "primitive" types:
toactual
tobits
tobitsrange
tobytes
tobytesrange
todescription
topath
torepr
tosym
tovalue
Encodings, serializations and hashes
In addition to binary formats fq also support reading to and from encodings and serialization formats.
At the moment fq does not have any dedicated argument for serialization formats but raw string input -R
slurp -s
and raw string output -r
can make things easier. The combination -Rs
will read all inputs into one string (same as jq).
Note that from*
functions output jq values and to*
takes jq values as input so in some cases not all information will be properly preserved. For example, for the element and attribute order might change and text and comment nodes might move or be merged. yq might be a better tool if that is needed.
Some example usages:
# read yml (format is probed, use -d yaml to force) and do some query
$ fq '...' file.yml
# convert YAML to JSON
# note -r for raw string output, without a JSON string with JSON would outputted
$ fq -r 'tojson({indent:2})' file.yml
# add token to URL
$ echo -n "https://host.org" | fq -Rsr 'from_url | .user.username="token" | tourl'
https://token@host.org
# top 3 hosts in src or href attributes:
# -d to decode as html, can't be probed as html5 parsers always produce some parse tree
# [...] to start collect values into an array
# .. | ."@src"?, ."@href"? | values, recurse and try (?) to get src and href attributes and filter out nulls
# from_url.host | values, parse as url and filter out those without a host
# count to count unique values, returns [[key, count], ...]
# reverse sort by count and pick first 3
# map [key, count] tuples into {key: key, values: count}
# from_entries, convert into object
$ curl -s https://www.discogs.com/ | fq -d html '[.. | ."@src"?, ."@href"? | values | from_url.host | values] | count | sort_by(-.[1])[0:3] | map({key: .[0], value: .[1]}) | from_entries'
{
"blog.discogs.com": 9,
"st.discogs.com": 10,
"www.discogs.com": 14
}
# shows how serialization functions can be used on any string, how to transform values and output some other format
# read and decode zip file and start an interactive REPL
$ fq -i . <(curl -sL https://github.com/stefangabos/world_countries/archive/master.zip)
# select from interesting xml file
zip> .local_files[] | select(.file_name == "world_countries-master/data/countries/en/world.xml").uncompressed | repl
# convert xml into jq value
> .local_files[95].uncompressed string> from_xml | repl
# sort countries by and select the first one
>> object> .countries.country | sort_by(."@name") | first | repl
# see what current input is
>>> object> .
{
"@alpha2": "af",
"@alpha3": "afg",
"@id": "4",
"@name": "Afghanistan"
}
# remove "@" prefix from keys and convert to YAML and print it
>>> object> with_entries(.key |= .[1:]) | to_yaml | print
alpha2: af
alpha3: afg
id: "4"
name: Afghanistan
# exit all REPLs back to shell
>>> object> ^D
>> object> ^D
> .local_files[95].uncompressed string> ^D
zip> ^D
-
from_xml
/from_xml($opts)
Parse XML into jq value.
{seq: true}
preserve element ordering if more than one sibling.
{array: true}
use nested[name, attributes, children]
arrays to represent elements. Attributes will benull
if none and children will be[]
if none, this is to make it easier to work with as the array as 3 values.to_xml
does not require this. -
from_html
/from_html($opts)
Parse HTML into jq value.
Similar tofrom_xml
but parses html5 in non-script mode. Will always have ahtml
root withhead
andbody
elements.
{array: true}
use nested arrays to represent elements.
{seq: true}
preserve element ordering if more than one sibling. -
to_xml
/to_xml($opts})
Serialize jq value into XML.
{indent: number}
indent child elements.
Assumes object representation if input is an object, and nested arrays if input is an array.
Will automatically add a rootdoc
element if jq value has more then one root element.
If a#seq
is found on at least one element all siblings will be sort by sequence number. Attributes are always sorted.XML elements can be represented as jq value in two ways, as objects (inspired by mxj and xml.com's Converting Between XML and JSON ) or nested arrays. Both representations are lossy and might lose ordering of elements, text nodes and comments. In object representation
from_xml
,from_html
andto_xml
support{seq:true}
option to parse/serialize{"#seq"=<number>}
attributes to preserve element sibling ordering.The object version is denser and convenient to query, the nested arrays version is probably easier to use when generating XML.
Let's assume
$xml
is this XML document as a string:<doc> <child attr="1"></child> <child attr="2">text</child> <other>text</other> </doc>
With object representation an element is represented as:
- Attributes as
@
prefixed@<key>
keys. - Text nodes as
#text
. - Comment nodes as
#comment
keys. - For explicit sibling ordering
#seq
keys with a number, can be negative, assumed zero if missing. - Child element with only text as
<name>
key with text as value. - Child element with more than just text as
<name>
key with value an object. - Multiple child element siblings with same name as
name
key with value as array with strings and objects.
> $xml | from_xml { "doc": { "child": [ { "@attr": "1" }, { "#text": "text", "@attr": "2" } ], "other": "text" } }
With nested array representation, an array with these values
["<name>", {attributes...}, [children...]]
- Index 0 is an element name.
- Index 1 object attributes (including
#text
and#comment
keys). - Index 2 array of child elements.
> $xml | from_xml({array: true}) [ "doc", [ [ "child", { "attr": "1" } ], [ "child", { "#text": "text", "attr": "2" } ], [ "other", { "#text": "text" } ] ] ]
Parse and include
#seq
attributes if needed:> $xml | from_xml({seq:true}) { "doc": { "child": [ { "#seq": 0, "@attr": "1" }, { "#seq": 1, "#text": "text", "@attr": "2" } ], "other": { "#seq": 2, "#text": "text" } } }
Select values in
<doc>
, remove<child>
, add a<new>
element, serialize to xml with 2 space indent and print the string> $xml | from_xml.doc | del(.child) | .new = "abc" | {root: .} | to_xml({indent: 2}) | println <root> <new>abc</new> <other>text</other> </root>
- Attributes as
JSON and jq-flavoured JSON
fromjson
Parse JSON into jq value.tojson
/tojson($opt)
Serialize jq value into JSON.
{indent: number}
indent array/object values.from_jq
Parse jq-flavoured JSON into jq value.to_jq
/to_jq($opt)
Serialize jq value into jq-flavoured JSON
{indent: number}
indent array/object values.
jq-flavoured JSON has optional key quotes,#
comments and can have trailing comma in arrays.from_jsonl
Parse JSON lines into jq array.to_jsonl
Serialize jq array into JSONL.
Note that fromjson
and tojson
use different naming conventions as they originate from jq's standard library.
YAML
from_yaml
Parse YAML into jq value.to_yaml
Serialize jq value into YAML.
TOML
from_toml
Parse TOML into jq value.to_toml
Serialize jq value into TOML.
CSV
from_csv
/from_cvs($opts)
Parse CSV into jq value.
{comma: string}
field separator, default ",".
{comment: string}
comment line character, default "#".
To work with tab separated values you can usefromcvs({comma: "\t"})
orfq -d csv -o 'comma="\t"'
to_csv
/to_csv($opts)
Serialize jq value into CSV.
{comma: string}
field separator, default ",".
XML encoding
from_xmlentities
Decode XML entities.to_xmlentities
Encode XML entities.
URL parts and XML encodings
from_urlpath
Decode URL path component.to_urlpath
Encode URL path component. Whitespace as %20.from_urlencode
Decode URL query encoding.to_urlencode
Encode URL to query encoding. Whitespace as "+".from_urlquery
Decode URL query into object. For duplicates keys value will be an array.to_urlquery
Encode object into query string.from_url
Decode URL into object.> "schema://user:pass@host/path?key=value#fragment" | from_url { "fragment": "fragment", "host": "host", "path": "/path", "query": { "key": "value" }, "rawquery": "key=value", "scheme": "schema", "user": { "password": "pass", "username": "user" } }
to_url
Encode object into URL string.
Binary encodings like hex and base64
from_hex
Decode hex string to binary.to_hex
Encode binary into hex string.from_base64
/from_base64($opts)
Decode base64 encodings into binary.
{encoding:string}
encoding variant:std
(default),url
,rawstd
orrawurl
to_base64
/to_base64($opts)
Encode binary into base64 encodings.
{encoding:string}
encoding variant:std
(default),url
,rawstd
orrawurl
Hash functions
to_md4
Hash binary using md4.to_md5
Hash binary using md5.to_sha1
Hash binary using sha1.to_sha256
Hash binary using sha256.to_sha512
Hash binary using sha512.to_sha3_224
Hash binary using sha3 224.to_sha3_256
Hash binary using sha3 256.to_sha3_384
Hash binary using sha3 384.to_sha3_512
Hash binary using sha3 512.
Text encodings
to_iso8859_1
Decode binary as ISO8859-1 into string.from_iso8859_1
Encode string as ISO8859-1 into binary.to_utf8
Encode string as UTF8 into binary.from_utf8
Decode binary as UTF8 into string.to_utf16
Encode string as UTF16 into binary.from_utf16
Decode binary as UTF16 into string.to_utf16le
Encode string as UTF16 little-endian into binary.from_utf16le
Decode binary as UTF16 little-endian into string.to_utf16be
Encode string as UTF16 big-endian into binary.from_utf16be
Decode binary as UTF16 big-endian into string.
Options
fq has some general options in addition to decode and decoders specific options. They all use the same -o <name>=<value>
argument.
<value>
is fuzzily parsed based on the type of the option. Ex: a string can be specified as -o name=string
or -o name="string"
.
-o bits_format=<string>
How to represent raw binary as JSON.
-o bits_format=string
String with raw bytes (zero bit padded if size is not byte aligned). The string is binary safe internally in fq but bytes not representable as UTF-8 will be lost if turn to JSON.-o bits_format=md5
MD5 hex string (zero bit padded).-o bits_format=hex
Hex string.-o bits_format=base64
Base64 string.-p bits_format=truncate
Truncated string.-o bits_format=snippet
Truncated Base64 string prefixed with bit length.
$ fq -V -o bits_format=base64 . file`
In query
tovalue({bits_format: "md5"})
-o skip_gaps=<boolean>
Skip gaps fields (gap0
etc) when using tovalue
or -V
. Note that this might affect array indexes if one more more gaps fields are skipped in an array.
$ fq -V -o skip_gaps=true . file`
In query
tovalue({skip_gaps: true})
Color and unicode output
fq by default tries to use colors if possible, this can be disabled with -M
. You can also
enable usage of unicode characters for improved output by setting the environment
variable CLIUNICODE
.
Configuration
To add own functions you can use init.fq
that will be read from
$HOME/Library/Application Support/fq/init.jq
on macOS$HOME/.config/fq/init.jq
on Linux, BSD etc%AppData%\fq\init.jq
on Windows
Use as script interpreter
fq can be used as a script interpreter:
mp3_duration.jq
:
#!/usr/bin/env fq -d mp3 -rf
[.frames[].header | .sample_count / .sample_rate] | add
Differences to jq
- gojq's differences to jq, notable is support for arbitrary-precision integers.
- Supports hexadecimal
0xab
, octal0o77
and binary0b101
integer literals. - Try include
include "file?";
that doesn't fail if file is missing or has errors. - Some values can act as an object with keys even when it's an array, number etc.
- There can be keys hidden from
keys
and[]
. - Some values are readonly and can't be updated.
Decoded values
When decoding something, using decode
or mp3
etc, you a decode value is returned. They behave like
normal jq values but has special abilities and is used to represent the decoded structure. Each value
always has a name, type and a bit range.
A value has these special keys (TODO: remove, are internal)
_actual
decoded (not symbol mapped value)_bits
bits in range as a binary_buffer_root
first decode value for current buffer_bytes
bits in range as binary using byte units_description
description of value (optional)_error
error message (optional)_format
name of decoded format (optional, only format root)_format_root
first decode value for current format_gap
is a bit range gap (was not decoded)_index
index in parent array (only for values in arrays)_len
bit range length (TODO: rename)_name
name of value_out
decoded out value_parent
parent decode value_path
jq path to decode value_root
root decode value_start
bit range start_stop
bit range stop_sym
symbolic value (optional)
Own decoders and use as library
TODO
Known issues and useful tricks
Run interactive mode with no input
fq -i
null>
select
fails with expected an ... but got: ...
Try add select(...)?
to catch and ignore type errors in the select expression.
Manual decode
Sometimes fq fails to decode or you know there is valid data buried inside some binary or maybe you know the format of some gap field. Then you can decode manually.
# try decode a `mp3_frame` that failed to decode $ fq -d mp3 '.gap0 | mp3_frame' file.mp3 # skip first 10 bytes then decode as `mp3_frame` $ fq -d bytes '.[10:] | mp3_frame' file.mp3
Use .
as input and in a positional argument
The expression .a | f(.b)
might not work as expected. .
is .a
when evaluating the arguments so
the positional argument will end up being .a.b
. Instead do . as $c | .a | f($c.b)
.
Building array is slow
Try to use map
or foreach
to avoid rebuilding the whole array for each append.
Use print
and println
to produce more friendly compact output
> [[0,"a"],[1,"b"]]
[
[
0,
"a"
],
[
1,
"b"
]
]
> [[0,"a"],[1,"b"]] | .[] | "\(.[0]): \(.[1])" | println
0: a
1: b
repl
argument using function or variable causes variable not defined
true as $verbose | repl({verbose: $verbose})
will currently fail as repl
is
implemented by rewriting the query to map(true as $verbose | .) | repl({verbose: $verbose})
.
error
produces no output
null | error
behaves as empty
.