Clojure CLI Built-in commands

clojure without any other arguments will run a REPL with a basic terminal prompt.

clj is a wrapper script for the clojure command (rlwrap required) to add command history to the basic REPL prompt.

clojure -T:deps to run one of several built-in commands to help work with Clojure CLI projects and libraries.

clojure --help list the available commands.

:deps alias

The :deps aliases provides tools for managing library dependencies.

The Clojure CLI -X flag is used to call these tools via clojure.exec and take key value pairs as arguments

Aliases	Description
clojure -X:deps list	List full transitive deps set and licenses
clojure -X:deps tree	download dependencies & print dependency tree, indenting libraries that are dependencies of dependencies
clojure -X:deps find-versions	Find available versions of a given library (domain/name)
clojure -X:deps prep	Prepare all unprepped libs in the dep tree
clojure -X:deps mvn-pom	Generate or update pom.xml with deps and paths
clojure -X:deps mvn-install :jar '"/path/to.jar"'	install a given jar file into the local maven repository, eg. ~/.m2/repository
clojure -X:deps git-resolve-tags	update deps.edn git based dependencies that used tags with the equivalent SHA commit values

tools.deps.alpha API Reference

Libraries are downloaded if they are not in the local Maven cache, e.g. $HOME/.m2/repository, so on first run a command may take a little time.

Use Clojure CLI -P flag to download libraries

clojure -P is the recommended way to download library dependencies as it does not run any other commands

The -P flag can be used with aliases to download libraries for building and testing a Clojure project, especially useful for a cached environment like Docker.

clojure -P -M:dev/reloaded:project/build

List Library dependencies

List library depenencies of a project, including the library version and software licence for each library.

The list includes transitive dependencies, library dependencies of the project library dependencies.

The :aliases '[:alias/name(s)]' argument will also list library dependencies from a given alias, either project alias or user alias.

clojure -X:deps list

Dependency list from Practicalli Service project template

 ❯ clojure -X:deps list
