From f52dae167a066aa948f779e50d164ee00a41e906 Mon Sep 17 00:00:00 2001 From: Alex Miller Date: Mon, 20 Nov 2023 09:22:25 -0600 Subject: [PATCH] update reference for other programs --- content/reference/deps_and_cli.adoc | 29 +++++++++++++++++++++++++---- 1 file changed, 25 insertions(+), 4 deletions(-) diff --git a/content/reference/deps_and_cli.adoc b/content/reference/deps_and_cli.adoc index c6a05f1f..c78b2ff4 100644 --- a/content/reference/deps_and_cli.adoc +++ b/content/reference/deps_and_cli.adoc @@ -507,13 +507,26 @@ There are some options that can be provided to `clj` that short circuit normal e * `-Sdescribe` - print environment and command parsing info as data * `-Spath` - compute classpath and echo to stdout only -The `:deps` alias is built into the root deps.edn and provides a default namespace with several additional programs: +The `:deps` alias is built into the root deps.edn and provides a default namespace with several additional programs described in the next sections. + +=== Dependency tree or list + +These programs are provided to see the dependencies used by your program: -* `-X:deps tree` - print dependency tree (also see <>) * `-X:deps list` - print dependency list and license information +* `-X:deps tree` - print dependency tree (also see <>) + +The `list` view shows a sorted list of all dependencies and selected versions and their licenses (if it can be found programatically). See https://clojure.github.io/tools.deps.cli/clojure.tools.deps.cli.api-api.html#clojure.tools.deps.cli.api/list[API docs] for more. + +The `tree` view shows all dependencies in the <> tree and explains why a version was selected or not. See https://clojure.github.io/tools.deps.cli/clojure.tools.deps.cli.api-api.html#clojure.tools.deps.cli.api/tree[API docs] for more. + +=== Alias list + +This program is used to print all aliases available in the current deps environment: + * `-X:deps aliases` - print all aliases available in the current deps environment -* `-X:deps mvn-pom` - generate (or update an existing) pom.xml with deps and paths -* `-X:deps git-resolve-tags` - resolve git coordinate tags to shas and update deps.edn + +See https://clojure.github.io/tools.deps.cli/clojure.tools.deps.cli.api-api.html#clojure.tools.deps.cli.api/aliases[API docs] for more. === Help functions @@ -638,6 +651,14 @@ As mentioned above, edn strings must be in double quotes, and then single-quoted A pom file must be either provided explicitly, generated from :lib/:version, or found inside the .jar file (the default). +=== Generate Maven pom + +Use the following program to generate or update an existing pom.xml with the deps and paths from your project: + +* `-X:deps mvn-pom` - generate (or update an existing) pom.xml with deps and paths + +See https://clojure.github.io/tools.deps.cli/clojure.tools.deps.cli.api-api.html#clojure.tools.deps.cli.api/mvn-pom[API docs] for more. + = Procurers Dependency coordinates are interpreted by procurers, which understand a particular coordinate type and know how to find dependencies and download artifacts for a library. The Clojure CLI currently suports the folllowing procurers: `mvn`, `local`, and `git`. The underlying tools.deps library supports procurer extensions when used as a library.