https://github.com/therealklanni/jp

A tiny commandline tool for parsing JSON from any source.
https://github.com/therealklanni/jp

cli commandline json npm parser

Last synced: about 2 months ago
JSON representation

A tiny commandline tool for parsing JSON from any source.

• Host: GitHub
• URL: https://github.com/therealklanni/jp
• Owner: therealklanni
• License: mit
• Created: 2016-12-08T21:25:56.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2019-02-14T01:25:58.000Z (almost 6 years ago)
• Last Synced: 2024-04-25T14:22:31.966Z (9 months ago)
• Topics: cli, commandline, json, npm, parser
• Language: JavaScript
• Homepage: https://npmjs.com/jp-cli
• Size: 56.6 KB
• Stars: 50
• Watchers: 3
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-cli-apps - jp - JSON parser. (Data Manipulation / JSON)
• fucking-awesome-cli-apps - jp - JSON parser. (Data Manipulation / JSON)

README

        
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/therealklanni/jp/blob/master/LICENSE)

[![Build Status](https://img.shields.io/travis/therealklanni/jp.svg)](https://travis-ci.org/therealklanni/jp)

[![npm](https://img.shields.io/npm/v/jp-cli.svg)](https://www.npmjs.com/package/jp-cli)

[![Prettier](https://img.shields.io/badge/style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

# jp

> Simply parse JSON from any input source.

_Inspired by_ [jq](https://github.com/stedolan/jq); not a replacement.

Supports [Lodash .get() path syntax](https://lodash.com/docs/#get) and [JSONPath syntax](https://github.com/dchester/jsonpath).

Also supports stdin streaming (see last example), i.e. line-by-line.

```

yarn global add jp-cli || npm install -g jp-cli

```

## Usage

```

Pipe jp onto a JSON source from the commandline to parse the output:

  cat data.json | jp [options] query

Options:

  -p, --path      Use JSON Path notation (https://github.com/dchester/jsonpath)

  -k, --keys      Print object keys only                               [boolean]

  -f, --file      Read input from file                                  [string]

  -i, --indent    Number of spaces for indentation (ignored by --human)

                                                           [number] [default: 2]

  -h, --human     Print human-readable (non-JSON) format               [boolean]

  -b, --break     Set break length of object/array for human format     [number]

  -c, --no-color  Disable color for human format                       [boolean]

  -d, --depth     Depth for human format                                [number]

  -L, --line-by-line  Parse each line as a separate input              [boolean]

  --help          Show help                                            [boolean]

Queries use the Lodash get method by default.

For more information, see https://github.com/therealklanni/jp

```

### Examples

> $ cat user-response.json | jp data.user

```js

{

  "name": "Gazorpazorpfield",

  "color": "orange"

}

```

> $ cat user-response.json | jp data.user | jp --keys

```js

[

  "name",

  "color"

]

```

> $ cat user-response.json | jp data.user.name

```js

"Gazorpazorpfield"

```

`jp` can also parse JSON line-by-line from a stdin stream.

> $ [ipfs](https://github.com/ipfs/ipfs) log tail | jp -L event | jq -r

```js

updatePeer

handleFindPeerBegin

handleFindPeer

updatePeer

handleFindPeerBegin

handleFindPeer

Bitswap.Rebroadcast.active

Bitswap.Rebroadcast.idle

... until you ^C

```

#### License

MIT © [therealklanni](https://github.com/therealklanni)