You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/up_and_running.md
+39-18Lines changed: 39 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,20 +3,20 @@ connect. Many Clojurians favour the use of tools like Leiningen, Boot or Gradle
3
3
to start an nREPL server, but the use of one of them is not a prerequisite to
4
4
use CIDER.
5
5
6
-
## Setting up a Leiningen or Boot project (optional)
7
-
8
-
[Leiningen](https://leiningen.org) is the de-facto standard build/project
9
-
management tool for Clojure. [Boot](http://boot-clj.com) is a newer build tool
10
-
offering abstractions and libraries to construct more complex build
11
-
scenarios. Both have a similar scope to the Maven build tool favoured by Java
12
-
developers (and they actually reuse many things from the Maven ecosystem).
6
+
## Setting up a Clojure project (optional)
13
7
14
8
CIDER features a command called `cider-jack-in` that will start an nREPL server
15
-
for a particular Leiningen or Boot project and connect to it automatically.
16
-
This functionality depends on Leiningen 2.5.2+ or Boot
17
-
2.7.0+. Older versions are not supported. For Leiningen, follow the installation
18
-
instructions on its web site to get it up and running and afterwards create a
19
-
project like this:
9
+
for a particular Clojure project and connect to it automatically. Most
10
+
popular Clojure project management tools are supported by default - namely
11
+
Leiningen, Boot, `clj` (`tools.deps`) and Gradle.
12
+
13
+
!!! Note
14
+
15
+
This functionality depends on Leiningen 2.5.2+ or Boot
16
+
2.7.0+. Older versions are not supported.
17
+
18
+
Let's create a simple Clojure project using Leiningen now. Provided you've installed
19
+
it already, all you need to do is:
20
20
21
21
```
22
22
$ lein new demo
@@ -30,15 +30,17 @@ Simply open in Emacs a file belonging to your project (like `foo.clj`) and type
30
30
<kbd>M-x</kbd> `cider-jack-in` <kbd>RET</kbd>. This will start an nREPL server
31
31
and CIDER will automatically connect to it.
32
32
33
-
If it is a `lein`, `boot` or `tools.deps (deps.edn)` project nREPL will be
34
-
started with all dependencies loaded.
33
+
!!! Note
34
+
35
+
If it is a `lein`, `boot` or `tools.deps (deps.edn)` project nREPL will be
36
+
started with all dependencies loaded. Dependency auto-injection is currently
37
+
not support for Gradle projects.
35
38
36
39
Alternatively you can use <kbd>C-u M-x</kbd> `cider-jack-in` <kbd>RET</kbd> to
37
40
specify the name of a `lein`, `boot` or `tools.deps` project, without having to
38
41
visit any file in it. This option is also useful if your project contains some
39
42
combination of `project.clj`, `build.boot` and `deps.edn` and you want to launch
40
-
a repl for one or the other.
41
-
43
+
a REPL for one or the other.
42
44
43
45
!!! Tip
44
46
@@ -47,8 +49,27 @@ a repl for one or the other.
47
49
For further customizing the command line used for `cider-jack-in`, you can
48
50
change the following (all string options):
49
51
50
-
*`cider-lein-global-options`, `cider-boot-global-options`, `cider-gradle-global-options`: these are passed to the command directly, in first position (e.g. `-o` to `lein` enables offline mode).
51
-
*`cider-lein-parameters`, `cider-boot-parameters`, `cider-gradle-parameters`: these are usually tasks names and their parameters (e.g.: `dev` for launching boot's dev task instead of the standard `repl -s wait`).
0 commit comments