diff options
Diffstat (limited to 'doc/commandline.rst')
-rw-r--r-- | doc/commandline.rst | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/doc/commandline.rst b/doc/commandline.rst new file mode 100644 index 0000000..7678442 --- /dev/null +++ b/doc/commandline.rst @@ -0,0 +1,33 @@ +The ``jsonpointer`` commandline utility +======================================= + +The JSON pointer package also installs a ``jsonpointer`` commandline utility +that can be used to resolve a JSON pointers on JSON files. + +The program has the following usage :: + + usage: jsonpointer [-h] [--indent INDENT] [-v] POINTER FILE [FILE ...] + + Resolve a JSON pointer on JSON files + + positional arguments: + POINTER File containing a JSON pointer expression + FILE Files for which the pointer should be resolved + + optional arguments: + -h, --help show this help message and exit + --indent INDENT Indent output by n spaces + -v, --version show program's version number and exit + + +The following shows example usage :: + + $ cat a.json + { "a": [1, 2, 3] } + $ cat b.json + { "a": {"b": [1, 3, 4]}, "b": 1 } + $ cat ptr.json + "/a" + $ jsonpointer ptr.json a.json b.json + [1, 2, 3] + {"b": [1, 3, 4]} |