Built with Crystal CI Latest release oq

A performant, portable jq wrapper thats facilitates the consumption and output of formats other than JSON; using jq filters to transform the data.


Linux via snap

For more on installing & using snap with your Linux distribution, see the official documentation.

snap install oq


brew tap blacksmoke16/tap
brew install oq

From Source

If building from source, jq will need to be installed separately. Installation instructions can be found in the official documentation.

Requires Crystal to be installed, see the installation documentation.

git clone https://github.com/Blacksmoke16/oq.git
cd oq/
shards build --production --release

The built binary will be available as ./bin/oq. This can be relocated elsewhere on your machine; be sure it is in your PATH to access it as oq.


oq can easily be included into a Docker image by fetching the static binary from Github for the version of oq that you want.

# Set an arg to store the oq version that should be installed.

# Grab the binary from the latest Github release and make it executable; placing it within /usr/local/bin.  Can also put it elsewhere if you so desire.
RUN wget https://github.com/Blacksmoke16/oq/releases/download/v${OQ_VERSION}/oq-${OQ_VERSION}-linux-x86_64 -O /usr/local/bin/oq && chmod +x /usr/local/bin/oq

# Also be sure to install jq if it is not already!



Use the oq binary, with a few optional custom arguments, see oq --help. All other arguments get passed to jq. See jq manual for details.


Consume JSON and output XML

echo '{"name": "Jim"}' | oq -o xml .
<?xml version="1.0" encoding="UTF-8"?>

Consume YAML from a file and output XML


name: Jim
  - 1
  - 2
  - 3
oq -i yaml -o xml . data.yaml 
<?xml version="1.0" encoding="UTF-8"?>


  1. Fork it (<https://github.com/Blacksmoke16/oq/fork>)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request