CLI to transform between JSON, EDN and Transit, powered with a minimal query language.
$ bash <(curl -s https://raw.githubusercontent.com/borkdude/jet/master/install)
$ echo '{:a 1}' | jet --to json
{"a":1}
This is a command line tool to transform between JSON, EDN and Transit, powered
with a minimal query language. It runs as a GraalVM binary with fast startup time
which makes it suited for shell scripting. It comes with a query language to do
intermediate transformation. It may seem familiar to users of jq
.
Linux and macOS binaries are provided via brew.
Install:
brew install borkdude/brew/jet
Upgrade:
brew upgrade jet
On Windows you can install using scoop and the scoop-clojure bucket.
Install via the installer script:
$ bash <(curl -s https://raw.githubusercontent.com/borkdude/jet/master/install)
By default this will install into /usr/local/bin
. To change this, provide the directory name:
$ bash <(curl -s https://raw.githubusercontent.com/borkdude/jet/master/install) /tmp
You may also download a binary from Github.
This tool can also be used via the JVM. If you use leiningen, you can put the
following in your .lein/profiles
:
{:user
{:dependencies [[borkdude/jet "0.0.6"]]
:aliases {"jet" ["run" "-m" "jet.main"]}}}
And then call jet
like:
$ echo '["^ ","~:a",1]' | lein jet --from transit --to edn
{:a 1}
jet
supports the following options:
--from
:edn
,transit
orjson
, defaults toedn
--to
:edn
,transit
orjson
, defaults toedn
--keywordize [ <key-fn> ]
: if present, keywordizes JSON keys. The default transformation function iskeyword
unless you provide your own.--pretty
: if present, pretty-prints JSON and EDN output.--edn-reader-opts
: options passed to the EDN reader.--query
: given a jet-lang query, transforms input. See jet-lang docs.--collect
: given separate values, collects them in a vector.--version
: if present, prints current version ofjet
and exits.--interactive [ cmd ]
: if present, starts an interactive shell. An initial command may be provided. See here.
Examples:
$ echo '{"a": 1}' | jet --from json --to edn
{"a" 1}
$ echo '{"a": 1}' | jet --from json --keywordize --to edn
{:a 1}
$ echo '{"my key": 1}' | jet --from json --keywordize '#(keyword (str/replace % " " "_"))' --to edn
{:my_key 1}
$ echo '{"a": 1}' | jet --from json --to transit
["^ ","a",1]
$ echo '[{:a {:b 1}} {:a {:b 2}}]' \
| jet --from edn --to edn --query '(filter (= [:a :b] #jet/lit 1))'
[{:a {:b 1}}]
- Get the latest commit SHA and date for a project from Github:
$ curl -s https://api.github.com/repos/borkdude/clj-kondo/commits \
| jet --from json --keywordize --to edn \
--query '[0 {:sha :sha :date [:commit :author :date]}]'
{:sha "bde8b1cbacb2b44ad2cd57d5875338f0926c8c0b", :date "2019-08-05T21:11:56Z"}
You can enable data readers by passing options to --edn-reader-opts
:
$ echo '#foo{:a 1}' | jet --edn-reader-opts '{:default tagged-literal}'
#foo {:a 1}
$ echo '#foo{:a 1}' | jet --edn-reader-opts "{:readers {'foo (fn [x] [:foo x])}}"
[:foo {:a 1}]
See this blog by Alex Miller for more information on the tagged-literal
function.
Jet supports streaming over multiple values, without reading the entire input into memory:
$ echo '{"a": 1} {"a": 1}' | jet --from json --keywordize --query ':a' --to edn
1
1
When you want to collect multiple values into a vector, you can use --collect
:
$ echo '{"a": 1} {"a": 1}' | lein jet --from json --keywordize --collect --to edn
[{:a 1} {:a 1}]
The --query
option supports an intermediate EDN transformation.
$ echo '{:a 1 :b 2 :c 3}' | jet --query '(select-keys [:a :b])'
{:a 1, :b 2}
$ echo '{:a {:b 1}}' | jet --query '[:a :b]'
1
The query language should be pretty familiar to users of Clojure and jq
. For
more information about the query language, read the docs here.
The jet interactive shell can be started with the --interactive
flag. Optionally you can provide the first command for the shell as an argument:
$ jet --interactive ':jeti/set-val {:a 1}'
$ curl -sL https://api.github.com/repos/clojure/clojure/commits > /tmp/commits.json
$ jet --interactive ':jeti/slurp "/tmp/commits.json" {:format :json}'
Note that a jeti command has to be valid EDN. To see a list of available
commands, type :jeti/help
in the shell:
> :jeti/help
Available commands:
:jeti/set-val {:a 1} : set value.
:jeti/jump "34d4" : jump to a previous state.
:jeti/quit, :jeti/exit : exit this shell.
:jeti/slurp : read a file from disk. Type :jeti/help :jeti/slurp for more details.
:jeti/spit : writes file to disk. Type :jeti/help :jeti/spit for more details.
:jeti/bookmark "name" : save a bookmark.
:jeti/bookmarks : show bookmarks.
:jeti/print-length : set *print-length*
:jeti/print-level : set *print-level*
Sometimes it's useful to reformat REPL output in Emacs to make it more
readable. You can do this by piping the relevant region via jet. Just
put this function somewhere in your Emacs configuration, highlight a
region, and press M-x jet-pretty <enter>
:
(defun jet ()
(interactive)
(shell-command-on-region
(region-beginning)
(region-end)
"jet --pretty --edn-reader-opts '{:default tagged-literal}'"
(current-buffer)
t
"*jet error buffer*"
t))
Passing --edn-reader-opts
ensures that jet will respect any tagged
literals that are particular to your codebase.
Test the JVM version:
script/test
Test the native version:
JET_TEST_ENV=native script/test
You will need leiningen and GraalVM.
script/compile
Copyright © 2019 Michiel Borkent
Distributed under the EPL License, same as Clojure. See LICENSE.