brianredbeard/faq

Format Agnostic jQ

faq

Note: The master branch may be in an unstable or even broken state during development. Please use releases instead of the master branch in order to get stable binaries.

faq is a tool intended to be a drop in replacement for "jq", but supports additional formats. The additional formats are converted into JSON and processed with libjq.

faq is pronounced "fah queue".

Supported formats:

• BSON
• Bencode
• JSON
• TOML
• XML
• YAML

For example usage, read the examples doc.

Installation

faq is still under heavy development and has only unstable binary releases. Behavior such as command-line flags may change causing shell scripts using faq to break after upgrading.

Linux

curl -Lo /usr/local/bin/faq https://github.com/jzelinskie/faq/releases/download/0.0.3/faq-linux-amd64
chmod +x /usr/local/bin/faq

macOS

brew tap jzelinskie/faq
brew install faq

Development

In order to compile the project, the latest stable version of Go and knowledge of a working Go environment are required. A modern version of jq that includes the libjq header files, must also be installed on the system. Reproducible builds are handled by using dep to vendor dependencies.

mkdir faq && export GOPATH=$PWD/faq
git clone [email protected]:jzelinskie/faq.git $GOPATH/src/github.com/jzelinskie/faq
cd $GOPATH/src/github.com/jzelinskie/faq
dep ensure
go install github.com/jzelinskie/faq
$GOPATH/bin/faq --help

License

faq is made available under the Apache 2.0 license. See the LICENSE file for details.