Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gmmorris/jg

Jeff Goldblum (jg) is a command-line JSON processor. jg searches for structural patterns in json input and prints each json object that matches the pattern.
https://github.com/gmmorris/jg

Last synced: 5 days ago
JSON representation

Jeff Goldblum (jg) is a command-line JSON processor. jg searches for structural patterns in json input and prints each json object that matches the pattern.

Awesome Lists containing this project

README 

        
[![Travis shield](https://travis-ci.org/gmmorris/jg.svg)](https://travis-ci.org/gmmorris/jg)



**Jeff Goldblum** / **jg** is a command-line JSON processor which, given Newline-Delimited JSON formatted as input, searches for structural patterns in each line of json input and prints each json object that matches the pattern.



## **SUMMARY**

1. **jg** is designed as a drop-in repalcement to **grep** specifically for _Newline-Delimited JSON files_

1. **jg** reads _each line_ in the file and attempt to read it as valid JSON

1. **jg** will use the _selector pattern_ that you specify to match against each line in the file

1. if the line of JSON does in fact match the selector pattern then **jg** will print the line



Read all about the reasoning behind the **jg**'s creation here:

https://gidi.io/tooling/2019/03/01/structured-greping-of-structured-logging-using-grep-for-json/



Read all about Newline-Delimited JSON which is a useful format for log files and streaming structured data here:

http://ndjson.org/

* * *



# **SYNOPSIS**



**jg** [**−^cfimnqv**] [**−e** _pattern_] [**−f** _file_]  [**−colour** _when_] [_pattern_]



# **DESCRIPTION**



The **jg** utility searches any given input files, selecting lines that correctly parse as valid JSON and match one or more _selector patterns_.



The following options are available:



**−c**, **−−count**



Only a count of selected lines is written to standard output.



**−−color=_when_**, **−−colour=_when_**



Surround the matched JSON input with escape sequences to display them in colour on the terminal.

_when_ is never, always, always-cycle, auto, or auto-cycle.

The _always_ and _auto_ options use a single default colour to highlight matches, the difference being t hat _auto_ only highlights content when output is to the terminal.

The _always-cycle_ and _auto-cycle_ options will cycle through a list of colours using a different colour for each match.



**−e** _pattern_



Specify a _selector pattern_ used during the search of the JSON input: an input line is selected if it parses as valid JSON and matches any of the specified _selector patterns_. This option is most useful when multiple **−e** options are used to specify multiple patterns.



**−−help**



Print a brief help message.



**−i**, **−−ignore-case**



Perform case insensitive matching. By default, **jg** is case sensitive.



**−m** _num,_ **−−max-count**=_num_



Stop reading the file after _num_ matches.



**−n**, **−−line-number**



Each output line is preceded by its relative line number in the file, starting at line 1.



**−q**, **−−quiet**, **−−silent**



Quiet mode: suppress normal output. **jg** will only search a file until a match has been found, making searches potentially less expensive.

This is useful if you're trying to ensure a certain match is present in the file and can rely on the Exit Code to get the result. _See **Exit Codes** section_



**−v**, **−−invert-match**



Selected lines are those _not_ matching any of the specified selector patterns.



**−^**, **−−match-root**



Only match objects if the selector matches the root of the JSON shape.

This means that, for example, if your selector is '.name' then the JSON shape must have a `name` property on JSON object itself, and a not an inner object.



## **SELECTOR PATTERNS**



_Selector Patterns_ are a way of describing a JSON structure which **jg** can then use to try and _match_ to the structure of JSON input from within a specified file or piped input. If **jg** finds that the input JSON contains the structure specified by the _selector pattern_ then the input is considered _matched_ and will be printed out.



For example, suppose you consume the Nasa API which returns a JSON dataset describing _How Many People Are In Space Right Now_...

```bash

$ curl 'http://api.open-notify.org/astros.json'

```



...you might get a response resembling this:



```json

{"people":[{"name":"Oleg Kononenko","craft":"ISS"},{"name":"David Saint-Jacques","craft":"ISS"},{"name":"Anne McClain","craft":"ISS"}],"number":3}

```



That's a little hard for a human to read, so just for legibility you can see a beautified version bellow.



```json

{

	"people": [

		{

			"name": "Oleg Kononenko",

			"craft": "ISS"

		}, {

			"name": "David Saint-Jacques",

			"craft": "ISS"

		}, {

			"name": "Anne McClain",

			"craft": "ISS"

		}

	],

	"number": 3

}

```



> It's **important to note** that **jg** evaluates each row in the input as JSON so you would have to stick to the original (non beautified) version when using **jg**.



If you wish to use the _cli_ to verify that there are people in space, you can use **jg** to ensure there is a _people_ property on the object.

For that we can use the _property matcher_ which matches any JSON object who has the specified property on it.



```bash

$ curl 'http://api.open-notify.org/astros.json' | jg '.people'

```



If you do so you'll see that the _cli_ prints out the JSON object, because it matches.



Suppose though you learn that Nasa always return the _people_ property, but it will be an empty array. Luckily, _patterns_ can be chained to describe complex structures deep within the provided input. Instead we'll ensure the people array contains an object.



```bash

$ curl 'http://api.open-notify.org/astros.json' | jg '.people[.]'

```



The JSON output is still getting matched, so this is pretty cool, but then you realise there's another issue which is that the _identity_ matcher, which matches any JSON value, can also match _Null_.



To avoid mistaking _Null_ for a real astronaut, lets ensure that the response contains a proper JSON object with a _name_:



```bash

$ curl 'http://api.open-notify.org/astros.json' | jg '.people[.name]'

```



There, that should do it.



If _curl_-ing the _API_ doesn't return a match, we'll know that no people are in space. Lets hope that never happens.



# **Pattern Syntax**



**Identity**: `.`



This is the most straight forward matcher, as it matches _anything_ and _everything_. This is useful for printing out all valid JSON object in the input or matching against a non-empty sequence in a JSON array, such as `.people[.]`.



**Property**: `.prop_name`



This matcher matches against any JSON object which _has_ a property named as the specified property in the _pattern_. So, for example, in the above _pattern_, any object which has a property with the name "_prop\_name_" will be matched against.



**Property & Value**: `{"prop_name":"prop_value"}`



This matcher is the same as the _property_ pattern, except it also allows us to specify the expected value. So, for example, in the above _pattern_, any object which has a property with the name "_prop\_name_" whose value is the string _prop\_value_ will be matched against.



The value of a property can be any valid JSON primitive, which means it can be a _String_, _Number_, _Boolean_ or _Null_.



_String Value Matchers_:



There are several ways to match against the value of a string and these are loosely based on the [CSS Attribute Selector](https://developer.mozilla.org/en-US/docs/Web/CSS/Attribute_selectors) syntax.



_Property Exact Value_: `{"prop_name":"prop_value"}`



Matches JSON objects whose specified property has the exact specified value. 

For example: ``` {"prop_name":"prop_value"} ```



_Property Contains Exact Value_: `{"prop_name"~:"prop_value"}`



Matches JSON objects whose specified property contains the specified value as a _word_. A _word_ is a single part pf a whitespace-separated list of words.

 For example: ``` {"prop_name":"This value will surely contain prop_value in it."} ```



_Property Prefixed Value_: `{"prop_name"^:"prop_value"}`



Matches JSON objects whose specified property begins with the specified value. 

 For example: ``` {"prop_name":"prop_value is what I'm all about."} ```



_Property Suffixed Value_: `{"prop_name"$:"prop_value"}`



Matches JSON objects whose specified property ends with the specified value. 

 For example: ``` {"prop_name":"Know what I'm all about? It's prop_value"} ```



_Property Contains Value_: `{"prop_name"*:"prop_value"}`



Matches JSON objects whose specified property contains the specified value. 

 For example: ``` {"prop_name":"Wildcard search for a the 'prop_value' is awesome"} ```



**Array Index**: `[2]`



This matcher matches against an array by verifying that it contains a value at the specified index.



For example: ``` ["some different value","member_value","some other value"] ```



**Array & Value**: `[="member_value"]`



This matcher matches against an array by verifying that it contains the exact string "_member\_value_" inside it.



Just like the property matcher, the value of an array member can be any valid JSON primitive, which means it can be a _String_, _Number_, _Boolean_ or _Null_.



_Array Value Matchers_:



There are several ways to match against the value in an array and these are similar to the _property_ selector's _string value matchers_ but slightly different due to differences between String and Array.



_Array Exact Value_: `[="member_value"]`



Matches JSON array whose contains the exact specified value and that is the only single value in the array. This can be used with all _primitives_.

For example: ``` ["member_value"] ```



_Array Contains Exact Value_: `[~="member_value"]`



Matches JSON array whose contains the exact specified value.  This can be used with all _primitives_.

For example: ``` ["some different value","member_value","some other value"] ```



_Array Prefixed Value_: `[^="member_value"]`



Matches JSON array which contains a value which _begins_ with the specified value.  This can only be used with strings.

For example: ``` ["some different value","member_value is cool","some other value"] ```



_Array Suffixed Value_: `[$="member_value"]`



Matches JSON array which contains a value which _ends_ with the specified value.  This can only be used with strings.

For example: ``` ["some different value","Know what's cool? member_value","some other value"] ```



_Array Contains Value_: `[*="_value"]`



Matches JSON array whose contains the specified value as a substring of a value in the array. 

For example: ``` ["Know what's cool? wildcard search of a member_value value","some other value"] ```



## **EXIT CODES**



In line with _grep_, the **jg** exit codes returns the exit status 0 if a selector match is found in the file and 1 if no selector is matched.



## **INSTALLATION**



While we iron out the kinks we're avoiding publishing **jg** into public package managers.

That said, under the _releases_ tab you will find both an _OSX_ and _Linux_ release.



If you're on _OSX_ and use _Homebrew_ you can use the following script to install the latest OSX release:



```

brew install https://raw.githubusercontent.com/gmmorris/jg/master/packaging/jg.rb

```



If you're on _linux_ we've created several binaries, including RPMs for supported distribution, which are available on [the releases page](https://github.com/gmmorris/jg/releases).



If you wish to install using an RPM you can use the following command:

_Note that the bellow command is *just an example*, you're better getting the latest URL from the releases page_



```

yum install -y https://github.com/gmmorris/jg/releases/download/0.1.4/jg-0.1.4-x86_64-unknown-linux-gnu.rpm

```



## **EXAMPLES**



![Using Colour to Highlight](../master/colour.gif?raw=true)



To find all JSON input with an object with property `name` on it:



```bash

$ jg '.name' -f myfile

```



To find all JSON input with an object with property `fellowship`, whose value is an array and in that array there's a JSON object with the property `name` on it whose value is `Aragorn`:



```bash

$ jg '.fellowship[{"name":"Aragorn"}]' -f myfile

```



To find all JSON input with whose root object has the property `name` on it:



```bash

$ jg -^ '.name' -f myfile

```



To find all JSON input which does not have the property `name` anywhere in its structure:



```bash

$ grep -v '.name' -f myfile

```



* * *