clojure.tools.cli.api — org.clojure/tools.deps.alpha 0.12.985

This api provides functions that can be executed from the Clojure tools using -X:deps.

basis clj

(basis params)

Calculates and returns the runtime basis from a master deps edn map, modifying resolve-deps and make-classpath args as needed.

master-edn - a master deps edn map args - an optional map of arguments to constituent steps, keys: :resolve-args - map of args to resolve-deps, with possible keys: :extra-deps :override-deps :default-deps :threads - number of threads to use during deps resolution :trace - flag to record a trace log :prep-args - map of args to prep-libs! :action - what to do when an unprepped lib is found, one of: :prep - if unprepped, prep :force - prep regardless of whether already prepped :error (default) - don't prep, error :classpath-args - map of args to make-classpath-map, with possible keys: :extra-paths :classpath-overrides

Returns {:basis basis}, which basis is initial deps edn map plus these keys: :resolve-args - the resolve args passed in, if any :classpath-args - the classpath args passed in, if any :libs - lib map, per resolve-deps :classpath - classpath map per make-classpath-map :classpath-roots - vector of paths in classpath order

find-versions clj

(find-versions {:keys [lib tool] :as args})

Find available tool versions given either a lib (with :lib) or existing installed tool (with :tool). If lib, check all registered procurers and print one coordinate per line when found.

git-resolve-tags clj

(git-resolve-tags _)

Resolve git tags in deps.edn git deps to full shas.

mvn-install clj

(mvn-install {:keys [jar pom lib version classifier local-repo] :as opts})

Install a jar and pom to the Maven local cache. The pom file must either be supplied, or generated based on provided lib/version/classifier, or provided inside the jar. The group/artifact/version coordinate will be pulled from the pom source as above.

Required: :jar (reqired) - path to jar file (embedded pom used by default)

Explicit pom options: :pom - path to pom file (pom in jar ignored)

Generated pom options: :lib - qualified symbol like my.org/lib :version - string :classifier - string

Other options: :local-repo (optional) - path to local repo (default = ~/.m2/repository)

Execute ad-hoc: clj -X:deps mvn/install :jar '"foo-1.2.3.jar"'

mvn-pom clj

(mvn-pom {:keys [argmaps]})

Sync or create pom.xml from deps.edn.

Options: :argmaps - vector of aliases to combine into argmaps to resolve-deps and make-classpath

prep clj

(prep {:keys [basis force log] :or {log :info} :as params})

Prep the unprepped libs found in the transitive lib set of basis. If no basis is provided, create and use the default project basis.

Options: :basis - basis to prep. If not provided, use (create-basis nil). :force - flag on whether to force prepped libs to re-prep (default = false) :log - :none, :info (default), or :debug

Returns params modified.

tree clj

(tree opts)

Print deps tree for the current project's deps.edn built from either the current directory deps.edn, or if provided, the trace file.

By default, :format will :print to the console in a human friendly tree. Use :edn mode to print the tree to edn.

In print mode, deps are printed with prefix of either . (included) or X (excluded). A reason code for inclusion/exclusion may be added at the end of the line.

Input options: :file Path to trace.edn file (from clj -Strace) to use in computing the tree

Output mode: :format :print (default) or :edn

Print output mode modifiers: :indent Indent spacing (default = 2) :hide-libs Set of libs to hide as deps (if not top dep), default = #{org.clojure/clojure}