• Home
  • History
  • Annotate
Name Date Size #Lines LOC

..03-May-2022-

.circleci/H22-Apr-2021-7466

.github/H22-Apr-2021-217155

doc/H22-Apr-2021-6,9625,146

logo/H03-May-2022-

refcard/H03-May-2022-149128

test/H22-Apr-2021-4,4563,017

.dir-locals.elH A D22-Apr-20211.7 KiB3627

.gitattributesH A D22-Apr-202125 21

.gitignoreH A D22-Apr-2021181 1918

.projectileH A D22-Apr-202116 22

CHANGELOG.mdH A D22-Apr-2021101.3 KiB1,3991,136

EldevH A D22-Apr-20211,008 2820

LICENSEH A D22-Apr-202134.3 KiB675553

README.mdH A D22-Apr-202116.8 KiB264201

ROADMAP.mdH A D22-Apr-20214.4 KiB11375

VagrantfileH A D22-Apr-2021177 96

cider-apropos.elH A D22-Apr-20219.2 KiB212161

cider-browse-ns.elH A D22-Apr-20218.7 KiB235164

cider-browse-spec.elH A D22-Apr-202115.4 KiB359269

cider-cheatsheet.elH A D22-Apr-202121.1 KiB578495

cider-classpath.elH A D22-Apr-20213.5 KiB11169

cider-client.elH A D22-Apr-202133.2 KiB812663

cider-clojuredocs.elH A D22-Apr-20215.7 KiB160109

cider-common.elH A D22-Apr-202119.1 KiB443349

cider-compat.elH A D22-Apr-20212.1 KiB5723

cider-completion.elH A D22-Apr-202110.5 KiB272204

cider-connection.elH A D22-Apr-202141 KiB936756

cider-debug.elH A D22-Apr-202136.1 KiB809615

cider-doc.elH A D22-Apr-202120.7 KiB546440

cider-eldoc.elH A D22-Apr-202121.2 KiB489361

cider-eval.elH A D22-Apr-202157.2 KiB1,2951,068

cider-find.elH A D22-Apr-20219.4 KiB231174

cider-format.elH A D22-Apr-20215.1 KiB15487

cider-inspector.elH A D22-Apr-202121.6 KiB527406

cider-macroexpansion.elH A D22-Apr-20217.9 KiB207146

cider-mode.elH A D22-Apr-202147 KiB1,079930

cider-ns.elH A D22-Apr-202111.3 KiB273177

cider-overlays.elH A D22-Apr-202113.4 KiB322243

cider-popup.elH A D22-Apr-20215.6 KiB13887

cider-profile.elH A D22-Apr-20217.9 KiB217165

cider-repl-history.elH A D22-Apr-202130.4 KiB728579

cider-repl.elH A D22-Apr-202176.3 KiB1,8391,534

cider-resolve.elH A D22-Apr-20215.8 KiB13153

cider-scratch.elH A D22-Apr-20213.4 KiB10053

cider-selector.elH A D22-Apr-20216.6 KiB175117

cider-stacktrace.elH A D22-Apr-202138.6 KiB890731

cider-test.elH A D22-Apr-202133.9 KiB840667

cider-tracing.elH A D22-Apr-20213.5 KiB9153

cider-util.elH A D22-Apr-202134.6 KiB842664

cider-xref.elH A D22-Apr-20217.5 KiB185133

cider.elH A D22-Apr-202168.7 KiB1,5741,287

nrepl-client.elH A D22-Apr-202158 KiB1,3731,059

nrepl-dict.elH A D22-Apr-20216.6 KiB194133

README.md

