Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dbohdan/jsonwatch
Track changes in JSON data from the command line
https://github.com/dbohdan/jsonwatch
change-report cli command-line-tool json monitor-changes rust watch
Last synced: 2 days ago
JSON representation
Track changes in JSON data from the command line
- Host: GitHub
- URL: https://github.com/dbohdan/jsonwatch
- Owner: dbohdan
- License: mit
- Created: 2014-03-17T15:20:26.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-05-28T16:32:26.000Z (5 months ago)
- Last Synced: 2024-10-12T13:14:07.578Z (22 days ago)
- Topics: change-report, cli, command-line-tool, json, monitor-changes, rust, watch
- Language: Rust
- Homepage: https://crates.io/crates/jsonwatch
- Size: 113 KB
- Stars: 166
- Watchers: 11
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
README
# jsonwatch — like `watch -d` but for JSON
jsonwatch is a command-line utility that lets you track changes in JSON data delivered by a shell command or a web (HTTP/HTTPS) API.
jsonwatch requests data from the source repeatedly at a set interval.
It displays the differences when the data changes.
It is similar but not identical to how [watch(1)](https://manpages.debian.org/stable/procps/watch.1.en.html) with the `-d` switch works for plain-text data.
jsonwatch has been tested on Debian 12, Ubuntu 24.04, macOS 14, and Windows 10 and Server 2022.
The two previous versions of jsonwatch are preserved in the branch
[`python`](https://github.com/dbohdan/jsonwatch/tree/python)
and
[`haskell`](https://github.com/dbohdan/jsonwatch/tree/haskell).
## Installation
Prebuilt binaries are available for Linux and Windows.
Binaries are attached to releases on the
["Releases"](https://github.com/dbohdan/jsonwatch/releases)
page.
### Installing with Cargo
```sh
cargo install jsonwatch
```
### Building on Debian and Ubuntu
Follow the instructions to build a static Linux binary of jsonwatch from the source code on recent Debian and Ubuntu.
1\. Install [Rustup](https://rustup.rs/).
Through Rustup, add the stable musl libc target for your CPU.
```sh
rustup target add x86_64-unknown-linux-musl
```
2\. Install the build and test dependencies.
```sh
sudo apt install build-essential expect musl-tools
cargo install just
```
3\. Clone this repository.
Build the binary.
```sh
git clone https://github.com/dbohdan/jsonwatch
cd jsonwatch
just test
just release-linux
```
### Cross-compiling for Windows
Follow the instructions to build a 32-bit Windows binary of jsonwatch on recent Debian and Ubuntu.
1\. Install [Rustup](https://rustup.rs/).
Through Rustup, add the i686 GNU ABI Windows target.
```sh
rustup target add i686-pc-windows-gnu
```
2\. Install the build dependencies.
```sh
sudo apt install build-essential mingw-w64
cargo install just
```
3\. Configure Cargo for cross-compilation.
Add the following in `~/.cargo/config`.
```toml
[target.i686-pc-windows-gnu]
linker = "/usr/bin/i686-w64-mingw32-gcc"
```
4\. Clone this repository.
Build the binary.
```sh
git clone https://github.com/dbohdan/jsonwatch
cd jsonwatch
just release-windows
```
## Use examples
### Commands
#### *nix
Testing jsonwatch.
```none
$ jsonwatch -n 1 -c "echo '{ \"filename\": \"'\$(mktemp -u)'\"}'"
{
"filename": "/tmp/tmp.dh3Y7LJTaK"
}
2020-01-19T18:52:19+0000 .filename: "/tmp/tmp.dh3Y7LJTaK" -> "/tmp/tmp.i4s56VENEJ"
2020-01-19T18:52:20+0000 .filename: "/tmp/tmp.i4s56VENEJ" -> "/tmp/tmp.zzMUSn45Fc"
2020-01-19T18:52:21+0000 .filename: "/tmp/tmp.zzMUSn45Fc" -> "/tmp/tmp.Jj1cKt6VLr"
2020-01-19T18:52:22+0000 .filename: "/tmp/tmp.Jj1cKt6VLr" -> "/tmp/tmp.1LGk4ok8O2"
2020-01-19T18:52:23+0000 .filename: "/tmp/tmp.1LGk4ok8O2" -> "/tmp/tmp.wWulyho8Qj"
```
Docker process information.
```none
$ jsonwatch -c 'docker ps -a "--format={{json .}}"' -n 1
2020-01-19T18:57:20+0000
+ .Command: "\"bash\""
+ .CreatedAt: "2020-01-19 18:57:20 +0000 UTC"
+ .ID: "dce7fb2194ed"
+ .Image: "i386/ubuntu:latest"
+ .Labels: ""
+ .LocalVolumes: "0"
+ .Mounts: ""
+ .Names: "dreamy_edison"
+ .Networks: "bridge"
+ .Ports: ""
+ .RunningFor: "Less than a second ago"
+ .Size: "0B"
+ .Status: "Created"
2020-01-19T18:57:21+0000 .RunningFor: "Less than a second ago" -> "1 second ago"
2020-01-19T18:57:23+0000
.RunningFor: "1 second ago" -> "3 seconds ago"
.Status: "Created" -> "Up 1 second"
2020-01-19T18:57:24+0000
.RunningFor: "3 seconds ago" -> "4 seconds ago"
.Status: "Up 1 second" -> "Up 2 seconds"
2020-01-19T18:57:25+0000
.RunningFor: "4 seconds ago" -> "5 seconds ago"
.Status: "Up 2 seconds" -> "Up 3 seconds"
```
#### Windows
On Windows, `-c` executes `cmd.exe` commands.
```none
> jsonwatch -c "type tests\weather1.json"
{
"clouds": {
"all": 92
},
"name": "Kiev",
"coord": {
"lat": 50.43,
"lon": 30.52
},
"sys": {
"country": "UA",
"message": 0.0051,
"sunset": 1394985874,
"sunrise": 1394942901
},
"weather": [
{
"main": "Snow",
"id": 612,
"icon": "13d",
"description": "light shower sleet"
},
{
"main": "Rain",
"id": 520,
"icon": "09d",
"description": "light intensity shower rain"
}
],
"rain": {
"3h": 2
},
"base": "cmc stations",
"dt": 1394979003,
"main": {
"pressure": 974.8229,
"humidity": 91,
"temp_max": 277.45,
"temp": 276.45,
"temp_min": 276.15
},
"id": 703448,
"wind": {
"speed": 10.27,
"deg": 245.507
},
"cod": 200
}
2020-01-19T18:51:04+0000 + .test: true
2020-01-19T18:51:10+0000 .test: true -> false
2020-01-19T18:51:23+0000 - .test: false
```
### URLs
Watching a URL works identically on *nix and on Windows.
Weather tracking.
(This API is no longer works without a key.)
```none
$ jsonwatch -u http://api.openweathermap.org/data/2.5/weather\?q\=Kiev,ua --no-initial-values -n 300
2014-03-17T23:06:19.073790
+ .rain.1h: 0.76
- .rain.3h: 0.5
.dt: 1395086402 -> 1395089402
.main.temp: 279.07 -> 278.66
.main.temp_max: 279.82 -> 280.15
.main.temp_min: 277.95 -> 276.05
.sys.message: 0.0353 -> 0.0083
```
Geolocation.
(Try this on a mobile device.)
```none
$ jsonwatch -u https://ipinfo.io/ --no-initial-values -n 300
```
## License
jsonwatch is distributed under the MIT license.
See the file [`LICENSE`](LICENSE) for details.
[Wapp](tests/vendor/wapp/wapp.tcl) is copyright (c) 2017 D. Richard Hipp and is distributed under the Simplified BSD License.