Skip to content

Commit 0eecde8

Browse files
committed
Doc changes for a better 0.2.0 announcement.
1 parent 4325402 commit 0eecde8

2 files changed

Lines changed: 13 additions & 5 deletions

File tree

‎README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# clojure-cli.repl
22

33
A terminal REPL for the Clojure CLI that you can use on its own, with multi-line
4-
editing, structural editing, completion, inline eval, doc lookup, and a data inspector. You
5-
can also use it with your editor, where evaluations sent from the editor show in
6-
the terminal with their output, ready to inspect.
4+
editing, [structural editing](doc/editing.md), [completion](doc/configuration.md#completion), inline eval, doc lookup, and a
5+
[data inspector](doc/inspector.md). You can also use it [with your editor](doc/editors.md), where evaluations sent
6+
from the editor show in the terminal with their output, ready to inspect.
77

88
## Try it
99

‎doc/configuration.md‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,16 @@ The aliases and refers defined here will always be available. The REPL requires
100100
in the starting namespace and again in each namespace it enters. Libspecs resolve on
101101
the server classpath, which includes the config's [user code](#user-code) and [dependencies](#dependencies).
102102

103+
## Completion
104+
105+
TAB completes vars, namespaces, keywords, and Java classes and methods. To also
106+
complete local bindings, add compliment to the server:
107+
108+
```clojure
109+
;; .cljconf/org.clojure/clojure-cli.repl/deps.edn
110+
{:aliases {:clojure-cli.repl/server {:extra-deps {compliment/compliment {:mvn/version "0.8.2"}}}}}
111+
```
112+
103113
## Init
104114

105115
`:init` names a function of no arguments. The server calls it once at startup,
@@ -142,5 +152,3 @@ are used to target one process.
142152
:aliases {:clojure-cli.repl/client {:extra-deps {...}}
143153
:clojure-cli.repl/server {:extra-deps {compliment/compliment {:mvn/version "0.8.2"}}}}}
144154
```
145-
146-
For example, compliment on the server adds local bindings to TAB completion.

0 commit comments

Comments
 (0)