https://github.com/nuckal777/nuq

A multi-format frontend for jq
https://github.com/nuckal777/nuq

jq json rust toml yaml

Last synced: about 1 month ago
JSON representation

A multi-format frontend for jq

• Host: GitHub
• URL: https://github.com/nuckal777/nuq
• Owner: Nuckal777
• License: unlicense
• Created: 2022-06-29T20:29:09.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-02-05T13:29:51.000Z (11 months ago)
• Last Synced: 2024-04-25T03:17:29.788Z (8 months ago)
• Topics: jq, json, rust, toml, yaml
• Language: Rust
• Homepage:
• Size: 82 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Nuq

![Build Status](https://img.shields.io/github/actions/workflow/status/Nuckal777/nuq/test.yaml?branch=master)

[![Coverage Status](https://coveralls.io/repos/github/Nuckal777/nuq/badge.svg?branch=master)](https://coveralls.io/github/Nuckal777/nuq?branch=master)

A multi-format frontend to jq supporting pretty-printing and syntax highlighting. Whether you need to process JSON, YAML or TOML pipe it into `nuq` and be done with it.

## Motivation

Based on some recent discussion at work I decided that an other option to process YAML is required. :wink:

To my knowledge there are two common options for that:

- [yq](https://github.com/mikefarah/yq), which uses Golang and has its interpreter with differs from jq's interpreter.

- [yq](https://github.com/kislyuk/yq), which uses python to convert YAML to JSON and shells out to jq after. Therefore it is slower than native implementations.

`nuq` should have decent speed and can execute all programs accepted by jq due to calling libjq directly. To be fair `nuq` has to parse JSON input streams containing multiple documents to split them before they can be handed off to libjq, so a straight `jq` should be faster.

## Usage

```

A multi-format frontend for jq

Usage: nuq [OPTIONS]  [FILES]...

Arguments:

     Jq program to execute

  [FILES]...  Input files, stdin if omitted

Options:

  -i, --input-format 

          Input format, will be guessed by extension or content [possible values: json, yaml, ron, toml]

  -o, --output-format 

          Output format, if omitted will return the input format. Toml output may require reordering the input [possible values: json, yaml, ron, toml]

  -r, --raw

          If jq outputs a JSON string only output contained plain text. This post-processes the jq output, so it may not behave the same as "jq -r"

      --slurp

          Concatenate all input files into a JSON array before processing it with jq

  -c, --color 

          Enables or disables colored output. By default coloring is enabled when writing to a tty [possible values: true, false]

  -p, --pretty

          Pretty-prints the output, if the serializer supports that

```

## How it works

Converts the input using [serde](https://serde.rs/) to JSON, runs it through `jq` with [jq-rs](https://crates.io/crates/jq-rs), which uses `libjq` (no shell-out) and transform it to the output format with [serde](https://serde.rs/) again.

Techically support for all formats supported by [serde](https://serde.rs/) can be implemented.