mirror of
https://github.com/jqlang/jq.git
synced 2026-10-12 02:16:58 +00:00
Hugohong258andHugohong258
1b4109b0d0
State explicitly in the README and download page that the platform-specific prebuilt files are standalone executables, not archives. Include the rename and executable-permission step for macOS and Linux in the README. Addresses #2956. Source archives are not described as executables. Validation: the official `docs/build_website.py` completed and the generated download page contains the new guidance. Used a Python venv with the site's required rendering packages; restored the Windows checkout's manual symlink in a temporary build copy only. jq itself was not built or tested for this documentation-only change. Co-authored-by: Hugohong258 <[email protected]>
81 lines
2.5 KiB
Markdown
81 lines
2.5 KiB
Markdown
# 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.org](https://jqlang.org)
|
|
- **Try jq Online**: [play.jqlang.org](https://play.jqlang.org)
|
|
|
|
## Installation
|
|
|
|
### Prebuilt Binaries
|
|
|
|
Download the latest releases from the [GitHub release page](https://github.com/jqlang/jq/releases).
|
|
The platform-specific assets are standalone executables, not archives. On macOS and Linux,
|
|
rename the downloaded file to `jq` and make it executable with `chmod +x jq`.
|
|
|
|
### 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)
|