Skip to content

Commit c624de5

Browse files
committed
Document cider-selector
1 parent a89a87a commit c624de5

File tree

1 file changed

+59
-0
lines changed

1 file changed

+59
-0
lines changed

doc/modules/ROOT/pages/usage/misc_features.adoc

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,65 @@ and `cider-ns-reload-all` commands can be used instead. These commands
115115
invoke Clojure's `+(require ... :reload)+` and `+(require
116116
... :reload-all)+` commands at the REPL.
117117

118+
== CIDER Selector
119+
120+
The `cider-selector` (kbd:[C-c M-s]) command allows you to quickly navigate to
121+
important buffers in the context of a Clojure project - e.g. the REPL, the
122+
stacktrace buffer, the doc buffer, the most recently visited Clojure file, etc.
123+
The usage of the command is extremely simple - after invoking you need to type a
124+
single key identifying the target buffer (e.g. `r` for the REPL).
125+
126+
Here's a list of all of `cider-selectors`'s keybindings:
127+
128+
|===
129+
| Keyboard shortcut | Description
130+
131+
| kbd:[c]
132+
| Most recently visited Clojure buffer.
133+
134+
| kbd:[e]
135+
| Most recently visited Emacs Lisp buffer.
136+
137+
| kbd:[r]
138+
| Current REPL buffer or most recently visited REPL buffer.
139+
140+
| kbd:[m]
141+
| `+*nrepl-messages*+` buffer.
142+
143+
| kbd:[x]
144+
| `+*cider-error*+` buffer.
145+
146+
| kbd:[d]
147+
| `+*cider-doc*+` buffer.
148+
149+
| kbd:[p]
150+
| `+*cider-profiler*+` buffer.
151+
152+
| kbd:[s]
153+
| `+*cider-scratch*+` buffer.
154+
155+
| kbd:[q]
156+
| Abort.
157+
158+
| kbd:[h]
159+
| Show help.
160+
|===
161+
162+
[TIP]
163+
====
164+
Any of those keys can be prefixed with a `4` to make the target buffer open in a
165+
different window (as opposed to the current one).
166+
====
167+
168+
You can easily extend the selector with new commands using `def-cider-selector-method`:
169+
170+
[source,lisp]
171+
----
172+
(def-cider-selector-method ?z
173+
"CIDER foo buffer."
174+
cider-foo-buffer)
175+
----
176+
118177
== Browsing the Classpath
119178

120179
You can easily browse the items on your classpath with the command

0 commit comments

Comments
 (0)