Skip to content

m jsonq

Query json data.

single value::

m jsonq path.to.property < file.json
cat file.json | m jsonq path.to.property
m jsonq @file.json path.to.property

Return the value stored in the json file. For arrays and objects it will print the python representation of the object.

multiple values::

m jsonq path1 path2 path3 < file.json
cat file.json | m jsonq path1 path2 path3
m jsonq @file.json path1 path2 path3

use read to store in bash variables::

read -r -d '\n' \
    var1 var2 var3 \
    <<< "$(m jsonq @file.json 'path1' 'path2' 'path3')"

If available, take advantage of better queries through jq and yq:

  • jq: https://stedolan.github.io/jq/manual/
  • yq: https://mikefarah.gitbook.io/yq/
Source code in m/cli/commands/jsonq.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
class Arguments(BaseModel):
    r"""Query json data.

    single value::

        m jsonq path.to.property < file.json
        cat file.json | m jsonq path.to.property
        m jsonq @file.json path.to.property

    Return the value stored in the json file. For arrays and objects it
    will print the python representation of the object.

    multiple values::

        m jsonq path1 path2 path3 < file.json
        cat file.json | m jsonq path1 path2 path3
        m jsonq @file.json path1 path2 path3

    use `read` to store in bash variables::

        read -r -d '\n' \
            var1 var2 var3 \
            <<< "$(m jsonq @file.json 'path1' 'path2' 'path3')"

    If available, take advantage of better queries through jq and yq:

    - jq: https://stedolan.github.io/jq/manual/
    - yq: https://mikefarah.gitbook.io/yq/
    """

    payload: Any = Arg(
        default='@-',
        help='json data: @- (stdin), @filename (file), string',
        validator=validate_json_payload,
        positional=True,
    )

    query: list[str] = Arg(
        help='path to json data',
        positional=True,
        nargs='+',
    )

    warn: bool = Arg(
        default=False,
        help='print warning messages instead of errors',
        aliases=['w', 'warn'],
    )

    separator: str = Arg(
        default='\n',
        help='separator for multiple values',
        aliases=['s', 'separator'],
    )

Options

-w, --warn

  • default: false

print warning messages instead of errors

-s, --separator

  • default: '\n'

separator for multiple values

Positional arguments

payload

  • default: '@-'

json data: @- (stdin), @filename (file), string

query

path to json data