discoveryjsjora-cli
Command line interface for Jora (a JSON query language)
Install
npm i -g jora-cliUsage
> jora -h
Usage:
jora [query] [options]
Options:
--no-color Suppress color output
-c, --compression [name] Compress output: gzip (default when [name] is omitted), deflate
--dry-run Don't output result, only report what it would have done (enables --verbose mode)
-e, --encoding <encoding> Output encoding: json (default), jsonxl (snapshot9)
-f, --force Force overwriting output file
-h, --help Output usage information
-i, --input <filename> Input file
-o, --output <filename> Output file (outputs to stdout if not set)
-p, --pretty [indent] Pretty-prints output with specified indentation (4 spaces if [indent] is omitted)
-q, --query <query> Jora query or path to a query file with extension .jora
--verbose Output debug info about actions
-v, --version Output versionExamples
Get a single field from, e.g. "version":
jora <package.json versionGet all top level dependencies count:
jora -i package.json -q '(dependencies.keys() + devDependencies.keys()).size()'Find packages with more than a single version (run query from a file)
npm ls --json | jora find-multi-version-packages.joraThe content of
find-multi-version-packages.joramay be as follows:..(dependencies.entries().({ name: key, ...value })) .group(=>name, =>version) .({ name: key, versions: value }) .[versions.size() > 1]Supported queries from JSONXL, and conversion JSON ⇄ JSONXL.
Note: JSONXL is a binary replacement for JSON. It is supported by any app built on Discovery.js, including JsonDiscovery, CPUpro and Statoscope. JSONXL not only saves space and transfer time but also offers faster decoding and a lower memory footprint, which is beneficial for processing large datasets.
- Queries for JSONXL input work the same ways as for JSON:
jora <input.jsonxl "select.something" - Convert JSON into JSONXL:
jora <input.json >output.jsonxl -e jsonxl - Convert JSONXL into JSON
jora <input.jsonxl >output.json
- Queries for JSONXL input work the same ways as for JSON:
Supported gzip and deflate as input and output
jora-clican read gzip/deflate on input (auto-detected) and write compressed output via--compression(-c).- Input compression is detected automatically for both stdin and
-i <file>. --compression(-c) affects output only; omit the name to default togzip.- Compression is applied after encoding/pretty-printing.
- Choose an appropriate extension for compressed files (e.g.
.json.gz,.jsonxl.gz,.deflate).
Reading compressed input (auto-detected for
gzipanddeflate, works for files and stdin):# query a gzipped JSON jora < data.json.gz "stats.total" # query a deflated JSON (raw deflate stream) jora -i data.json.deflate "items.size()" # pipe from cat/gunzip as well cat data.json.gz | jora "select.deep.field"Writing compressed output using
-c, --compression:# gzip-compress output (default when name is omitted) jora -i data.json -q "items.group(=>type)" -c > result.json.gz # explicitly choose deflate jora < data.json "items.pick(=>active)" -c deflate > result.json.deflate
Mixing with JSONXL encoding:
# convert JSON -> JSONXL and gzip the result (most compact output combo) jora < data.json > data.jsonxl.gz -e jsonxl -c # read gzipped JSON, query, and write gzipped JSONXL in one go jora < data.json.gz -q "heavy.[score > 0.9]" -e jsonxl -c > filtered.jsonxl.gz # convert JSONXL -> JSON while keeping compression on output jora < data.jsonxl -e json -c > data.json.gz
- Input compression is detected automatically for both stdin and
Caveats
jora-cli takes a valid JSON and produce a valid JSON as a result. However, jora language could produce some values that incompatable with JSON, such values are transforming:
NaN,Infinityand-Infinityare converting tonull, that's a behaviour ofJSON.stringify()undefined- is convering to
nullwhen a result of query (top level) or an element of an array - object entries with
undefinedas a value are eliminating
- is convering to
License
MIT