Command-line JSON processor
Clone or download
wtlangford Merge pull request #1768 from haochenx/readme-add-automake-as-build-d…
…ependency-in

add automake as build dependency to README.md
Latest commit bb87e6e Nov 20, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE Create issue template Aug 17, 2018
build Rake task to build website including source dist and binaries. May 11, 2013
config Bugfix: Math function checking Oct 12, 2018
docs Minor website fixes for 1.6 Nov 2, 2018
m4 BSD sed lacks -r; fix #551 Aug 14, 2014
modules Update oniguruma to fix #1370 Apr 2, 2017
scripts Make scripts/version work in shallow clones Mar 3, 2017
sig Release jq-1.6 Nov 2, 2018
src Add missing jv_copy when printing with -ar Nov 20, 2018
tests Fix destructuring alternation Aug 18, 2018
.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 Fix osx travis build Aug 31, 2018
AUTHORS Update AUTHORS Dec 11, 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 Fix make dist Mar 2, 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 add automake as build dependency to README.md Nov 12, 2018
appveyor.yml Fix Appveyor for non-master branches Feb 26, 2017
compile-ios.sh Updated the compile-ios.sh script to fix issues with local oniguruma … Dec 13, 2017
configure.ac Bugfix: Math function checking Oct 12, 2018
jq.1.prebuilt Revert "reduce: handle empty updates (fix #1313)" Dec 11, 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, automake, and autoconf installed. To get regexp support you'll also need to install Oniguruma or clone it as a git submodule as per the instructions below. (note that jq's tests require regexp support to pass). To build, run:

git submodule update --init # if building from git to get oniguruma
autoreconf -fi              # if building from git
./configure --with-oniguruma=builtin
make -j8
make check

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

./configure --with-oniguruma=builtin --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/).