jnichols0/jnv

interactive JSON filter using jq

jnv is designed for navigating JSON, offering an interactive JSON viewer and jq filter editor.

Inspired by jid and jiq.

Features

• Interactive JSON viewer and jq filter editor
  • Syntax highlighting for JSON
  • Use jaq to apply jq filter
    • This eliminates the need for users to prepare jq on their own.

Important

Starting from v0.3.0, the transition from libjq Rust binding j9 to jq clone jaq was made.

This change eliminated the need to manage C-related dependencies that include external tools like autoconf, thus simplifying the build process. However, please note that some filters are not yet supported by jaq. For more details, refer to GitHub issue #24.

Please continue to provide feedback regarding this transition.

• Capable of accommodating various format
  • Input: File, Stdin
  • Data: A JSON or multiple JSON structures that can be deserialized with StreamDeserializer, such as JSON Lines
• Auto-completion for the filter
  • Only supports:
    • Identity
    • Object Identifier-Index
    • Array Index
• Hint message to evaluate the filter

Installation

Homebrew

See here for more info.

brew install jnv

Or install via Homebrew Tap:

brew install ynqa/tap/jnv

MacPorts

See here for more info.

sudo port install jnv

Nix / NixOS

See package entry on search.nixos.org for more info.

nix-shell -p jnv

conda-forge

See here for more info.

pixi global install jnv
# or
cat data.json | pixi exec jnv
# or
conda install jnv

Docker

Build (In the near future, the image will be available on something of registries)

docker build -t jnv .

And Run (The following commad is just an example. Please modify the path to the file you want to mount)

docker run -it --rm -v $(pwd)/debug.json:/jnv/debug.json jnv /jnv/debug.json

Cargo

cargo install jnv

Examples

cat data.json | jnv
# or
jnv data.json

Keymap

Key	Action
Ctrl + C	Exit jnv
Tab	jq filter auto-completion
←	Move the cursor one character to the left
→	Move the cursor one character to the right
Ctrl + A	Move the cursor to the start of the filter
Ctrl + E	Move the cursor to the end of the filter
Backspace	Delete a character of filter at the cursor position
Ctrl + U	Delete all characters of filter
↑, Ctrl + K	Move the cursor one entry up in JSON viewer
↓, Ctrl + J	Move the cursor one entry down in JSON viewer
Ctrl + H	Move to the last entry in JSON viewer
Ctrl + L	Move to the first entry in JSON viewer
Enter	Toggle expand/collapse in JSON viewer
Ctrl + P	Expand all folds in JSON viewer
Ctrl + N	Collapse all folds in JSON viewer
Alt + B	Move the cursor to the previous nearest character within set(.,|,(,),[,])
Alt + F	Move the cursor to the next nearest character within set(.,|,(,),[,])
Ctrl + W	Erase to the previous nearest character within set(.,|,(,),[,])
Alt + D	Erase to the next nearest character within set(.,|,(,),[,])
Ctrl + O	Copy current JSON content to clipboard
Ctrl + Q	Copy current query to clipboard

Usage

JSON navigator and interactive filter leveraging jq

Usage: jnv [OPTIONS] [INPUT]

Examples:
- Read from a file:
        jnv data.json

- Read from standard input:
        cat data.json | jnv

Arguments:
  [INPUT]  Optional path to a JSON file. If not provided or if "-" is specified, reads from standard input

Options:
  -e, --edit-mode <EDIT_MODE>
          Edit mode for the interface ('insert' or 'overwrite'). [default: insert]
  -i, --indent <INDENT>
          Number of spaces used for indentation in the visualized data. [default: 2]
  -n, --no-hint
          Disables the display of hints.
  -d, --expand-depth <JSON_EXPAND_DEPTH>
          Initial depth to which JSON nodes are expanded in the visualization. [default: 3]
  -s, --limit-length <JSON_LIMIT_LENGTH>
          Limit length of JSON array in the visualization. [default: 50]
  -l, --suggestion-list-length <SUGGESTION_LIST_LENGTH>
          Number of suggestions visible in the list. [default: 3]
  -h, --help
          Print help (see more with '--help')
  -V, --version
          Print version

Stargazers over time