mirror of
https://github.com/wader/fq.git
synced 2024-12-23 13:22:58 +03:00
229 lines
4.6 KiB
Markdown
229 lines
4.6 KiB
Markdown
# fq
|
||
|
||
Tool, language and decoders for working with binary data.
|
||
|
||
|
||
|
||
In most cases fq works the same way as jq but instead of reading JSON it reads binary data.
|
||
The result is a JSON compatible structure where values have a bit range, can have symbolic
|
||
values and know how to be presented in a useful ways.
|
||
|
||
It was initially developed to debug, inspect and query media files but has since been extended
|
||
to handle a variety of binary formats.
|
||
|
||
You can pronounce the name as you wish, I pronounce jq /‘dʒei’kju:/ so I usually pronounce fq /‘ef’kju:/.
|
||
|
||
**NOTE:** fq is still early in development so some things are broken or do not make sense.
|
||
That also means that there is a great opportunity to help out!
|
||
|
||
### Goals
|
||
|
||
- Make binaries accessible, queryable and sliceable.
|
||
- Nested formats and bit-oriented decoding.
|
||
- Quick and comfortable CLI tool.
|
||
- Bits and bytes transformations.
|
||
|
||
### Hopes
|
||
|
||
- Make it useful enough that people want to help improve it.
|
||
- Inspire people to create similar tools.
|
||
|
||
### Supported formats
|
||
|
||
[./formats_list.jq]: sh-start
|
||
|
||
aac_frame,
|
||
adts,
|
||
adts_frame,
|
||
apev2,
|
||
ar,
|
||
av1_ccr,
|
||
av1_frame,
|
||
av1_obu,
|
||
avc_annexb,
|
||
avc_au,
|
||
avc_dcr,
|
||
avc_nalu,
|
||
avc_pps,
|
||
avc_sei,
|
||
avc_sps,
|
||
bencode,
|
||
bsd_loopback_frame,
|
||
bson,
|
||
bzip2,
|
||
cbor,
|
||
dns,
|
||
dns_tcp,
|
||
elf,
|
||
ether8023_frame,
|
||
exif,
|
||
flac,
|
||
flac_frame,
|
||
flac_metadatablock,
|
||
flac_metadatablocks,
|
||
flac_picture,
|
||
flac_streaminfo,
|
||
gif,
|
||
gzip,
|
||
hevc_annexb,
|
||
hevc_au,
|
||
hevc_dcr,
|
||
hevc_nalu,
|
||
icc_profile,
|
||
icmp,
|
||
id3v1,
|
||
id3v11,
|
||
id3v2,
|
||
ipv4_packet,
|
||
jpeg,
|
||
json,
|
||
matroska,
|
||
mp3,
|
||
mp3_frame,
|
||
mp4,
|
||
mpeg_asc,
|
||
mpeg_es,
|
||
mpeg_pes,
|
||
mpeg_pes_packet,
|
||
mpeg_spu,
|
||
mpeg_ts,
|
||
msgpack,
|
||
ogg,
|
||
ogg_page,
|
||
opus_packet,
|
||
pcap,
|
||
pcapng,
|
||
png,
|
||
protobuf,
|
||
protobuf_widevine,
|
||
pssh_playready,
|
||
raw,
|
||
sll2_packet,
|
||
sll_packet,
|
||
tar,
|
||
tcp_segment,
|
||
tiff,
|
||
udp_datagram,
|
||
vorbis_comment,
|
||
vorbis_packet,
|
||
vp8_frame,
|
||
vp9_cfm,
|
||
vp9_frame,
|
||
vpx_ccr,
|
||
wav,
|
||
webp,
|
||
xing,
|
||
zip
|
||
|
||
[#]: sh-end
|
||
|
||
For details see [formats.md](doc/formats.md)
|
||
|
||
## Usage
|
||
|
||
Basic usage is `fq . file`.
|
||
|
||
For more details see [usage.md](doc/usage.md)
|
||
|
||
## Install
|
||
|
||
Use one of the methods listed below or download [release](https://github.com/wader/fq/releases)
|
||
for your platform. Unarchive it and move the executable to `PATH` etc.
|
||
|
||
On macOS if don't install using a method below you might have to manually allow the binary to run.
|
||
This can be done by trying to run the binary, ignore the warning and then go into security preference
|
||
and allow it. Or you can run this command:
|
||
|
||
```sh
|
||
xattr -d com.apple.quarantine fq && spctl --add fq
|
||
```
|
||
|
||
### Homebrew
|
||
|
||
```sh
|
||
# install latest release
|
||
brew install wader/tap/fq
|
||
```
|
||
|
||
### Arch Linux
|
||
|
||
`fq` can be installed from the [community repository](https://archlinux.org/packages/community/x86_64/fq/) using [pacman](https://wiki.archlinux.org/title/Pacman):
|
||
|
||
```sh
|
||
pacman -S fq
|
||
```
|
||
|
||
You can also build and install the development (VCS) package using an [AUR helper](https://wiki.archlinux.org/index.php/AUR_helpers):
|
||
|
||
```sh
|
||
paru -S fq-git
|
||
```
|
||
|
||
### Nix
|
||
|
||
```sh
|
||
nix-shell -p fq
|
||
```
|
||
|
||
### FreeBSD
|
||
|
||
Use the [fq](https://cgit.freebsd.org/ports/tree/misc/fq) port.
|
||
|
||
### Alpine
|
||
|
||
Currently in edge testing but should work fine in stable also.
|
||
|
||
```
|
||
apk add -X http://dl-cdn.alpinelinux.org/alpine/edge/testing fq
|
||
```
|
||
|
||
### Build from source
|
||
|
||
Make sure you have go 1.17 or later installed.
|
||
|
||
To install directly from git repository do:
|
||
```sh
|
||
# build and install latest release
|
||
go install github.com/wader/fq@latest
|
||
|
||
# or build and install latest master
|
||
go install github.com/wader/fq@master
|
||
|
||
# copy binary to $PATH if needed
|
||
cp "$(go env GOPATH)/bin/fq" /usr/local/bin
|
||
```
|
||
|
||
To run and run tests from source directory:
|
||
```sh
|
||
# run all tests and build binary
|
||
make test fq
|
||
# it's also possible to use go run
|
||
go run fq.go
|
||
```
|
||
|
||
## TODO and ideas
|
||
|
||
See [TODO.md](doc/TODO.md)
|
||
|
||
## Development
|
||
|
||
See [dev.md](doc/dev.md)
|
||
|
||
## Thanks and related projects
|
||
|
||
This project would not have been possible without [itchyny](https://github.com/itchyny)'s
|
||
jq implementation [gojq](https://github.com/itchyny/gojq). I also want to thank
|
||
[HexFiend](https://github.com/HexFiend/HexFiend) for inspiration and ideas and [stedolan](https://github.com/stedolan)
|
||
for inventing the [jq](https://github.com/stedolan/jq) language.
|
||
|
||
### Similar or related projects
|
||
|
||
- [HexFiend](https://github.com/HexFiend/HexFiend)
|
||
- [binspector](https://github.com/binspector/binspector)
|
||
- [kaitai](https://kaitai.io)
|
||
- [Wireshark](https://www.wireshark.org) (specially `tshark -T json`)
|
||
- [MediaInfo](https://mediaarea.net/en/MediaInfo) (specially `mediainfo --Output=JSON` and `mediainfo --Details=1`)
|
||
- [GNU poke](https://www.jemarch.net/poke)
|
||
- [ffmpeg/ffprobe](https://ffmpeg.org)
|
||
- [hexdump](https://git.kernel.org/pub/scm/utils/util-linux/util-linux.git/tree/text-utils/hexdump.c)
|