aero/aero 1.1.6  (MIT)
amalloy/ring-buffer 1.3.1  (EPL-1.0)
aysylu/loom 1.0.2  (EPL-1.0)
borkdude/dynaload 0.2.2  (EPL-1.0)
borkdude/edamame 0.0.18  (EPL-1.0)
com.bhauman/spell-spec 0.1.2  (EPL-1.0)
com.brunobonacci/mulog 0.9.0  (Apache-2.0)
com.brunobonacci/mulog-adv-console 0.9.0  (Apache-2.0)
com.brunobonacci/mulog-json 0.9.0  (Apache-2.0)
com.cnuernber/charred 1.010
com.cognitect/transit-clj 1.0.324  (Apache-2.0)
com.cognitect/transit-java 1.0.343  (Apache-2.0)
com.fasterxml.jackson.core/jackson-annotations 2.12.1  (Apache-2.0)
com.fasterxml.jackson.core/jackson-core 2.12.1  (Apache-2.0)
com.fasterxml.jackson.core/jackson-databind 2.12.1  (Apache-2.0)
com.fasterxml.jackson.datatype/jackson-datatype-jsr310 2.12.0  (Apache-2.0)
com.google.javascript/closure-compiler v20151015  (Apache-2.0)
com.googlecode.json-simple/json-simple 1.1.1  (Apache-2.0)
commons-codec/commons-codec 1.15  (Apache-2.0)
commons-fileupload/commons-fileupload 1.4  (Apache-2.0)
commons-io/commons-io 2.6  (Apache-2.0)
crypto-equality/crypto-equality 1.0.0  (EPL-1.0)
crypto-random/crypto-random 1.2.0  (EPL-1.0)
expound/expound 0.9.0  (EPL-1.0)
fipp/fipp 0.6.25  (EPL-1.0)
http-kit/http-kit 2.6.0  (Apache-2.0)
javax.xml.bind/jaxb-api 2.3.0  (CDDL 1.1)
lambdaisland/deep-diff 0.0-47  (EPL-1.0)
meta-merge/meta-merge 1.0.0  (EPL-1.0)
metosin/jsonista 0.3.1  (EPL-1.0)
metosin/malli 0.7.5  (EPL-2.0)
metosin/muuntaja 0.6.8  (EPL-1.0)
metosin/reitit 0.5.13  (EPL-1.0)
metosin/reitit-core 0.5.18  (EPL-1.0)
metosin/reitit-dev 0.5.18  (EPL-1.0)
metosin/reitit-frontend 0.5.13  (EPL-1.0)
metosin/reitit-http 0.5.13  (EPL-1.0)
metosin/reitit-interceptors 0.5.13  (EPL-1.0)
metosin/reitit-malli 0.5.13  (EPL-1.0)
metosin/reitit-middleware 0.5.13  (EPL-1.0)
metosin/reitit-ring 0.5.13  (EPL-1.0)
metosin/reitit-schema 0.5.13  (EPL-1.0)
metosin/reitit-sieppari 0.5.13  (EPL-1.0)
metosin/reitit-spec 0.5.13  (EPL-1.0)
metosin/reitit-swagger 0.5.13  (EPL-1.0)
metosin/reitit-swagger-ui 0.5.13  (EPL-1.0)
metosin/ring-swagger-ui 3.36.0  (EPL-1.0)
metosin/schema-tools 0.12.3  (EPL-1.0)
metosin/sieppari 0.0.0-alpha13  (EPL-1.0)
metosin/spec-tools 0.10.5  (EPL-1.0)
mvxcvi/arrangement 2.0.0  (Public Domain)
mvxcvi/puget 1.1.2  (Public Domain)
org.clojure/clojure 1.11.1  (EPL-1.0)
org.clojure/clojurescript 1.7.170  (EPL-1.0)
org.clojure/core.rrb-vector 0.0.14  (EPL-1.0)
org.clojure/core.specs.alpha 0.2.62  (EPL-1.0)
org.clojure/data.json 0.2.6  (EPL-1.0)
org.clojure/data.priority-map 0.0.5  (EPL-1.0)
org.clojure/google-closure-library 0.0-20151016-61277aea  (Apache-2.0)
org.clojure/google-closure-library-third-party 0.0-20151016-61277aea  (Apache-2.0)
org.clojure/java.classpath 1.0.0  (EPL-1.0)
org.clojure/spec.alpha 0.3.218  (EPL-1.0)
org.clojure/test.check 1.1.1  (EPL-1.0)
org.clojure/tools.namespace 1.3.0  (EPL-1.0)
org.clojure/tools.reader 1.3.6  (EPL-1.0)
org.javassist/javassist 3.18.1-GA  (MPL 1.1)
org.mozilla/rhino 1.7R5  (Mozilla Public License, Version 2.0)
org.msgpack/msgpack 0.6.12  (Apache-2.0)
party.donut/system 0.0.202 
prismatic/schema 1.1.12  (EPL-1.0)
ring/ring-codec 1.1.3  (MIT)
ring/ring-core 1.9.1  (MIT)
tailrecursion/cljs-priority-map 1.2.1  (EPL-1.0)
tech.droit/clj-diff 1.0.1  (EPL-1.0)

Use the :aliases '[:alias/name(s)]' option to also include the dependencies from a project or user alias. Showing the dependencies from an aliase can useful to identify conflicting dependencies when using an alias (unlikely but it could happen).

clojure -X:deps list :aliases '[:dev/reloaded]'

Dependency list from project and Practicalli :dev/reloaded alias

