# jsondepth > A small command-line tool to parse JSON and log it with the desired object depth Latest version **2.0.5** (published 2021-06-15) · MIT license · 0 weekly downloads ## Install ```sh npm install jsondepth pnpm add jsondepth yarn add jsondepth bun add jsondepth ``` Provides the commands `jd`, `jsondepth`. ## Health **Score 25/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned. ## Facts | | | |---|---| | Version | 2.0.5 | | Published | 2021-06-15 | | First published | 2016-04-28 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Node | >= 8 | | Dependencies | 2 | | Unpacked size | 12.1 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 11 | | Author | maxlath | | Maintainers | maxlath | | Keywords | json, ndjson, parse, inspect, depth, cli | ## Links - npm: https://www.npmjs.com/package/jsondepth - Repository: https://github.com/maxlath/jsondepth - Homepage: https://github.com/maxlath/jsondepth#readme - Issues: https://github.com/maxlath/jsondepth/issues - npm.io page: https://npm.io/package/jsondepth ## Dependencies (2) - [split](https://npm.io/package/split.md) ^1.0.1 - [commander](https://npm.io/package/commander.md) ^7.2.0 ## Alternatives - [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads - [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads - [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads - [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads - [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads ## Recent versions - 2.0.5 (latest) — 2021-06-15 - 2.0.4 — 2021-06-12 - 2.0.3 — 2021-04-24 - 2.0.2 — 2020-09-13 - 2.0.1 — 2020-01-10 - 2.0.0 — 2020-01-10 - 1.9.3 — 2019-08-13 - 1.9.2 — 2019-03-17 - 1.9.1 — 2018-05-14 - 1.9.0 — 2018-05-01 - 1.8.0 — 2017-12-08 - 1.7.0 — 2017-02-19 - 1.6.3 — 2017-02-03 - 1.6.2 — 2017-01-17 - 1.6.1 — 2017-01-16 - … 18 more at https://npm.io/package/jsondepth/versions ## README # jsondepth A small command-line tool to walk through the depth levels of a json objects `output json | jd =. =0` ![screenshot](https://cloud.githubusercontent.com/assets/1596934/19417977/b2025c36-93ba-11e6-85fa-6bd274eb6be4.png) ## Summary - [Motivation](#motivation) - [Installation](#installation) - [How-to](#how-to) - [Specify a depth level](#specify-a-depth-level) - [Specify a path](#specify-a-path) - [Specify a depth and a path](#specify-a-depth-and-a-path) - [Access JS objects attributes](#access-js-objects-attributes) - [Native attributes](#native-attributes) - [Arrays `length`](#arrays-length) - [Special keys](#special-keys) - [`_keys`](#_keys) - [`_values`](#_values) - [`_map`](#_map) - [`_first`](#_first) - [`_last`](#_last) - [Format the output as valid JSON](#format-the-output-as-valid-json) - [Parse newline delimited JSON](#parse-newline-delimited-json) - [See also](#see-also) ## Motivation Working with super deep json objects from the terminal is a pain, unless you use a good json parser.
[jq](https://github.com/stedolan/jq) is an awesome one, but doesn't handle object depths, afaik.
Here the idea is to **walk through a json object as you would read a summary**: level by level. ## Installation ```sh npm install -g jsondepth ``` ## How-to real world example: ```sh url='https://www.wikidata.org/w/api.php?action=wbgetentities&ids=Q1&format=json' curl -s "$url" | jsondepth ``` logs the object with only the first-level keys and values: ```js { entities: [Object], success: 1 } ``` for the sake of convenience and lazyness, **jsondepth is aliased to jd**
(which, purposedly make it look a bit like jq) ``` curl -s "$url" | jd ``` ### Specify a depth level this is equivalent to the two previous one: ``` curl -s "$url" | jd 0 ```
now let's go one-level deeper: ```sh curl -s "$url" | jd 1 ``` outputs: ```js { entities: { Q1: [Object] }, success: 1 } ```
![we need to go deeper](http://vignette3.wikia.nocookie.net/glee/images/6/6f/We-need-to-go-deeper_inception.jpg/revision/latest) ```sh curl -s "$url" | jd 2 curl -s "$url" | jd 3 curl -s "$url" | jd 4 # etc ```
If you use [paths](#specify-a-path), you may wish to disable object wrapping: this can be done by passing `-1`. The advantage is that you are sure to get back a valid json object. ```sh curl -s "$url" | jd -1 ``` ### Specify a path ```sh curl -s "$url" | jd entities.Q1.aliases.fi.1 # or to mimick jq syntax curl -s "$url" | jd .entities.Q1.aliases.fi.1 # or with keys with spaces curl -s "$url" | jd .entities.Q1.['a key with spaces'] ``` ### Specify a depth and a path if both a path and a depth are specified, **path should come first, depth second** ```sh curl -s "$url" | jd entities.Q1.claims.P31.0 3 ``` ### Access JS objects attributes #### Native attributes ##### Arrays `length` ```sh curl -s "$url" | jd entities.Q1.aliases.en.length # => 5 ``` #### Special keys ##### `_keys` apply `Object.keys` to the final object ```sh curl -s "$url" | jd entities._keys # => ['Q1'] ``` ##### `_values` apply `_.values` to an array ```sh curl -s "$url" | jd entities._values # => [{ id: 'Q1', etc...}] curl -s "$url" | jd entities._values.0.id # => 'Q1' ``` ##### `_map` map properties of an array ```sh curl -s "$url" | jd entities._values._map.id # => ['Q1'] ``` ##### `_first` ```sh echo '["foo", "bar"]' | jd ._first # => foo ``` ##### `_last` ```sh echo '["foo", "bar"]' | jd ._first # => bar ``` ### Format the output as valid JSON Wrapped results like `{ entities: { Q1: [Object] }, success: 1 }` are more readible but aren't valid JSON. And sometimes, for whatever reason, you want a valid JSON output; there in a option for that: `--json|-j` ``` curl -s "$url" | jd entities.Q1.aliases --json ``` You can even specify the output indentation level (Between 0 and 9. Default: 2): ``` curl -s "$url" | jd entities.Q1.aliases --json=0 curl -s "$url" | jd entities.Q1.aliases --json=4 ``` Notice that it disables the depth option as it's responsible for the wrapping mechanism. ### Parse newline delimited JSON Add the `--line` option to parse the stdin line by line ``` curl https://some.ndjson.dump | jd --line .key ``` There is a tolerance for JSON lines ending by a comma, and any line that isn't starting by a `{` or a `}` is ignored. ## See also * [jq](https://stedolan.github.io/jq/) * [fx](https://github.com/antonmedv/fx) --- _Source: https://npm.io/package/jsondepth · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._