wader/fq
1
1
Fork 0
mirror of https://github.com/wader/fq.git synced 2024-12-23 13:22:58 +03:00
Code Issues Projects Releases Wiki Activity
jq for binary formats
248 Commits 36 Branches 23 Tags 61 MiB
Go 96.5%
jq 3.3%
Makefile 0.1%
509b8f8c50
Go to file
Mattias Wadman 509b8f8c50 flac_picture: Add picture_type names
2021-10-13 21:34:14 +02:00
.github/workflows Update github-go-version from 1.17.1, 1.17.1 to 1.17.2 2021-10-08 18:34:51 +02:00
.vscode Add *grep/1/2 and find/1/2 2021-10-13 01:27:04 +02:00
dev test: Nicer test output 2021-09-19 11:58:37 +02:00
doc doc: Add find/1 find/2 2021-10-13 19:43:53 +02:00
format flac_picture: Add picture_type names 2021-10-13 21:34:14 +02:00
internal Add *grep/1/2 and find/1/2 2021-10-13 01:27:04 +02:00
pkg Add *grep/1/2 and find/1/2 2021-10-13 01:27:04 +02:00
.golangci.yml lint: Enable errcheck adnd revive 2021-09-27 11:01:14 +02:00
.goreleaser.yml goreleaser: Cleanup 2021-10-05 12:27:24 +02:00
Bumpfile bump: Cleanup config, add config for release.yml 2021-10-05 12:18:47 +02:00
Dockerfile Update docker-golang from 1.17.1 to 1.17.2 2021-10-08 18:34:04 +02:00
go.mod gojq: Update fq fork 2021-10-12 18:10:20 +02:00
go.sum gojq: Update fq fork 2021-10-12 18:10:20 +02:00
LICENSE Init 2021-09-12 13:08:42 +02:00
main.go cli: Make profile build optional and move it to cli 2021-09-12 13:08:53 +02:00
Makefile readme: Nicer demo 2021-10-10 02:17:29 +02:00
README.md readme: Nicer demo 2021-10-10 02:17:29 +02:00

README.md

fq

Tool, language and format decoders for exploring binary data.

fq demo

Goals

  • Make structured binary data accessible.
  • Nested formats and bit-oriented decoding.
  • Quick CLI tool that mimics jq as much as possible.
  • Do bit and byte transformations and conversions.
  • Programmer's calculator.

NOTE: fq is early in development and many things are missing, broken or do not make sense. That also means there is a great opportunity to help out.

Install

Download archive from releases page for your platform, unarchive and move the executable to PATH.

Homebrew

# install latest release
brew install wader/tap/fq

Build from source

Make sure you have go 1.17 or later installed.

To install directly from git repository do:

# 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 build and run tests from source directory:

make test fq
# copy binary to $PATH if needed
cp fq /usr/local/bin

Usage

Basic usage is:

Usage: fq [OPTIONS] [--] [EXPR] [FILE...]

For more usage details see usage.md.

Supported formats

aac_frame, adts, adts_frame, apev2, av1_ccr, av1_frame, av1_obu, avc_annexb, avc_au, avc_dcr, avc_nalu, avc_pps, avc_sei, avc_sps, bzip2, dns, elf, exif, flac, flac_frame, flac_metadatablocks, flac_picture, gif, gzip, hevc_annexb, hevc_au, hevc_dcr, hevc_nalu, icc_profile, id3v1, id3v11, id3v2, jpeg, json, matroska, mp3, mp3_frame, mp4, mpeg_asc, mpeg_es, mpeg_pes, mpeg_pes_packet, mpeg_spu, mpeg_ts, ogg, ogg_page, opus_packet, png, protobuf, protobuf_widevine, pssh_playready, raw, tar, tiff, vorbis_comment, vorbis_packet, vp8_frame, vp9_cfm, vp9_frame, vpx_ccr, wav, webp, xing

See formats for more details.

TODO and ideas

See TODO.md

Development

See dev.md

Thanks and related projects

This project would not be possible without itchyny's jq implementation gojq. Also want to thank HexFiend for inspiration and ideas and stedolan for inventing the jq language.

Similar projects: