Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://jqlang.github.io/jq/
Command-line JSON processor
https://jqlang.github.io/jq/
jq
Last synced: 8 days ago
JSON representation
Command-line JSON processor
- Host: GitHub
- URL: https://jqlang.github.io/jq/
- Owner: jqlang
- License: other
- Created: 2012-07-18T19:57:25.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2024-10-27T06:55:22.000Z (16 days ago)
- Last Synced: 2024-10-30T01:43:27.221Z (14 days ago)
- Topics: jq
- Language: C
- Homepage: https://jqlang.github.io/jq/
- Size: 8.03 MB
- Stars: 30,463
- Watchers: 322
- Forks: 1,575
- Open Issues: 457
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog
- License: COPYING
- Security: SECURITY.md
- Authors: AUTHORS
Awesome Lists containing this project
- netlas-cookbook - JQ utility documentation
README
# 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
- **Official Documentation**: [jqlang.github.io/jq](https://jqlang.github.io/jq)
- **Try jq Online**: [jqplay.org](https://jqplay.org)
## Installation
### Prebuilt Binaries
Download the latest releases from the [GitHub release page](https://github.com/jqlang/jq/releases).
### Docker Image
Pull the [jq image](https://github.com/jqlang/jq/pkgs/container/jq) to start quickly with Docker.
#### Run with Docker
##### Example: Extracting the version from a `package.json` file
```bash
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
```bash
docker run --rm -i -v "$PWD:$PWD" -w "$PWD" ghcr.io/jqlang/jq:latest '.version' package.json
```
### Building from source
#### Dependencies
- libtool
- make
- automake
- autoconf
#### Instructions
```console
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:
```console
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](.github/workflows/ci.yml) and the [cross-compilation wiki page](https://github.com/jqlang/jq/wiki/Cross-compilation).
## Community & Support
- Questions & Help: [Stack Overflow (jq tag)](https://stackoverflow.com/questions/tagged/jq)
- Chat & Community: [Join us on Discord](https://discord.gg/yg6yjNmgAC)
- Wiki & Advanced Topics: [Explore the Wiki](https://github.com/jqlang/jq/wiki)
## License
`jq` is released under the [MIT License](COPYING). `jq`'s documentation is
licensed under the [Creative Commons CC BY 3.0](COPYING).
`jq` uses parts of the open source C library "decNumber", which is distributed
under [ICU License](COPYING)