1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
|
!!! Note
Because connections map one-to-one to REPL buffers, for the purpose of this
section we use "REPL" and "connection" interchangeably.
## Sessions
CIDER maintains a grouped view of opened connections through [Sesman]
sessions. Each session is a collection of connections which share the same nREPL
server.
Start new sessions with
- <kbd>C-c C-x j j</kbd> `cider-jack-in-clj`
- <kbd>C-c C-x j s</kbd> `cider-jack-in-cljs`
- <kbd>C-c C-x j m</kbd> `cider-jack-in-clj&cljs`
- <kbd>C-c C-x c j</kbd> `cider-connect-clj`
- <kbd>C-c C-x c s</kbd> `cider-connect-cljs`
- <kbd>C-c C-x c m</kbd> `cider-connect-clj&cljs`
Add new REPLs to the current session with
- <kbd>C-c C-x s j</kbd> `cider-connect-sibling-clj`
- <kbd>C-c C-x s s</kbd> `cider-connect-sibling-cljs`
Session life-cycle management commands live on the [Sesman] map (<kbd>C-c
C-s</kbd>)
- <kbd>C-c C-s s</kbd> `sesman-start`
- <kbd>C-c C-s r</kbd> `sesman-restart`
- <kbd>C-c C-s q</kbd> `sesman-quit`
The command `sesman-start` wraps around all of the aforementioned `jack-in` and
`connect` commands. You can also invoke same functionality with <kbd>M-x</kbd>
`cider` or <kbd>C-c M-x</kbd>.
To quit or restart individual connections use cider commands
- <kbd>C-c C-q</kbd> `cider-quit`
- <kbd>C-c M-r</kbd> `cider-restart`
## Context Links
Sessions can be linked to contexts (projects, directories and buffers)
- <kbd>C-c C-s b</kbd> `sesman-link-with-buffer`
- <kbd>C-c C-s d</kbd> `sesman-link-with-directory`
- <kbd>C-c C-s p</kbd> `sesman-link-with-project`
- <kbd>C-c C-s u</kbd> `sesman-unlink`
## Friendly Sessions
[Sesman] defines "friendly" session to allow for on-the-fly operation on
sessions from contexts where there are no explicit links. In CIDER friendly
sessions are defined by the project dependencies. For example when you use
`cider-find-var` (<kbd>M-.</kbd>) to navigate to a var definition in a
dependency project the current project's session becomes a friendly session for
the dependency.
When you evaluate some code from a dependency project and there are no explicit
links in that project, the most recent friendly session is used to evaluate the
code. Explicitly linked sessions have precedence over the friendly sessions.
You can disable friendly session inference by customizing
`sesman-use-friendly-sessions`.
## Displaying Session Info
Get info on all linked and friendly sessions in the current context with
<kbd>C-c C-s i</kbd> (`sesman-info`). On <kbd>C-u</kbd>, display info on all
CIDER sessions. For the connection specific information use CIDER's built-in
`cider-describe-connection` (<kbd>C-c M-d</kbd>).
An interactive view of all CIDER sessions is available through the
`sesman-browser` (<kbd>C-c C-s w</kbd>).
## Current Session
All CIDER commands (evaluation, completion, switching to REPL etc.) operate on
the relevant REPL within the current session. The current session is the most
relevant session among all linked session (or friendly sessions when no links
exist). Session relevance is decided by the specificity of the linked contexts
and recency of the REPL buffers.
If the current context is linked to a single session then that session is the
current one. If multiple sessions are linked to a context (say, a project) then
the current session is the one containing the most recently viewed REPL.
Links to more specific contexts have precedence. For example, if you have two
sessions linked to the same project and another to a directory within that
project, then the session linked to the directory is the current session. Thus,
again, there is no ambiguity.
By default [Sesman] allows multiple simultaneous links to projects and
directories, but only one link per buffer. See `sesman-single-link-contexts` if
you would like to change that.
## Current REPL
The current REPL is the most relevant REPL from the current session. REPL relevance
is determined by the type of the current buffer. For example if the current
buffer is a `clj` buffer then a `clj` REPL is selected. Ambiguous situations could
arise when, for instance, there are multiple `clj` REPLs within a session, or
the current buffer is a `cljc` buffer and both `clj` and `cljs` REPLs exist in
the session. In such cases the current REPL is the most recently viewed REPL of
the relevant type.
Switch to the current REPL buffer with <kbd>C-c C-z</kbd>. You can then use the
same key combination to switch back to the Clojure(Script) buffer that you came
from.
The single prefix <kbd>C-u C-c C-z</kbd>, will switch to the current REPL buffer
and set the namespace in that buffer based on namespace in the current
Clojure(Script) buffer.
## Customizing Session and REPL Names
By default session names consist of abbreviated project name, host and port
(e.g. `project/dir:localhost:1234`). REPL buffer name consist of the session
name and the REPL type specification post-fix
(e.g. `*project/dir:localhost:1234(cljs:node)*`).
You can customize session names with `cider-session-name-template` and REPL
names with `nrepl-repl-buffer-name-template`. See also
`cider-format-connection-params` for available formats.
[Sesman]: https://github.com/vspinu/sesman
|
