Command-line JSON processor
C Yacc M4 JSONiq Shell C++ Other
Permalink
Failed to load latest commit information.
build Rake task to build website including source dist and binaries. May 11, 2013
config Add `pow`, better libm detection (fix #443) Jun 28, 2015
docs Document `localtime` and `strflocaltime` Feb 24, 2017
m4 BSD sed lacks -r; fix #551 Aug 14, 2014
modules Add local oniguruma submodule Feb 19, 2017
scripts gen_utf8_tables: remove unused variable Jan 26, 2017
sig Fix linux32 jq-1.5 executable (fix #935) Oct 23, 2015
src Add `localtime` and `strflocaltime` (fix #1349) Feb 24, 2017
tests Allow var bindings in path expressions (#1347) Feb 22, 2017
.gitattributes Remove .gitignore from tarballs. Oct 23, 2012
.gitignore Move jq-coded builtins to non-C file (fix #424) Oct 23, 2015
.gitmodules Add local oniguruma submodule Feb 19, 2017
.travis.yml Attempt to use builtin Oniguruma for CIs Feb 23, 2017
AUTHORS Add @base64d for decoding base64 #47 Feb 12, 2017
COPYING Use https where possible Aug 15, 2015
ChangeLog Update ChangeLog Jul 10, 2015
Dockerfile Revert e7caf68 for Dockerfile Feb 24, 2017
KEYS Remove David from maintainers Feb 24, 2016
Makefile.am Add local oniguruma submodule Feb 19, 2017
NEWS Update website for jq 1.5 (fix #910) Aug 16, 2015
README Check in a pile of Autotools junk, including the configure script. May 8, 2013
README.md Promote wiki more in README Jan 31, 2017
appveyor.yml Attempt to use builtin Oniguruma for CIs Feb 23, 2017
compile-ios.sh Get oniguruma from github instead of geocities Sep 5, 2015
configure.ac Add `localtime` and `strflocaltime` (fix #1349) Feb 24, 2017
jq.1.prebuilt Document `localtime` and `strflocaltime` Feb 24, 2017
jq.spec Use https where possible Aug 15, 2015

README.md

jq

jq is a lightweight and flexible command-line JSON processor.

Coverage Status, Unix: Build Status, Windows: Windows build status

If you want to learn to use jq, read the documentation at https://stedolan.github.io/jq. This documentation is generated from the docs/ folder of this repository. You can also try it online at jqplay.org.

If you want to hack on jq, feel free, but be warned that its internals are not well-documented at the moment. Bring a hard hat and a shovel. Also, read the wiki: https://github.com/stedolan/jq/wiki, where you will find cookbooks, discussion of advanced topics, internals, release engineering, and more.

Source tarball and built executable releases can be found on the homepage and on the github release page, https://github.com/stedolan/jq/releases

If you're building directly from the latest git, you'll need flex, bison (3.0 or newer), libtool, make, and autoconf installed. To get regexp support you'll also need to install Oniguruma (note that jq's tests require regexp support to pass). To build, run:

autoreconf -i   # if building from git
./configure
make -j8
make check

To build without bison or flex, add --disable-maintainer-mode to the ./configure invocation:

./configure --disable-maintainer-mode

(Developers must not use --disable-maintainer-mode, not when making changes to the jq parser and/or lexer.)

To build a statically linked version of jq, run:

make LDFLAGS=-all-static

After make finishes, you'll be able to use ./jq. You can also install it using:

sudo make install

If you're not using the latest git version but instead building a released tarball (available on the website), then you won't need to run autoreconf (and shouldn't), and you won't need flex or bison.

To cross-compile for OS X and Windows, see docs/Rakefile's build task and scripts/crosscompile. You'll need a cross-compilation environment, such as Mingw for cross-compiling for Windows.

Cross-compilation requires a clean workspace, then:

# git clean ...
autoreconf -i
./configure
make distclean
scripts/crosscompile <name-of-build> <configure-options>

Use the --host= and --target= ./configure options to select a cross-compilation environment. See also the wiki.

Send questions to https://stackoverflow.com/questions/tagged/jq or to the #jq channel (http://irc.lc/freenode/%23jq/) on Freenode (https://webchat.freenode.net/).