❯ clojure -X:deps list :aliases '[:dev/reloaded]'
aero/aero 1.1.6  (MIT)
amalloy/ring-buffer 1.3.1  (EPL-1.0)
clj-commons/clj-yaml 1.0.27  (EPL-1.0)
com.brunobonacci/mulog 0.9.0  (Apache-2.0)
com.cognitect/transit-clj 1.0.333  (Apache-2.0)
com.cognitect/transit-cljs 0.8.280  (Apache-2.0)
com.cognitect/transit-java 1.0.371  (Apache-2.0)
com.cognitect/transit-js 0.8.874  (Apache-2.0)
com.fasterxml.jackson.core/jackson-core 2.14.2  (Apache-2.0)
com.google.code.gson/gson 2.10.1  (Apache-2.0)
com.googlecode.json-simple/json-simple 1.1.1  (Apache-2.0)
com.nextjournal/beholder 1.0.2 
criterium/criterium 0.4.6  (EPL-1.0)
djblue/portal 0.49.0  (MIT)
expound/expound 0.9.0  (EPL-1.0)
fipp/fipp 0.6.26  (EPL-1.0)
hawk/hawk 0.2.11  (EPL-1.0)
http-kit/http-kit 2.7.0  (Apache-2.0)
io.methvin/directory-watcher 0.17.3  (Apache-2.0)
javax.activation/javax.activation-api 1.2.0  (CDDL/GPLv2+CE)
javax.xml.bind/jaxb-api 2.4.0-b180830.0359  (CDDL 1.1)
lambdaisland/clj-diff 1.4.78  (EPL-1.0)
lambdaisland/deep-diff2 2.10.211  (EPL-1.0)
lambdaisland/kaocha 1.87.1366  (EPL-1.0)
lambdaisland/tools.namespace 0.3.256  (EPL-1.0)
meta-merge/meta-merge 1.0.0  (EPL-1.0)
mvxcvi/arrangement 2.1.0  (Public Domain)
net.incongru.watchservice/barbary-watchservice 1.0  (GPLv2 + Classpath Exception)
net.java.dev.jna/jna 5.12.1  (LGPL-2.1-or-later)
org.clojure/clojure 1.11.1  (EPL-1.0)
org.clojure/core.rrb-vector 0.1.2  (EPL-1.0)
org.clojure/core.specs.alpha 0.2.62  (EPL-1.0)
org.clojure/data.json 2.4.0  (EPL-1.0)
org.clojure/java.classpath 1.0.0  (EPL-1.0)
org.clojure/spec.alpha 0.3.218  (EPL-1.0)
org.clojure/test.check 1.1.1  (EPL-1.0)
org.clojure/tools.cli 1.0.219  (EPL-1.0)
org.clojure/tools.namespace 1.4.4  (EPL-1.0)
org.clojure/tools.reader 1.3.6  (EPL-1.0)
org.clojure/tools.trace 0.7.11  (EPL-1.0)
org.flatland/ordered 1.15.11  (EPL-1.0)
org.javassist/javassist 3.18.1-GA  (MPL 1.1)
org.msgpack/msgpack 0.6.12  (Apache-2.0)
org.slf4j/slf4j-api 2.0.9  (MIT)
org.slf4j/slf4j-nop 2.0.9  (MIT)
org.tcrawley/dynapath 1.1.0  (EPL-1.0)
org.yaml/snakeyaml 2.1  (Apache-2.0)
progrock/progrock 0.1.2  (EPL-1.0)
slingshot/slingshot 0.12.2  (EPL-1.0)

The :aliases option can be used to inspect the dependencies of a user alias, listing only dependencies from the specified aliases when run outside of a Clojure project.

Dependency list from Practicalli :repl/rebel alias only

