jq README

The project's README from github.com/jqlang/jq. As one markdown file: README.md.

jq

jq is a lightweight and flexible command-line JSON processor akin to sed,awk,grep, and friends for JSON data. It's written in portable C and has zero runtime dependencies, allowing you to easily slice, filter, map, and transform structured data.

Documentation

Installation

Prebuilt Binaries

Download the latest releases from the GitHub release page.

Docker Image

Pull the jq image to start quickly with Docker.

Run with Docker

Example: Extracting the version from a package.json file
docker run --rm -i ghcr.io/jqlang/jq:latest < package.json '.version'
Example: Extracting the version from a package.json file with a mounted volume
docker run --rm -i -v "$PWD:$PWD" -w "$PWD" ghcr.io/jqlang/jq:latest '.version' package.json

Building from source

Dependencies

Instructions

git submodule update --init    # if building from git to get oniguruma
autoreconf -i                  # if building from git
./configure --with-oniguruma=builtin
make clean                     # if upgrading from a version previously built from source
make -j8
make check
sudo make install

Build a statically linked version:

make LDFLAGS=-all-static

If you're not using the latest git version but instead building a released tarball (available on the release page), skip the autoreconf step, and flex or bison won't be needed.

Cross-Compilation

For details on cross-compilation, check out the GitHub Actions file and the cross-compilation wiki page.

Community & Support

License

jq is released under the MIT License. jq's documentation is licensed under the Creative Commons CC BY 3.0. jq uses parts of the open source C library "decNumber", which is distributed under ICU License

jq (jqlang/jq)

Searching Database…

35.8K ·GitHub
Что это такое?jq — это лёгкий консольный процессор JSON, что-то вроде sed, awk и grep, только для JSON-данных: он нарезает, фильтрует, преобразует и трансформирует структурированные данные прямо в терминале.
Так это отдельная программа, которую я запускаю, или библиотека, которую я подключаю в свой код?Это отдельный консольный инструмент, а не библиотека. Он написан на портируемом C и не имеет никаких рантайм-зависимостей, так что вы просто прогоняете его на любом JSON.
Как его установить?Скачайте готовый бинарник со страницы релизов на GitHub, загрузите Docker-образ jq или соберите из исходников обычным путём через autotools (autoreconf, configure, make).
Нужно ли ещё что-то установить, чтобы он работал?Для работы — ничего: у бинарников ноль зависимостей. А вот для сборки из исходников нужны libtool, make, automake и autoconf.
Есть ли подводные камни при сборке из исходников?Один: если вы собираете релизный tarball, а не последнюю версию из git, пропустите шаг autoreconf — flex и bison тоже не понадобятся.
На каких платформах он работает?Linux, macOS и Windows — готовые бинарники лежат на странице релизов. Есть также Docker-образ, а для других платформ задокументирована кросс-компиляция.
Можно попробовать jq, ничего не устанавливая?Да — play.jqlang.org это официальный онлайн-плейграунд, а полная документация живёт на jqlang.org.
Проект до сих пор активно развивается?Да — релизы выходят на странице GitHub Releases, в репозитории работают CI-процессы, а вокруг проекта живое сообщество в Discord и в теге jq на Stack Overflow.
What are similar projects?fq, fx, fastfetch, miller, difftastic, mas, cloc, tig
Creator
jqlang
Size
8 MB
Stars
35.8K
Age
14y
Commits · 90 Days