Skip to content

Commit 6e8d505

Browse files
committed
update readme
1 parent fb3fa6c commit 6e8d505

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,34 @@ This can be handy for debugging; if you find that in fact ExplicitImports thinks
113113

114114
## Command-line usage
115115

116+
### CLI app
117+
118+
ExplicitImports provides an experimental CLI application using the brand-new "apps" functionality from Pkg, available with Julia v1.12.
119+
120+
If you use [juliaup](https://github.com/JuliaLang/juliaup) you can install Julia v1.12 with `juliaup add nightly`, and then run
121+
122+
```sh
123+
julia +nightly --startup-file=no -e 'using Pkg; Pkg.activate(temp=true); Pkg.Apps.add("ExplicitImports")'
124+
```
125+
to install a CLI executable `explicit-imports-jl` to the bin directory in your Julia depot (`~/.julia` by default). You will likely need to add your bin directory to your PATH, e.g.
126+
127+
```sh
128+
export PATH="/Users/eph/.julia/bin:$PATH"
129+
```
130+
131+
which can go in a shell startup script (e.g. `~/.bashrc` or `~/.zshrc`).
132+
133+
134+
Then you can run e.g.
135+
136+
```sh
137+
explicit-imports-jl --help
138+
```
139+
140+
from the command-line to run the app and print the help.
141+
142+
### `main` function
143+
116144
ExplicitImports provides a `main` function to facilitate using ExplicitImports directly from the command line. For example,
117145

118146
```bash

0 commit comments

Comments
 (0)