1<p align="center">
2  <img src="https://raw.github.com/clojure-emacs/cider/master/logo/cider-logo-w640.png" alt="CIDER Logo"/>
3</p>
4
5-----------
6[![License GPL 3][badge-license]](http://www.gnu.org/licenses/gpl-3.0.txt)
7[![MELPA](http://melpa.org/packages/cider-badge.svg)](http://melpa.org/#/cider)
8[![MELPA Stable](http://stable.melpa.org/packages/cider-badge.svg)](http://stable.melpa.org/#/cider)
9[![CircleCI](https://circleci.com/gh/clojure-emacs/cider.svg?style=svg)](https://circleci.com/gh/clojure-emacs/cider)
10[![Discord](https://img.shields.io/badge/chat-on%20discord-7289da.svg?sanitize=true)](https://discord.com/invite/nFPpynQPME)
11[![Slack](https://img.shields.io/badge/chat-%23cider-green.svg?style=flat)](http://clojurians.net)
12
13CIDER is the **C**lojure(Script) **I**nteractive **D**evelopment **E**nvironment
14that **R**ocks!
15
16CIDER extends Emacs with support for [interactive
17programming](https://docs.cider.mx/cider/usage/interactive_programming.html)
18in Clojure. The features are centered around `cider-mode`, an Emacs
19minor-mode that complements [clojure-mode][]. While `clojure-mode`
20supports editing Clojure source files, `cider-mode` adds support for
21interacting with a running Clojure process for compilation, code
22completion, debugging, definition and documentation lookup, running
23tests and so on.
24
25----------
26[![OpenCollective](https://opencollective.com/cider/backers/badge.svg)](#open-collective-backers)
27[![OpenCollective](https://opencollective.com/cider/sponsors/badge.svg)](#open-collective-sponsors)
28[![Patreon](https://img.shields.io/badge/patreon-donate-orange.svg)](https://www.patreon.com/bbatsov)
29[![Paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=GRQKNBM6P8VRQ)
30
31Bozhidar (a.k.a. Bug, CIDER's primary author/maintainer) has spent countless hours working on
32CIDER and the [numerous related projects](https://metaredux.com/posts/2018/11/09/ciders-orchard-the-heart.html). That's a lot of work and not all of it is fun!
33
34**Please consider [supporting financially CIDER's ongoing development](#funding).**
35
36## Quickstart
37
38The instructions that follow are meant to get you from zero to a running CIDER
39REPL in under 5 minutes.  See the
40[user manual](https://docs.cider.mx) for (way) more
41details.
42
43### Installation
44
45The recommended way to install CIDER is via `package.el` - the built-in package
46manager in Emacs.
47
48CIDER is available on the two major `package.el` community
49maintained repos -
50[MELPA Stable](http://stable.melpa.org)
51and [MELPA](http://melpa.org).
52
53Provided you've enabled one of them in your Emacs setup, you can
54install CIDER with the following command:
55
56<kbd>M-x</kbd> `package-install` <kbd>RET</kbd> `cider` <kbd>RET</kbd>
57
58### Launch an nREPL server and client from Emacs
59
60Simply open in Emacs a file belonging to your `lein`, `tools.deps` or `boot` project (like
61`foo.clj`) and type <kbd>M-x</kbd> `cider-jack-in`. This will start an nREPL
62server with all the project dependencies loaded in and CIDER will automatically
63connect to it.
64
65Alternatively you can use <kbd>C-u M-x</kbd> `cider-jack-in` to specify the path to
66a Clojure project, without having to visit any file in it.
67
68**Tip:** In Clojure(Script) buffers the command `cider-jack-in` is bound to
69<kbd>C-c C-x (C-)j</kbd>.
70
71### Connect to a running nREPL server
72
73You can go to your project's directory in a terminal and type there
74(assuming you're using Leiningen that is):
75
76```
77$ lein repl
78```
79
80Or with Boot:
81
82```
83$ boot repl -s wait
84```
85
86Alternatively you can start nREPL either manually or by the facilities provided
87by your project's build tool (`tools.deps`, Gradle, Maven, etc).
88
89After you get your nREPL server running go back to Emacs.  Typing there <kbd>M-x</kbd>
90`cider-connect` will allow you to connect to the running nREPL server.
91
92**Tip:** In Clojure(Script) buffers the command `cider-connect` is bound to
93<kbd>C-c C-x (C-)c (C-)j</kbd> and the command `cider-connect-cljs` is bound to
94<kbd>C-c C-x (C-)c (C-)s</kbd>.
95
96## Diving Deeper
97
98CIDER packs a ton of functionality and you really want to be familiar with it,
99so you can fully empower your workflow. The best way to get acquainted with all
100available features is to go over the entire
101[CIDER manual](https://docs.cider.mx/).
102
103If you're into video lessons, you might also check out
104this [intro to CIDER demo](https://www.youtube.com/watch?v=aYA4AAjLfT0) as well.
105
106## Get Help
107
108Start with CIDER's [discussions board](https://github.com/clojure-emacs/cider/discussions). If it doesn't get the job done consider some of the other available
109[support channels](https://docs.cider.mx/cider/about/support.html).
110
111## Changelog
112
113An extensive changelog is available [here](CHANGELOG.md).
114
115## Team
116
117### The Core Team
118
119The direction of the project is being stewarded by the CIDER core team. This
120group of long-term contributors manage releases, evaluate pull-requests, and
121does a lot of the groundwork on major new features.
122
123* [Bozhidar Batsov](https://github.com/bbatsov) (author & head maintainer)
124* [Vitalie Spinu](https://github.com/vspinu)
125* [Michael Griffiths](https://github.com/cichli)
126* [Lars Andersen](https://github.com/expez)
127
128### CIDER Alumni
129
130In addition, we'd like to extend a special thanks the following retired CIDER
131core team members. Lovingly known as The Alumni:
132
133* [Tim King](https://github.com/kingtim) (original author)
134* [Phil Hagelberg](https://github.com/technomancy)
135* [Hugo Duncan](https://github.com/hugoduncan)
136* [Steve Purcell](https://github.com/purcell)
137* [Artur Malabarba](https://github.com/malabarba)
138* [Jeff Valk](https://github.com/jeffvalk)
139
140## Release policy
141
142We’re following [SemVer](http://semver.org/).
143
144You can read more on the subject [here](https://docs.cider.mx/cider/about/release_policy.html).
145
146## Logo
147
148CIDER's logo was created by [@tapeinosyne](https://github.com/tapeinosyne). You can find
149the logo in various formats
150[here](https://github.com/clojure-emacs/cider/tree/master/logo).
151
152The logo is licensed under a
153[Creative Commons Attribution-NonCommercial 4.0 International License](http://creativecommons.org/licenses/by-nc/4.0/deed.en_GB).
154
155## Homepage
156
157CIDER's homepage <https://cider.mx> is in the `gh-pages` branch of this repository and is deployed
158automatically when changes are made to it.
159
160It's just a single `index.html` file and a bit of Bootstrap 4. Contributions to it are very welcome!
161
162## Funding
163
164While CIDER is free software and will always be, the project would benefit immensely from some funding.
165Raising a monthly budget of a couple of thousand dollars would make it possible to pay people to work on
166certain complex features, fund other development related stuff (e.g. hardware, conference trips) and so on.
167Raising a monthly budget of over $5000 would open the possibility of someone working full-time on the project
168which would speed up the pace of development significantly.
169
170We welcome both individual and corporate sponsors! We also offer a wide array of funding channels to account
171for your preferences (although currently [Open Collective](https://opencollective.com/cider) is our preferred funding platform).
172
173If you're working in a company that's making significant use of CIDER we'd appreciate it if you suggest to your company
174to become a CIDER sponsor.
175
176You can support the development of CIDER, [clojure-mode][] and [inf-clojure][] via
177[Open Collective](https://opencollective.com/cider),
178[GitHub Sponsors](https://github.com/sponsors/bbatsov),
179[Patreon](https://www.patreon.com/bbatsov) and
180[PayPal](https://www.paypal.me/bbatsov).
181
182### Open Collective Backers
183
184<a href="https://opencollective.com/cider/backer/0/website" target="_blank"><img src="https://opencollective.com/cider/backer/0/avatar.svg"></a>
185<a href="https://opencollective.com/cider/backer/1/website" target="_blank"><img src="https://opencollective.com/cider/backer/1/avatar.svg"></a>
186<a href="https://opencollective.com/cider/backer/2/website" target="_blank"><img src="https://opencollective.com/cider/backer/2/avatar.svg"></a>
187<a href="https://opencollective.com/cider/backer/3/website" target="_blank"><img src="https://opencollective.com/cider/backer/3/avatar.svg"></a>
188<a href="https://opencollective.com/cider/backer/4/website" target="_blank"><img src="https://opencollective.com/cider/backer/4/avatar.svg"></a>
189<a href="https://opencollective.com/cider/backer/5/website" target="_blank"><img src="https://opencollective.com/cider/backer/5/avatar.svg"></a>
190<a href="https://opencollective.com/cider/backer/6/website" target="_blank"><img src="https://opencollective.com/cider/backer/6/avatar.svg"></a>
191<a href="https://opencollective.com/cider/backer/7/website" target="_blank"><img src="https://opencollective.com/cider/backer/7/avatar.svg"></a>
192<a href="https://opencollective.com/cider/backer/8/website" target="_blank"><img src="https://opencollective.com/cider/backer/8/avatar.svg"></a>
193<a href="https://opencollective.com/cider/backer/9/website" target="_blank"><img src="https://opencollective.com/cider/backer/9/avatar.svg"></a>
194<a href="https://opencollective.com/cider/backer/10/website" target="_blank"><img src="https://opencollective.com/cider/backer/10/avatar.svg"></a>
195<a href="https://opencollective.com/cider/backer/11/website" target="_blank"><img src="https://opencollective.com/cider/backer/11/avatar.svg"></a>
196<a href="https://opencollective.com/cider/backer/12/website" target="_blank"><img src="https://opencollective.com/cider/backer/12/avatar.svg"></a>
197<a href="https://opencollective.com/cider/backer/13/website" target="_blank"><img src="https://opencollective.com/cider/backer/13/avatar.svg"></a>
198<a href="https://opencollective.com/cider/backer/14/website" target="_blank"><img src="https://opencollective.com/cider/backer/14/avatar.svg"></a>
199<a href="https://opencollective.com/cider/backer/15/website" target="_blank"><img src="https://opencollective.com/cider/backer/15/avatar.svg"></a>
200<a href="https://opencollective.com/cider/backer/16/website" target="_blank"><img src="https://opencollective.com/cider/backer/16/avatar.svg"></a>
201<a href="https://opencollective.com/cider/backer/17/website" target="_blank"><img src="https://opencollective.com/cider/backer/17/avatar.svg"></a>
202<a href="https://opencollective.com/cider/backer/18/website" target="_blank"><img src="https://opencollective.com/cider/backer/18/avatar.svg"></a>
203<a href="https://opencollective.com/cider/backer/19/website" target="_blank"><img src="https://opencollective.com/cider/backer/19/avatar.svg"></a>
204<a href="https://opencollective.com/cider/backer/20/website" target="_blank"><img src="https://opencollective.com/cider/backer/20/avatar.svg"></a>
205<a href="https://opencollective.com/cider/backer/21/website" target="_blank"><img src="https://opencollective.com/cider/backer/21/avatar.svg"></a>
206<a href="https://opencollective.com/cider/backer/22/website" target="_blank"><img src="https://opencollective.com/cider/backer/22/avatar.svg"></a>
207<a href="https://opencollective.com/cider/backer/23/website" target="_blank"><img src="https://opencollective.com/cider/backer/23/avatar.svg"></a>
208<a href="https://opencollective.com/cider/backer/24/website" target="_blank"><img src="https://opencollective.com/cider/backer/24/avatar.svg"></a>
209<a href="https://opencollective.com/cider/backer/25/website" target="_blank"><img src="https://opencollective.com/cider/backer/25/avatar.svg"></a>
210<a href="https://opencollective.com/cider/backer/26/website" target="_blank"><img src="https://opencollective.com/cider/backer/26/avatar.svg"></a>
211<a href="https://opencollective.com/cider/backer/27/website" target="_blank"><img src="https://opencollective.com/cider/backer/27/avatar.svg"></a>
212<a href="https://opencollective.com/cider/backer/28/website" target="_blank"><img src="https://opencollective.com/cider/backer/28/avatar.svg"></a>
213<a href="https://opencollective.com/cider/backer/29/website" target="_blank"><img src="https://opencollective.com/cider/backer/29/avatar.svg"></a>
214
215### Open Collective Sponsors
216
217Become a sponsor and get your logo on our README on Github with a link to your
218site. [[Become a sponsor](https://opencollective.com/cider#sponsor)]
219
220<a href="https://opencollective.com/cider/sponsor/0/website" target="_blank"><img src="https://opencollective.com/cider/sponsor/0/avatar.svg"></a>
221<a href="https://opencollective.com/cider/sponsor/1/website" target="_blank"><img src="https://opencollective.com/cider/sponsor/1/avatar.svg"></a>
222<a href="https://opencollective.com/cider/sponsor/2/website" target="_blank"><img src="https://opencollective.com/cider/sponsor/2/avatar.svg"></a>
223<a href="https://opencollective.com/cider/sponsor/3/website" target="_blank"><img src="https://opencollective.com/cider/sponsor/3/avatar.svg"></a>
224<a href="https://opencollective.com/cider/sponsor/4/website" target="_blank"><img src="https://opencollective.com/cider/sponsor/4/avatar.svg"></a>
225<a href="https://opencollective.com/cider/sponsor/5/website" target="_blank"><img src="https://opencollective.com/cider/sponsor/5/avatar.svg"></a>
226<a href="https://opencollective.com/cider/sponsor/6/website" target="_blank"><img src="https://opencollective.com/cider/sponsor/6/avatar.svg"></a>
227<a href="https://opencollective.com/cider/sponsor/7/website" target="_blank"><img src="https://opencollective.com/cider/sponsor/7/avatar.svg"></a>
228<a href="https://opencollective.com/cider/sponsor/8/website" target="_blank"><img src="https://opencollective.com/cider/sponsor/8/avatar.svg"></a>
229<a href="https://opencollective.com/cider/sponsor/9/website" target="_blank"><img src="https://opencollective.com/cider/sponsor/9/avatar.svg"></a>
230<a href="https://opencollective.com/cider/sponsor/10/website" target="_blank"><img src="https://opencollective.com/cider/sponsor/10/avatar.svg"></a>
231<a href="https://opencollective.com/cider/sponsor/11/website" target="_blank"><img src="https://opencollective.com/cider/sponsor/11/avatar.svg"></a>
232<a href="https://opencollective.com/cider/sponsor/12/website" target="_blank"><img src="https://opencollective.com/cider/sponsor/12/avatar.svg"></a>
233<a href="https://opencollective.com/cider/sponsor/13/website" target="_blank"><img src="https://opencollective.com/cider/sponsor/13/avatar.svg"></a>
234<a href="https://opencollective.com/cider/sponsor/14/website" target="_blank"><img src="https://opencollective.com/cider/sponsor/14/avatar.svg"></a>
235<a href="https://opencollective.com/cider/sponsor/15/website" target="_blank"><img src="https://opencollective.com/cider/sponsor/15/avatar.svg"></a>
236<a href="https://opencollective.com/cider/sponsor/16/website" target="_blank"><img src="https://opencollective.com/cider/sponsor/16/avatar.svg"></a>
237<a href="https://opencollective.com/cider/sponsor/17/website" target="_blank"><img src="https://opencollective.com/cider/sponsor/17/avatar.svg"></a>
238<a href="https://opencollective.com/cider/sponsor/18/website" target="_blank"><img src="https://opencollective.com/cider/sponsor/18/avatar.svg"></a>
239<a href="https://opencollective.com/cider/sponsor/19/website" target="_blank"><img src="https://opencollective.com/cider/sponsor/19/avatar.svg"></a>
240<a href="https://opencollective.com/cider/sponsor/20/website" target="_blank"><img src="https://opencollective.com/cider/sponsor/20/avatar.svg"></a>
241<a href="https://opencollective.com/cider/sponsor/21/website" target="_blank"><img src="https://opencollective.com/cider/sponsor/21/avatar.svg"></a>
242<a href="https://opencollective.com/cider/sponsor/22/website" target="_blank"><img src="https://opencollective.com/cider/sponsor/22/avatar.svg"></a>
243<a href="https://opencollective.com/cider/sponsor/23/website" target="_blank"><img src="https://opencollective.com/cider/sponsor/23/avatar.svg"></a>
244<a href="https://opencollective.com/cider/sponsor/24/website" target="_blank"><img src="https://opencollective.com/cider/sponsor/24/avatar.svg"></a>
245<a href="https://opencollective.com/cider/sponsor/25/website" target="_blank"><img src="https://opencollective.com/cider/sponsor/25/avatar.svg"></a>
246<a href="https://opencollective.com/cider/sponsor/26/website" target="_blank"><img src="https://opencollective.com/cider/sponsor/26/avatar.svg"></a>
247<a href="https://opencollective.com/cider/sponsor/27/website" target="_blank"><img src="https://opencollective.com/cider/sponsor/27/avatar.svg"></a>
248<a href="https://opencollective.com/cider/sponsor/28/website" target="_blank"><img src="https://opencollective.com/cider/sponsor/28/avatar.svg"></a>
249<a href="https://opencollective.com/cider/sponsor/29/website" target="_blank"><img src="https://opencollective.com/cider/sponsor/29/avatar.svg"></a>
250
251## License
252
253CIDER is distributed under the GNU General Public License, version 3.
254
255Copyright © 2012-2021 Bozhidar Batsov, Artur Malabarba, Tim King, Phil Hagelberg and
256[contributors](https://github.com/clojure-emacs/cider/contributors).
257
258[badge-license]: https://img.shields.io/badge/license-GPL_3-green.svg
259[nREPL]:https://github.com/nrepl/nrepl
260[Sly]: https://github.com/joaotavora/sly
261[Geiser]: https://github.com/jaor/geiser
262[clojure-mode]: https://github.com/clojure-emacs/clojure-mode
263[inf-clojure]: https://github.com/clojure-emacs/inf-clojure
264