analyse-json

CLI tool to analyse Newline Delimited (ND)JSON files and return useful metadata about the structure to help you understand the contents

USAGE:
    analyse-json [OPTIONS] [FILE_PATH]

ARGS:
    <FILE_PATH>    File to process, expected to contain a single JSON object or Newline
                   Delimited (ND) JSON objects

OPTIONS:
        --explode-arrays
            Walk the elements of arrays treating arrays like a map of their enumerated elements?
            (E.g. $.path.to.array[0], $.path.to.array[1], ...) Ignored if using `--inspect-arrays`

    -g, --glob <GLOB>
            Process all files identified by this glob pattern

        --generate-completions <SHELL>
            Output shell completions for the chosen shell to stdout [possible values: bash, elvish,
            fish, powershell, zsh]

    -h, --help
            Print help information

        --inspect-arrays
            Walk the elements of arrays grouping elements paths together under `$.path.to.array[*]`?
            Takes precedence over `--explode-arrays`

        --jsonpath <JSONPATH>
            JSONpath query to filter/limit the inspection to e.g. `'$.a_key.an_array[0]'`

        --merge
            Include combined results for all files when using glob

    -n, --lines <LINES>
            Limit inspection to the first n lines

        --parallel
            Use multi-threaded version of the processing

    -q, --quiet
            Silence error logging

    -V, --version
            Print version information

Installation

via cargo

Prerequisites

You need to have cargo installed https://doc.rust-lang.org/cargo/getting-started/installation.html

Install

cargo install analyse-json

Prebuild binaries

Prebuild binaries for some systems can be found on github

Changelog

Changelog is available on github