Files
jq/docs/content/download/default.yml
T

227 lines
9.8 KiB
YAML
Raw Normal View History

2012-09-18 17:51:53 +01:00
headline: Download jq
body:
- text: |
jq is written in C and has no runtime dependencies, so it should be
possible to build it for nearly any platform. Prebuilt binaries are
available for Linux, macOS and Windows.
2012-09-18 17:51:53 +01:00
The binaries should just run, but on macOS and Linux you may need
to make them executable first using `chmod +x jq`.
2012-09-19 00:08:02 +01:00
2012-09-18 17:51:53 +01:00
jq is licensed under the MIT license. For all of the gory
details, read the file `COPYING` in the source distribution.
2012-09-19 00:08:02 +01:00
2018-10-27 00:04:35 +03:00
jq uses a C library for decimal number support. This is an ICU 1.8.1
licensed code obtained from the ICU downloads archive.
<https://download.icu-project.org/files/decNumber/decNumber-icu-368.zip>
2018-10-27 00:04:35 +03:00
2012-10-23 14:46:44 +01:00
### Linux
2015-08-13 22:33:37 -07:00
* jq is in the official [Debian](https://packages.debian.org/jq) and
[Ubuntu](https://packages.ubuntu.com/jq) repositories. Install using
2015-08-07 21:40:19 -07:00
`sudo apt-get install jq`.
2012-10-23 14:46:44 +01:00
* jq is in the official [Fedora](https://src.fedoraproject.org/rpms/jq) repository.
2015-11-26 10:48:06 -05:00
Install using `sudo dnf install jq`.
2012-10-23 14:46:44 +01:00
* jq is in the official [openSUSE](https://software.opensuse.org/package/jq) repository.
Install using `sudo zypper install jq`.
2015-09-20 14:11:35 +03:00
* jq is in the official [Arch](https://archlinux.org/packages/?q=jq) repository.
Install using `sudo pacman -S jq`.
2012-09-18 17:51:53 +01:00
2023-09-07 10:54:10 -07:00
* jq 1.7 binaries for
[AMD64](https://github.com/jqlang/jq/releases/download/jq-1.7/jq-linux-amd64)
2018-10-28 19:18:48 -04:00
or
2023-09-07 10:54:10 -07:00
[ARM64](https://github.com/jqlang/jq/releases/download/jq-1.7/jq-linux-arm64)
or
[i386](https://github.com/jqlang/jq/releases/download/jq-1.7/jq-linux-i386).
* jq 1.6 binaries for
[AMD64](https://github.com/jqlang/jq/releases/download/jq-1.6/jq-linux64)
or
[i386](https://github.com/jqlang/jq/releases/download/jq-1.6/jq-linux32).
2018-10-28 19:18:48 -04:00
2015-08-15 23:12:31 -07:00
* jq 1.5 binaries for
2023-09-07 10:54:10 -07:00
[AMD64](https://github.com/jqlang/jq/releases/download/jq-1.5/jq-linux64)
2015-08-15 23:12:31 -07:00
or
2023-09-07 10:54:10 -07:00
[i386](https://github.com/jqlang/jq/releases/download/jq-1.5/jq-linux32).
2015-08-15 23:12:31 -07:00
* jq 1.4 binaries for
2023-09-07 10:54:10 -07:00
[AMD64](https://github.com/jqlang/jq/releases/download/jq-1.4/jq-linux-x86_64)
or
2023-09-07 10:54:10 -07:00
[i386](https://github.com/jqlang/jq/releases/download/jq-1.4/jq-linux-x86).
2015-08-07 21:40:19 -07:00
* jq 1.3 binaries for
2023-09-07 10:54:10 -07:00
[AMD64](https://github.com/jqlang/jq/releases/download/jq-1.3/jq-linux-x86_64)
or
2023-09-07 10:54:10 -07:00
[i386](https://github.com/jqlang/jq/releases/download/jq-1.3/jq-linux-x86).
2015-07-23 21:26:18 -07:00
### macOS
* Use [Homebrew](https://brew.sh/) to install jq with `brew install jq`.
2021-12-26 17:18:03 -05:00
* Use [MacPorts](https://www.macports.org) to install jq with `port install jq`.
* Use [Fink](https://finkproject.org) to install jq with `fink install jq`.
2023-09-07 10:54:10 -07:00
* jq 1.7 binaries for
[AMD64](https://github.com/jqlang/jq/releases/download/jq-1.7/jq-macos-amd64)
or
[ARM64](https://github.com/jqlang/jq/releases/download/jq-1.7/jq-macos-arm64).
2018-10-28 19:18:48 -04:00
* jq 1.6 binary for
2023-09-07 10:54:10 -07:00
[AMD64](https://github.com/jqlang/jq/releases/download/jq-1.6/jq-osx-amd64).
2018-10-28 19:18:48 -04:00
2015-08-15 23:44:41 -07:00
* jq 1.5 binary for
2023-09-07 10:54:10 -07:00
[AMD64](https://github.com/jqlang/jq/releases/download/jq-1.5/jq-osx-amd64).
2015-08-15 23:44:41 -07:00
* jq 1.4 binaries for
2023-09-07 10:54:10 -07:00
[AMD64](https://github.com/jqlang/jq/releases/download/jq-1.4/jq-osx-x86_64)
or
2023-09-07 10:54:10 -07:00
[i386](https://github.com/jqlang/jq/releases/download/jq-1.4/jq-osx-x86).
* jq 1.3 binaries for
2023-09-07 10:54:10 -07:00
[AMD64](https://github.com/jqlang/jq/releases/download/jq-1.3/jq-osx-x86_64)
or
2023-09-07 10:54:10 -07:00
[i386](https://github.com/jqlang/jq/releases/download/jq-1.3/jq-osx-x86).
2015-08-18 08:21:55 -07:00
### FreeBSD
2018-10-21 23:11:37 -04:00
* `pkg install jq` as root installs a pre-built
[binary package](https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/pkgng-intro.html).
* `make -C /usr/ports/textproc/jq install clean` as root installs the
[jq](https://www.freshports.org/textproc/jq/)
[port](https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/ports-using.html)
from source.
2015-08-18 08:21:55 -07:00
2015-07-23 21:26:18 -07:00
### Solaris
2014-06-12 19:26:05 -05:00
2015-08-15 12:07:00 -07:00
* `pkgutil -i jq` in [OpenCSW](https://www.opencsw.org/p/jq) for Solaris
2015-08-07 21:40:19 -07:00
10+, Sparc and x86.
2015-07-23 21:26:18 -07:00
* jq 1.4 binaries for Solaris 11
2023-09-07 10:54:10 -07:00
[AMD64](https://github.com/jqlang/jq/releases/download/jq-1.4/jq-solaris11-64)
or
2023-09-07 10:54:10 -07:00
[i386](https://github.com/jqlang/jq/releases/download/jq-1.4/jq-solaris11-32).
2014-06-12 19:26:05 -05:00
### Windows
2023-06-06 05:52:09 +09:00
* Use [winget](https://learn.microsoft.com/en-us/windows/package-manager/winget/)
to install jq with `winget install jqlang.jq`.
* Use [scoop](https://scoop.sh/) to install jq with `scoop install jq`.
2023-06-16 14:55:29 +02:00
* Use [Chocolatey NuGet](https://chocolatey.org/) to install jq with
2015-08-07 21:40:19 -07:00
`chocolatey install jq`.
2015-07-23 21:26:18 -07:00
2023-09-07 10:54:10 -07:00
* jq 1.7 executables for
[AMD64](https://github.com/jqlang/jq/releases/download/jq-1.7/jq-windows-amd64.exe)
2018-10-28 19:18:48 -04:00
or
2023-09-07 10:54:10 -07:00
[i386](https://github.com/jqlang/jq/releases/download/jq-1.7/jq-windows-i386.exe).
* jq 1.6 executables for
[AMD64](https://github.com/jqlang/jq/releases/download/jq-1.6/jq-win64.exe)
or
[i386](https://github.com/jqlang/jq/releases/download/jq-1.6/jq-win32.exe).
2018-10-28 19:18:48 -04:00
2015-08-15 23:12:31 -07:00
* jq 1.5 executables for
2023-09-07 10:54:10 -07:00
[AMD64](https://github.com/jqlang/jq/releases/download/jq-1.5/jq-win64.exe)
2015-08-15 23:12:31 -07:00
or
2023-09-07 10:54:10 -07:00
[i386](https://github.com/jqlang/jq/releases/download/jq-1.5/jq-win32.exe).
2015-08-15 23:12:31 -07:00
* jq 1.4 executables for
2023-09-07 10:54:10 -07:00
[AMD64](https://github.com/jqlang/jq/releases/download/jq-1.4/jq-win64.exe)
or
2023-09-07 10:54:10 -07:00
[i386](https://github.com/jqlang/jq/releases/download/jq-1.4/jq-win32.exe).
2015-07-23 21:26:18 -07:00
* jq 1.3 executables for
2023-09-07 10:54:10 -07:00
[AMD64](https://github.com/jqlang/jq/releases/download/jq-1.3/jq-win64.exe)
or
2023-09-07 10:54:10 -07:00
[i386](https://github.com/jqlang/jq/releases/download/jq-1.3/jq-win32.exe).
### Checksums and signatures
SHA-256 checksums are provided for all release and pre-release binaries.
They can be found under
2023-05-28 17:06:31 +01:00
[sig/v1.x/sha256sum.txt](https://github.com/jqlang/jq/tree/master/sig).
2023-09-07 10:54:10 -07:00
The checksums for jq 1.7 are in
[sig/v1.7/sha256sum.txt](https://raw.githubusercontent.com/jqlang/jq/master/sig/v1.7/sha256sum.txt).
2018-10-28 19:18:48 -04:00
The checksums for jq 1.6 are in
2023-05-28 17:06:31 +01:00
[sig/v1.6/sha256sum.txt](https://raw.githubusercontent.com/jqlang/jq/master/sig/v1.6/sha256sum.txt).
The checksums for jq 1.5 are in
2023-05-28 17:06:31 +01:00
[sig/v1.5/sha256sum.txt](https://raw.githubusercontent.com/jqlang/jq/master/sig/v1.5/sha256sum.txt).
2023-07-31 23:10:41 -05:00
Additionally, all release artifacts are signed by a jq release key. We have two release keys, [one for 1.6 and older releases](https://raw.githubusercontent.com/jqlang/jq/master/sig/jq-release-old.key), and [one for 1.7 and newer releases](https://raw.githubusercontent.com/jqlang/jq/master/sig/jq-release-new.key).
Signatures can be found under
2023-05-28 17:06:31 +01:00
[sig/v1.x/\*.asc](https://github.com/jqlang/jq/tree/master/sig).
2023-09-07 10:54:10 -07:00
The signatures for jq 1.7 are in
[sig/v1.7/\*.asc](https://github.com/jqlang/jq/tree/master/sig/v1.7).
2018-10-28 19:18:48 -04:00
The signatures for jq 1.6 are in
2023-07-31 23:10:41 -05:00
[sig/v1.6/\*.asc](https://github.com/jqlang/jq/tree/master/sig/v1.6).
The signatures for jq 1.5 are in
2023-05-28 17:06:31 +01:00
[sig/v1.5/\*.asc](https://github.com/jqlang/jq/tree/master/sig/v1.5).
You can use [GnuPG](https://gnupg.org/) to verify a signature by downloading
the signature and running `gpg --verify signature.asc`.
### From source on Linux, macOS, Cygwin, and other POSIX-like operating systems
2023-09-07 10:54:10 -07:00
* [Source tarball for jq 1.7](https://github.com/jqlang/jq/releases/download/jq-1.7/jq-1.7.tar.gz)
2023-05-28 17:06:31 +01:00
* [Source tarball for jq 1.6](https://github.com/jqlang/jq/releases/download/jq-1.6/jq-1.6.tar.gz)
* [Source tarball for jq 1.5](https://github.com/jqlang/jq/releases/download/jq-1.5/jq-1.5.tar.gz)
2013-05-19 10:48:25 +01:00
You can build it using the usual `./configure && make && sudo
make install` rigmarole.
If you're interested in using the latest development version, try:
2013-05-19 10:48:25 +01:00
2023-05-28 17:06:31 +01:00
git clone --recursive https://github.com/jqlang/jq.git
cd jq
2013-09-20 10:34:57 +08:00
autoreconf -i
2023-07-24 11:34:21 +02:00
./configure
2013-05-19 10:48:25 +01:00
make
sudo make install
2012-09-18 17:51:53 +01:00
To build it from a git clone, you'll need to install a few
packages first:
2015-08-15 12:07:00 -07:00
* [GCC](https://gcc.gnu.org)
* [Make](https://www.gnu.org/software/make/)
* [Autotools](https://www.gnu.org/software/automake/)
2012-09-18 17:51:53 +01:00
For Linux systems, these will all be in your system's package
manager, and if you do development on the machine they're most
2012-12-07 14:40:20 +00:00
likely already installed.
2012-09-18 17:51:53 +01:00
On macOS, these are all included in Apple's command line tools, which can
2015-08-07 21:40:19 -07:00
be installed from [Xcode](https://developer.apple.com/xcode/). However,
you may find that you need a newer version of Bison than the one provided
by Apple. This can be found in [Homebrew](https://brew.sh/) or
2015-08-15 12:07:00 -07:00
[MacPorts](https://macports.org/).
2023-07-24 11:34:21 +02:00
If you want to generate the lexer and parser from source you can use the
`--enable-maintainer-mode` configure flag. This requires bison to be installed.
2023-06-05 00:29:36 -05:00
[Flex](https://github.com/westes/flex) and
2015-08-15 23:12:31 -07:00
[Bison](https://www.gnu.org/software/bison/).
2015-08-13 22:33:37 -07:00
### Docker
Docker image is available from
[GitHub Container Registry](https://github.com/jqlang/jq/pkgs/container/jq).
docker run -i --rm ghcr.io/jqlang/jq -n 'range(3)'
#### Building the documentation
2012-09-18 17:51:53 +01:00
2019-02-20 20:50:08 -05:00
jq's documentation is compiled into static HTML using Python.
2023-07-31 09:52:52 +09:00
To build the docs, run `pipenv run python3 build_website.py --root /output`
in the `docs/` directory. To serve them locally, you can run
`python3 -m http.server`. You'll need a few Python dependencies,
2019-02-20 20:50:08 -05:00
which can be installed by following the instructions in `docs/README.md`.
The man page is built by `make jq.1`, or just `make`, also from
2019-02-20 20:50:08 -05:00
the YAML docs, and you'll still need the Python dependencies to
build the manpage.