Skip to content

Commit 3906cae

Browse files
install: add user config location environment variables
Enhance install description
1 parent 53b5a39 commit 3906cae

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

docs/install/clojure-cli.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -100,12 +100,19 @@ Clojure CLI automatically downloads required library dependencies, including the
100100
101101
## Practicalli Clojure CLI Config
102102

103-
Add a wide range of community tools to extend the capabilities of Clojure CLI via the aliases contained within Practicalli Clojure CLI configuration.
103+
Add a wide range of community tools to extend the capabilities of Clojure CLI via the aliases.
104104

105-
Fork or clone [:fontawesome-solid-book-open: Practicalli Clojure CLI Config](https://github.com/practicalli/clojure-cli-config){target=_blank} GitHub repository, first removing the `$XDG_CONFIG_HOME/clojure` and `$HOME/.clojure` directory if they exist.
105+
Clone [:fontawesome-solid-book-open: Practicalli Clojure CLI Config](https://github.com/practicalli/clojure-cli-config){target=_blank} GitHub repository, first removing the `$XDG_CONFIG_HOME/clojure` and `$HOME/.clojure` directory if they exist.
106106

107-
!!! INFO "Practicalli recommends using FreeDesktop XDG configuration locations"
108-
Practically recommends setting `XDG_CONFIG_HOME` to the `.config` directory, to avoid creating another dot directory in the root of the user account.
107+
??? INFO "User configuration locations"
108+
If `XDG_CONFIG_HOME` environment variable is set, then the user configuration is `$XDG_CONFIG_HOME/clojure/deps.edn`
109+
110+
Otherwise the user configuration is `$HOME/.clojure/deps.edn`.
111+
112+
`CLJ_CONFIG` environment variable can be used to set a custom location, overriding any other location.
113+
114+
!!! HINT "Practicalli recommends FreeDesktop XDG location"
115+
Practically recommends setting `XDG_CONFIG_HOME` to the `.config` directory to simplify versioning of configuration.
109116

110117
Configure `~/.bashrc` for the bash shell
111118
```shell title="Bash .bashrc file"
@@ -182,6 +189,8 @@ Pressing the ++arrow-up++ and ++arrow-down++ keys will scroll through the code p
182189
`rlwrap` is available with most Linux systems. Look for install instructions by searching for rlwrap in a web browser or build from source from the [:globe_with_meridians: rlwrap GitHub repository](https://github.com/hanslub42/rlwrap).
183190

184191
!!! HINT "Use Rebel Readline for a rich terminal UI experience"
185-
[:fontawesome-solid-book-open: rebel readline](/clojure/clojure-cli/repl/) provides a auto-completion, documentation, signature help and multi-line editing all within a terminal UI, providing a much richer experience than the `clj` wrapper and `rlwrap`.
192+
[:fontawesome-solid-book-open: rebel readline](/clojure/clojure-cli/repl/) is an advanced readline tool providing auto-completion, documentation, signature help and multi-line editing, all within a terminal UI
193+
194+
Rebel is a much richer experience than the `clj` wrapper with `rlwrap`. Rebel should not be used with `clj`.
186195

187196
Rebel Readline is part of the [Practicalli Clojure CLI config](#practicalli-clojure-cli-config).

0 commit comments

Comments
 (0)