❯ clojure -X:deps list :aliases '[:repl/rebel]'
cider/cider-nrepl 0.42.1  (EPL-1.0)
cider/orchard 0.18.0  (EPL-1.0)
cljfmt/cljfmt 0.5.7  (EPL-1.0)
com.bhauman/rebel-readline 0.1.4  (EPL-1.0)
com.google.javascript/closure-compiler v20151216  (Apache-2.0)
compliment/compliment 0.3.6  (EPL-1.0)
mx.cider/logjam 0.1.1  (EPL-1.0)
nrepl/nrepl 1.1.0  (EPL-1.0)
org.clojure/clojure 1.11.1  (EPL-1.0)
org.clojure/clojurescript 1.7.228  (EPL-1.0)
org.clojure/core.specs.alpha 0.2.62  (EPL-1.0)
org.clojure/data.json 0.2.6  (EPL-1.0)
org.clojure/google-closure-library 0.0-20151016-61277aea  (Apache-2.0)
org.clojure/google-closure-library-third-party 0.0-20151016-61277aea  (Apache-2.0)
org.clojure/spec.alpha 0.3.218  (EPL-1.0)
org.clojure/tools.reader 1.0.0-alpha4  (EPL-1.0)
org.fusesource.jansi/jansi 1.16  (Apache-2.0)
org.jline/jline-reader 3.5.1  (The BSD License)
org.jline/jline-terminal 3.5.1  (The BSD License)
org.jline/jline-terminal-jansi 3.5.1  (The BSD License)
org.mozilla/rhino 1.7R5  (Mozilla Public License, Version 2.0)
rewrite-clj/rewrite-clj 0.5.2  (MIT)
rewrite-cljs/rewrite-cljs 0.4.3  (MIT)

Dependency tree

Show a tree hieracthy of project library dependencies, including the library name and version used.

The tree includes transitive dependencies, library dependencies of the project library dependencies.

The :aliases '[:alias/name(s)]' argument will also list library dependencies from a given alias, either project alias or user alias.

clojure -X:deps tree

Dependency list from Practicalli Service project template

❯ clojure -X:deps tree
org.clojure/clojure 1.11.1
  . org.clojure/spec.alpha 0.3.218
  . org.clojure/core.specs.alpha 0.2.62
