Installing the command-line executable

Assuming you have Rust/Cargo installed, run this command in a terminal:

cargo install jsq

It will make the jsq command available in your PATH if you've allowed the PATH to be modified when installing Rust. cargo uninstall jsq uninstalls.

Back to the crate overview.

Readme

jsq

jsq is a tool for evaluating some JavaScript and printing the result.

Help

Evaluate some JavaScript and print the result

Usage: jsq [OPTIONS] [SCRIPT]

Arguments:
  [SCRIPT]  The JavaScript to be evaluated [default: $]

Options:
  -j, --json-in      Parse input as JSON
  -y, --yaml-in      Parse input as YAML
  -t, --toml-in      Parse input as TOML
  -5, --json5-in     Parse input as JSON5
  -c, --csv-in       Parse input as CSV
  -J, --json-out     Print result as JSON
  -Y, --yaml-out     Print result as YAML
  -T, --toml-out     Print result as TOML
  -%, --json5-out    Print result as JSON5
  -C, --csv-out      Print result as CSV
  -N, --no-out       Don't print result
  -f, --file <FILE>  Read SCRIPT from FILE
  -h, --help         Print help
  -V, --version      Print version

Input is available in SCRIPT as $. Environment variables are available in SCRIPT prefixed by $.

Example

Suppose we have some JSON which contains a bunch of superheroes and we want to find the hero with the power of "Immortality":

> curl https://mdn.github.io/learning-area/javascript/oojs/json/superheroes.json |
    jsq -jJ '$.members.find(m => m.powers.includes("Immortality"))'
{
  "name": "Eternal Flame",
  "age": 1000000,
  "secretIdentity": "Unknown",
  "powers": [
    "Immortality",
    "Heat Immunity",
    "Inferno",
    "Teleportation",
    "Interdimensional travel"
  ]
}

Semantics

The provided SCRIPT is evaluated by Deno so the Deno runtime and standard library are available, as are third party imports.

If any of the --FORMAT-in flags described in the help are set then $ contains the result of parsing STDIN from that format. If no input format is specified then $ contains STDIN as plain text. If STDIN is a terminal then $ is the empty string.

If any of the --FORMAT-out flags described in the help are set, then the value of the final statement in SCRIPT is printed to STDOUT after being serialized in the specified format. If no output format is specified then the result is printed as plain text. If --no-out is set then the result is not printed.

Environment variables are available in SCRIPT prefixed by $. e.g. USER is available as $USER.

Why?

JavaScript is a convenient language with which to process JSON (which stands for "JavaScript Object Notation" after all), but the boilerplate of reading from STDIN, parsing, and writing to STDOUT makes many could-be "one-liners" significantly more involved than they need to be. jsq provides a thin wrapper around Deno which handles this boilerplate and makes it more ergonomic to sprinkle a little JavaScript in to a shell script.

jsq can be used for many of the same tasks as jq. A given jq command is often a little shorter than the equivalent jsq command, but if (like the author) you find yourself often forgetting the syntax of jq, and you already know JavaScript, you might find jsq easier to use. To see how jsq compares to jq, check out the translated jq tutorial.

Install

With brew

brew install callum-oakley/tap/jsq

With cargo

Install Deno and then:

cargo install jsq

Binaries

There are binaries for Linux, MacOS, and Windows attached to each release. Install Deno, download a binary, and make it available in your PATH.