Skip to content

Commit c669505

Browse files
committed
update readme for -T installation and usage
1 parent ea42268 commit c669505

2 files changed

Lines changed: 16 additions & 28 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Changelog
22
===========
33

4-
* next
4+
* 1.1.76 on Dec 12, 2022
55
* Update to tools.deps and other deps
66
* 1.1.68 on Dec 10, 2021
77
* Bump to latest tools.deps.alpha and other deps

README.md

Lines changed: 15 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -11,33 +11,21 @@ tools.deps.graph uses [Graphviz](https://www.graphviz.org/) to generate images.
1111

1212
# Usage
1313

14-
Add tools.deps.graph as an alias in your ~/.clojure/deps.edn so it's available in any project:
14+
Install tools.deps.graph as a Clojure CLI tool so it's available in any project:
1515

16-
```clojure
17-
{...
18-
:aliases
19-
{:graph {:replace-deps {org.clojure/tools.deps.graph {:mvn/version "1.1.68"}}
20-
:main-opts ["-m" "clojure.tools.deps.graph"] ;; deprecated
21-
:ns-default clojure.tools.deps.graph}}}
2216
```
23-
24-
tools.deps.graph supports both older clojure.main invocation (deprecated) and newer exec function invocation (clj -X).
25-
26-
To run with exec in your current project:
27-
28-
```
29-
clj -X:graph graph <options>
17+
clj -Ttools install io.github.clojure/tools.deps.graph '{:git/tag "v1.1.76"}' :as graph
3018
```
3119

32-
Older clojure.main invocation in your current project (use -M for clj 1.10.1.697+, -A for older):
20+
To run the tool in your current project:
3321

3422
```
35-
clj -M:graph <options>
23+
clj -Tgraph graph <options>
3624
```
3725

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

40-
When using -X, options:
28+
When using -T or -X, options:
4129

4230
* `:deps` - Path to deps file (default = "deps.edn")
4331
* `:trace` - Boolean flag to use trace mode (default = false)
@@ -61,59 +49,59 @@ Equivalent clojure.main options:
6149
Show dependency graph for current project:
6250

6351
```
64-
clj -X:graph graph
52+
clj -Tgraph graph
6553
```
6654

6755
Save dependency graph to deps.png for current project:
6856

6957
```
70-
clj -X:graph graph :output '"deps.png"'
58+
clj -Tgraph graph :output '"deps.png"'
7159
```
7260

7361
Show dependency graph for current project with jar sizes:
7462

7563
```
76-
clj -X:graph graph :output '"deps.png"' :size true
64+
clj -Tgraph graph :output '"deps.png"' :size true
7765
```
7866

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

8169
```
82-
clj -X:graph graph :deps '"mydeps.edn"' :output '"mydeps.png"'
70+
clj -Tgraph graph :deps '"mydeps.edn"' :output '"mydeps.png"'
8371
```
8472

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

8775
```
88-
clj -X:graph graph :trace true :output '"trace"'
76+
clj -Tgraph graph :trace true :output '"trace"'
8977
```
9078

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

9381
```
94-
clj -X:graph graph :deps '"mydeps.edn"' :trace true :output '"trace"'
82+
clj -Tgraph graph :deps '"mydeps.edn"' :trace true :output '"trace"'
9583
```
9684

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

10088
```
10189
clj -Strace
102-
clj -X:graph graph :trace-file '"trace.edn"' :output '"trace"'
90+
clj -Tgraph graph :trace-file '"trace.edn"' :output '"trace"'
10391
```
10492

10593
# Release Information
10694

10795
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.
10896

109-
Latest release: 1.1.68
97+
Latest release: 1.1.76
11098

11199
* [All released versions](http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22org.clojure%22%20AND%20a%3A%22tools.deps.graph%22)
112100

113101
[deps.edn](https://clojure.org/guides/deps_and_cli) dependency information:
114102

115103
```
116-
org.clojure/tools.deps.graph {:mvn/version "1.1.68"}
104+
org.clojure/tools.deps.graph {:mvn/version "1.1.76"}
117105
```
118106

119107
# Developer Information
@@ -126,7 +114,7 @@ org.clojure/tools.deps.graph {:mvn/version "1.1.68"}
126114

127115
# Copyright and License
128116

129-
Copyright © 2019-2022 Rich Hickey, Alex Miller, and contributors
117+
Copyright © 2019-2023 Rich Hickey, Alex Miller, and contributors
130118

131119
All rights reserved. The use and
132120
distribution terms for this software are covered by the

0 commit comments

Comments
 (0)