http-kit/http-kit 2.6.0
metosin/reitit 0.5.13
  X metosin/reitit-core 0.5.13 :superseded
    X meta-merge/meta-merge 1.0.0 :parent-omitted
  X metosin/reitit-dev 0.5.13 :use-top
  . metosin/reitit-spec 0.5.13
    X metosin/reitit-core 0.5.13 :older-version
    . metosin/spec-tools 0.10.5
      X org.clojure/spec.alpha 0.2.187 :older-version
  . metosin/reitit-malli 0.5.13
    X metosin/reitit-core 0.5.13 :older-version
    X metosin/malli 0.3.0 :older-version
  . metosin/reitit-schema 0.5.13
    X metosin/reitit-core 0.5.13 :older-version
    . metosin/schema-tools 0.12.3
      . prismatic/schema 1.1.12
  . metosin/reitit-ring 0.5.13
    X metosin/reitit-core 0.5.13 :older-version
    . ring/ring-core 1.9.1
      . ring/ring-codec 1.1.3
        . commons-codec/commons-codec 1.15
      . commons-io/commons-io 2.6
      . commons-fileupload/commons-fileupload 1.4
        X commons-io/commons-io 2.2 :older-version
      . crypto-random/crypto-random 1.2.0
        X commons-codec/commons-codec 1.6 :older-version
      . crypto-equality/crypto-equality 1.0.0
  . metosin/reitit-middleware 0.5.13
    . metosin/reitit-ring 0.5.13
    . lambdaisland/deep-diff 0.0-47
      . mvxcvi/puget 1.1.2
        X mvxcvi/arrangement 1.2.0 :older-version
        X fipp/fipp 0.6.17 :older-version
      X fipp/fipp 0.6.17 :older-version
      . org.clojure/core.rrb-vector 0.0.14
      . tech.droit/clj-diff 1.0.1
      X mvxcvi/arrangement 1.2.0 :older-version
    . metosin/muuntaja 0.6.8
      . metosin/jsonista 0.3.1
      . com.cognitect/transit-clj 1.0.324
        . com.cognitect/transit-java 1.0.343
          X com.fasterxml.jackson.core/jackson-core 2.8.7 :older-version
          . org.msgpack/msgpack 0.6.12
            . com.googlecode.json-simple/json-simple 1.1.1
            . org.javassist/javassist 3.18.1-GA
          X commons-codec/commons-codec 1.10 :older-version
          . javax.xml.bind/jaxb-api 2.3.0
    . metosin/spec-tools 0.10.5
  . metosin/reitit-http 0.5.13
    X metosin/reitit-core 0.5.13 :older-version
    . metosin/reitit-ring 0.5.13
  . metosin/reitit-interceptors 0.5.13
    . metosin/reitit-ring 0.5.13
    . lambdaisland/deep-diff 0.0-47
    . metosin/muuntaja 0.6.8
  . metosin/reitit-swagger 0.5.13
    X metosin/reitit-core 0.5.13 :older-version
  . metosin/reitit-swagger-ui 0.5.13
    . metosin/reitit-ring 0.5.13
    . metosin/jsonista 0.3.1
      X com.fasterxml.jackson.core/jackson-core 2.12.0 :older-version
      X com.fasterxml.jackson.core/jackson-databind 2.12.0 :older-version
      . com.fasterxml.jackson.datatype/jackson-datatype-jsr310 2.12.0
        X com.fasterxml.jackson.core/jackson-annotations 2.12.0 :older-version
        X com.fasterxml.jackson.core/jackson-core 2.12.0 :older-version
        X com.fasterxml.jackson.core/jackson-databind 2.12.0 :older-version
    . metosin/ring-swagger-ui 3.36.0
  . metosin/reitit-frontend 0.5.13
    X metosin/reitit-core 0.5.13 :older-version
  . metosin/reitit-sieppari 0.5.13
    X metosin/reitit-core 0.5.13 :older-version
    . metosin/sieppari 0.0.0-alpha13
  . com.fasterxml.jackson.core/jackson-core 2.12.1
  . com.fasterxml.jackson.core/jackson-databind 2.12.1
    . com.fasterxml.jackson.core/jackson-annotations 2.12.1
    . com.fasterxml.jackson.core/jackson-core 2.12.1
metosin/reitit-dev 0.5.18
  . metosin/reitit-core 0.5.18 :newer-version
    . meta-merge/meta-merge 1.0.0
  . com.bhauman/spell-spec 0.1.2
  . expound/expound 0.9.0
  . fipp/fipp 0.6.25
com.brunobonacci/mulog 0.9.0
  . amalloy/ring-buffer 1.3.1
com.brunobonacci/mulog-adv-console 0.9.0
  X com.brunobonacci/mulog 0.9.0 :use-top
  . com.brunobonacci/mulog-json 0.9.0
    X com.brunobonacci/mulog 0.9.0 :use-top
    . com.cnuernber/charred 1.010
aero/aero 1.1.6
party.donut/system 0.0.202
  . aysylu/loom 1.0.2
    . org.clojure/data.priority-map 0.0.5
    . tailrecursion/cljs-priority-map 1.2.1
      . org.clojure/clojurescript 1.7.170
        . com.google.javascript/closure-compiler v20151015
        . org.clojure/google-closure-library 0.0-20151016-61277aea
          . org.clojure/google-closure-library-third-party 0.0-20151016-61277aea
        . org.clojure/data.json 0.2.6
        . org.mozilla/rhino 1.7R5
        X org.clojure/tools.reader 0.10.0-alpha3 :older-version
  . org.clojure/tools.namespace 1.3.0
    . org.clojure/java.classpath 1.0.0
    . org.clojure/tools.reader 1.3.6
  . metosin/malli 0.7.5
    . borkdude/dynaload 0.2.2
    . borkdude/edamame 0.0.18
      X org.clojure/tools.reader 1.3.4 :older-version
    . org.clojure/test.check 1.1.1
    X fipp/fipp 0.6.24 :older-version
    . mvxcvi/arrangement 2.0.0

