Skip to content

Latest commit

 

History

History
126 lines (85 loc) · 3.92 KB

README.md

File metadata and controls

126 lines (85 loc) · 3.92 KB
Raw

tools.deps.graph

A tool for making deps.edn dependency graphs.

Deps

Dependencies

tools.deps.graph uses Graphviz to generate images. You can find a list of platform-specific installations at https://graphviz.gitlab.io/download/.

Usage

Install tools.deps.graph as a Clojure CLI tool so it's available in any project:

clj -Ttools install io.github.clojure/tools.deps.graph '{:git/tag "v1.1.90"}' :as graph

To run the tool in your current project:

clj -Tgraph graph <options>

If no options are provided, tools.deps.graph will create a dependency graph for the current project and display it. Ctrl-C to quit.

When using -T or -X, options:

  • :deps - Path to deps file (default = "deps.edn")
  • :trace - Boolean flag to use trace mode (default = false)
  • :trace-file - Path to trace.edn file to read
  • :output - Output file path
  • :trace-omit - Collection of lib symbols to omit in trace output
  • :size - Boolean flag to include sizes in images (default = false)

Equivalent clojure.main options:

  • -d DEPSFILE - deps.edn file to read, default=deps.edn
  • -t - Trace mode, will output one image per expansion step
  • -f TRACEFILE - Trace file mode - read trace file, don't use deps.edn file
  • -o FILE - Output file, in trace mode, required and will create N images with this as a prefix
  • -a - Concatenated alias names to enable when reading deps file
  • --trace-omit - Comma-delimited list of libs to skip in trace images"
  • --size- Add jar size info to dep graph"

Examples

Show dependency graph for current project:

clj -Tgraph graph

Save dependency graph to deps.png for current project:

clj -Tgraph graph :output '"deps.png"'

Show dependency graph for current project with jar sizes:

clj -Tgraph graph :output '"deps.png"' :size true

Read mydeps.edn, create deps graph, output image to mydeps.png:

clj -Tgraph graph :deps '"mydeps.edn"' :output '"mydeps.png"'

Read deps.edn, trace expansion, output steps as trace100.png, trace101.png, ... :

clj -Tgraph graph :trace true :output '"trace"'

Read mydeps.edn, trace expansion, output trace100.png, ... :

clj -Tgraph graph :deps '"mydeps.edn"' :trace true :output '"trace"'

Use -Strace to output a trace.edn file. Read trace.edn file, output trace100.png, ...

clj -Strace
clj -Tgraph graph :trace-file '"trace.edn"' :output '"trace"'

Release Information

This project follows the version scheme MAJOR.MINOR.COMMITS where MAJOR and MINOR provide some relative indication of the size of the change, but do not follow semantic versioning. In general, all changes endeavor to be non-breaking (by moving to new names rather than by breaking existing names). COMMITS is an ever-increasing counter of commits since the beginning of this repository.

Latest release: 1.1.90

deps.edn dependency information:

org.clojure/tools.deps.graph {:mvn/version "1.1.90"}

Developer Information

Copyright and License

Copyright © 2019-2023 Rich Hickey, Alex Miller, and contributors

All rights reserved. The use and distribution terms for this software are covered by the Eclipse Public License 1.0 which can be found in the file epl-v10.html at the root of this distribution. By using this software in any fashion, you are agreeing to be bound by the terms of this license. You must not remove this notice, or any other, from this software.