jnv Documentation

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

Inspired by jid
and jiq.

Features Copy Chapter

• 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
• Configurable features via TOML configuration
  • Toggle hint message display
  • Adjust UI reactivity (debounce times and animation speed)
  • Editor appearance and behavior
  • JSON viewer styling
  • Adjust completion feature display and behavior
  • Keybinds
• 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 Copy Chapter

Homebrew Copy Section

See here for more info.

brew install jnv

Or install via Homebrew Tap:

brew install ynqa/tap/jnv

MacPorts Copy Section

See here for more info.

sudo port install jnv

Nix / NixOS Copy Section

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

nix-shell -p jnv

conda-forge Copy Section

See here for more info.

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

Docker Copy Section

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 Copy Section

cargo install jnv

Examples Copy Chapter

cat data.json | jnv

# or
jnv data.json

# or write current result to stdout on exit (UNIX only)
cat data.json | jnv --write-to-stdout | some-command
# and also output to file
cat data.json | jnv -- --write-to-stdout > result.json

Keymap Copy Chapter

Editor mode (default) Copy Section

Suggestion in Editor (after Tab)

JSON viewer mode Copy Section

Usage Copy Chapter

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:
  -c, --config <CONFIG_FILE>             Path to the configuration file.
      --default-filter <DEFAULT_FILTER>  Default jq filter to apply to the input data
      --write-to-stdout                  Write the current JSON result to stdout when exiting
  -h, --help                             Print help (see more with '--help')
  -V, --version                          Print version

Configuration Copy Chapter

jnv uses a TOML format configuration file to customize various features.
The configuration file is loaded in the following order of priority:

1. Path specified on the command line (-c or --config option)
2. Default configuration file path

Default Configuration File Location Copy Section

Following the dirs crate,
the default configuration file location for each platform is as follows:

• Linux: ~/.config/jnv/config.toml
• macOS: ~/Library/Application Support/jnv/config.toml
• Windows: C:\Users\{Username}\AppData\Roaming\jnv\config.toml

If the configuration file does not exist,
it will be automatically created on first run.

Configuration Copy Section

[!IMPORTANT]
The syntax in TOML configurations
like default.toml was revamped in v0.7.0,
and the configuration shown below reflects the new format.
A migration tool is not provided for this change.
Please manually replace/update your local
config.toml to match the new syntax.

[!WARNING]
Depending on the type of terminal and environment,
characters and styles may not be displayed properly.
Specific key bindings and decorative characters may not
display or function correctly in certain terminal emulators.

The following settings are available in config.toml

/* Detailed source-code truncated for AI context efficiency. */