Use the :aliases option with the Clojure CLI in the root of a project to show library dependencies for the project and the :dev/reloaded alias which could be useful if there are library conflicts when using an alias (unlikely but it could happen).

clojure -X:deps tree :aliases '[:dev/reloaded]'

The :aliases option can be used to inspect the dependencies of a user alias, listing only dependencies from the specified aliases when run outside of a Clojure project.

Dependency list from Practicalli :repl/rebel alias only

 ❯ clojure -X:deps tree :aliases '[:repl/rebel]'
org.clojure/clojure 1.11.1
  . org.clojure/spec.alpha 0.3.218
  . org.clojure/core.specs.alpha 0.2.62
nrepl/nrepl 1.1.0
cider/cider-nrepl 0.42.1
  X nrepl/nrepl 1.0.0 :use-top
  . cider/orchard 0.18.0
  . mx.cider/logjam 0.1.1
com.bhauman/rebel-readline 0.1.4
  . org.jline/jline-reader 3.5.1
    . org.jline/jline-terminal 3.5.1
  . org.jline/jline-terminal 3.5.1
  . org.jline/jline-terminal-jansi 3.5.1
    . org.fusesource.jansi/jansi 1.16
    . org.jline/jline-terminal 3.5.1
  . cljfmt/cljfmt 0.5.7
    . org.clojure/tools.reader 1.0.0-alpha4
    . rewrite-clj/rewrite-clj 0.5.2
      X org.clojure/tools.reader 0.10.0 :older-version
    . rewrite-cljs/rewrite-cljs 0.4.3
      . org.clojure/clojurescript 1.7.228
        . com.google.javascript/closure-compiler v20151216
        . org.clojure/google-closure-library 0.0-20151016-61277aea
          . org.clojure/google-closure-library-third-party 0.0-20151016-61277aea
        . org.clojure/data.json 0.2.6
        . org.mozilla/rhino 1.7R5
        X org.clojure/tools.reader 1.0.0-alpha1 :older-version
      X org.clojure/tools.reader 1.0.0-alpha3 :older-version
  . compliment/compliment 0.3.6

Local library install

Add a jar file for a library to the local Maven repository, e.g. ~/.m2/repository, making that library accessible to all other local projects.

clojure -X:deps mvn-install :jar '"/path/to.jar"'`

Find Library Versions

Find the available versions of a given library in the form domain/library-name (domain is typically the company name or Git Service user or organisation name).

clojure -X:deps find-versions :lib clojure.java-time/clojure.java-time

Prepare Source dependencies

Some dependencies will require a preparation step before they can be used on the classpath.

Projects that require preparation would have a configuration of the form:

Example

{:paths ["src" "target/classes"]
 :deps/prep-lib {:alias :build
                 :fn compile
                 :ensure "target/classes"}}

Including the top-level key :deps/prep-lib tells the tools.deps classpath construction that something extra is needed to prepare this lib and that can be performed by invoking the compile function in the :build alias. Once the prepare step has been done, it should create the path "target/classes" and that can be checked for completion.

Add a library dependency as with any other library (git or local/root):

{:deps {practicalli/library-name {:local/root "../needs-prep"}
        practicalli/library-name {:git/sha "../needs-prep"}}}

:deps prep will built the library of any dependency that requires it

clojure -X:deps prep

POM file

Generate or update pom.xml with deps and paths

clojure -X:deps mvn-pom

Resolve Git tags

-X:deps git-resolve-tags updates git based dependencies in the project deps.edn file which use :git/tags key to the equivalent SHA commit values in the :git/sha key

clojure -X:deps git-resolve-tags

References

tools.deps and cli guide clojure.main guide

clojure.main API Reference tools.deps.alpha API Reference