livejq

Crates.iolivejq
lib.rslivejq
version2.0.0
sourcesrc
created_at2023-07-30 13:48:40.347686
updated_at2024-08-04 08:39:00.722616
descriptionAn alternative jq implementation in rust for continuous parsing without crashing on invalid JSON. With filters
homepagehttps://github.com/kunalsin9h/livejq
repositoryhttps://github.com/kunalsin9h/livejq
max_upload_size
id929985
size25,985
Kunal Singh (KunalSin9h)

documentation

README

LiveJQ

livejq is JSON parser like jq but is designed to work in continuous input without crashing on invalid JSON. With json filtering.

It uses livejq.toml file to specify filter rules.

User Case

When you have a program that is printing logs which may have other formats in between like text along with JSON, and you want to parse JSON for better readability. You can use livejq to parse JSON without crashing on other formats.

Or when you want to apply filters when paring json.

Demo

https://github.com/KunalSin9h/livejq/assets/82411321/71907858-5150-4efe-8c0f-58bb1c0dc591

Install

Install using cargo

cargo install livejq

or you can find binaries in the Release page

Usage

./your_program | livejq

Filter

To apply filtering, you need to create livejq.toml file in the project root.

It contains labels. labels are filter labels which you can apply with -f / --filter flag.

Example config file:

# livejq.toml

allow = ["name"] # default

[network-fail]  # -f network-fail
allow = ["failed"]

[memory-info] # -f memory-info
allow = ["memory"]

Then run the application as

./your_program | livejq -f network-fail

# you can apply multiple filters
./your_program | livejq -f network-fail memory-info

when not label is created, default is used. For each label, you can only give allow or disallow, not both.

When not flag is used while running the program, the default flag is used.

Here | is for piping output of my_program into livejq as input.

Commit count: 36

cargo fmt