Skip to content
The Clojure Interactive Development Environment that Rocks for Emacs
Emacs Lisp Other
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Implement a workaround for an expired elpa key (#2722) Oct 3, 2019
.github Fix a broken link Aug 11, 2019
doc Remove references to obsolete variables Dec 1, 2019
legacy-manual Bump versions in RTD so that we can rebuild the docs with Python 3 Oct 21, 2019
logo Update logo; add favicon files Feb 21, 2014
refcard Add a basic README for the refcard Oct 5, 2019
test Show startup commands in repl buffer Nov 29, 2019
.dir-locals.el Fix cider-eval-pprint-with-multiline-comment-handler Feb 11, 2019
.gitattributes Make it easier to deal with changelog conflicts Oct 20, 2016
.gitignore Add cider-pkg.el to .gitignore Jan 25, 2019
.projectile Add a .projectile file Oct 30, 2013
.readthedocs.yml Bump versions in RTD so that we can rebuild the docs with Python 3 Oct 21, 2019
CHANGELOG.md Show startup commands in repl buffer Nov 29, 2019
Cask [Fix #2199] Implement elisp-lint.el in CI Mar 5, 2018
LICENSE docs: add license Feb 14, 2019
Makefile Avoid hitting keyservers.net if key already in cache (#2727) Oct 16, 2019
README.md Tweak some wording Sep 4, 2019
ROADMAP.md Update the roadmap document Jun 25, 2018
Vagrantfile Update ubuntu version - Fix vagrant provision failure Aug 24, 2015
cider-apropos.el Observe `cider-use-tooltips` so it can prevent filling the echo area Aug 15, 2019
cider-browse-ns.el Bump the copyright years Jan 1, 2019
cider-browse-spec.el Initialize `sesman-system` in all CIDER modes Jul 13, 2018
cider-cheatsheet.el Bump the copyright years Jan 1, 2019
cider-classpath.el [#2611] Add an eval-based fallback for classpath lookup Mar 26, 2019
cider-client.el Fix a :package-version property Oct 2, 2019
cider-clojuredocs.el Add a command for refreshing the ClojureDocs cache Oct 7, 2019
cider-common.el Add `cider-jump-to-pop-to-buffer-actions` Nov 26, 2019
cider-compat.el Bump the copyright years Jan 1, 2019
cider-completion.el [completion] Protect get-context function from errors Aug 5, 2019
cider-connection.el Show startup commands in repl buffer Nov 29, 2019
cider-debug.el Checkdoc fixes Nov 3, 2019
cider-doc.el Add a command for refreshing the ClojureDocs cache Oct 7, 2019
cider-eldoc.el Bump the copyright years Jan 1, 2019
cider-eval.el Fix regex tests Nov 3, 2019
cider-find.el [#2611] Add eval-based var info lookup Apr 18, 2019
cider-format.el Simplify printing configuration Feb 11, 2019
cider-inspector.el Checkdoc fixes Nov 3, 2019
cider-macroexpansion.el Fix a bunch of typos May 24, 2019
cider-mode.el Fix docstring for cider-mode-menu Sep 1, 2019
cider-ns.el [#2611] Add an eval-based fallback for classpath lookup Mar 26, 2019
cider-overlays.el Checkdoc fixes Nov 3, 2019
cider-popup.el Bump the copyright years Jan 1, 2019
cider-profile.el Bump the copyright years Jan 1, 2019
cider-repl-history.el Fix a bunch of typos May 24, 2019
cider-repl.el Remove the mentioning of the survey Dec 9, 2019
cider-resolve.el Fix a bunch of typos May 24, 2019
cider-scratch.el Make it possible to pprint results in the scratch buffer Jan 8, 2019
cider-selector.el Improve the cider-selector handling of some edge cases (#2711) Sep 21, 2019
cider-stacktrace.el Fix a bunch of typos May 24, 2019
cider-test.el Remove C-g binding in test maps to make C-g work May 24, 2019
cider-tracing.el Bump the copyright years Jan 1, 2019
cider-util.el Allow lookup of function symbol when cursor is on opening paren Nov 2, 2019
cider-xref.el Fix the rendering of the xref buffer Aug 29, 2019
cider.el Show startup commands in repl buffer Nov 29, 2019
mkdocs.yml Delete RTD docs pages Oct 21, 2019
nrepl-client.el Fix the cider-file-loaded-hook definition Aug 10, 2019
nrepl-dict.el [#2611] Add eval-based var info lookup Apr 18, 2019

README.md

CIDER Logo


License GPL 3 MELPA MELPA Stable CircleCI

CIDER is the Clojure(Script) Interactive Development Environment that Rocks!

CIDER extends Emacs with support for interactive programming in Clojure. The features are centered around cider-mode, an Emacs minor-mode that complements clojure-mode. While clojure-mode supports editing Clojure source files, cider-mode adds support for interacting with a running Clojure process for compilation, debugging, definition and documentation lookup, running tests and so on.


OpenCollective OpenCollective Patreon Paypal

Please consider supporting financially its ongoing development.

Quickstart

The instructions that follow are meant to get you from zero to a running CIDER REPL in under 5 minutes. See the user manual for (way) more details.

Installation

The recommended way to install CIDER is via package.el - the built-in package manager in Emacs.

CIDER is available on the two major package.el community maintained repos - MELPA Stable and MELPA.

You can install CIDER with the following command:

M-x package-install RET cider RET

Launch an nREPL server and client from Emacs

Simply open in Emacs a file belonging to your lein or boot project (like foo.clj) and type M-x cider-jack-in. This will start an nREPL server with all the project dependencies loaded in and CIDER will automatically connect to it.

Alternatively you can use C-u M-x cider-jack-in to specify the name of a lein or boot project, without having to visit any file in it.

In Clojure(Script) buffers the command cider-jack-in is bound to C-c C-x (C-)j.

Connect to a running nREPL server

You can go to your project's directory in a terminal and type there (assuming you're using Leiningen that is):

$ lein repl

Or with Boot:

$ boot repl -s wait

Alternatively you can start nREPL either manually or by the facilities provided by your project's build tool (Gradle, Maven, etc).

After you get your nREPL server running go back to Emacs. Typing there M-x cider-connect will allow you to connect to the running nREPL server.

In Clojure(Script) buffers the command cider-connect is bound to C-c C-x (C-)c (C-)j and the command cider-connect-cljs is bound to C-c C-x (C-)c (C-)s.

Diving Deeper

CIDER packs a ton of functionality and you really want to be familiar with it, so you can fully empower your workflow. The best way to get acquainted with all available features is to go over the entire CIDER manual.

If you're into video lessons, you might also check out this intro to CIDER demo as well.

Changelog

An extensive changelog is available here.

Team

The Core Team

The direction of the project is being stewarded by the CIDER core team. This group of long-term contributors manage releases, evaluate pull-requests, and does a lot of the groundwork on major new features.

CIDER Alumni

In addition, we'd like to extend a special thanks the following retired CIDER core team members. Lovingly known as The Alumni:

Release policy

We’re following SemVer (as much as one can be following it when the major version is 0). At this point bumps of the minor (second) version number are considered major releases and always include new features or significant changes to existing features. API compatibility between major releases is not a (big) concern (although we try to break the API rarely and only for a good reason).

The development cycle for the next major release starts immediately after the previous one has been shipped. Bugfix/point releases (if any) address only serious bugs and never contain new features.

The versions of CIDER and cider-nrepl are always kept in sync. If you're tracking the master branch of CIDER, you should also be tracking the master branch of cider-nrepl.

Logo

CIDER's logo was created by @tapeinosyne. You can find the logo in various formats here.

The logo is licensed under a Creative Commons Attribution-NonCommercial 4.0 International License.

Homepage

CIDER's homepage https://cider.mx is in the gh-pages branch of this repository and is deployed automatically when changes are made to it.

It's just a single index.html file and a bit of Bootstrap 4. Contributions to it are very welcome!

Funding

While CIDER is free software and will always be, the project would benefit immensely from some funding. Raising a monthly budget of a couple of thousand dollars would make it possible to pay people to work on certain complex features, fund other development related stuff (e.g. hardware, conference trips) and so on. Raising a monthly budget of over $5000 would open the possibility of someone working full-time on the project which would speed up the pace of development significantly.

We welcome both individual and corporate sponsors! We also offer a wide array of funding channels to account for your preferences (although currently Open Collective is our preferred funding platform).

If you're working in a company that's making significant use of CIDER we'd appreciate it if you suggest to your company to become a CIDER sponsor.

You can support the development of CIDER, clojure-mode and inf-clojure via Open Collective, Salt, Patreon and PayPal.

Open Collective Backers

Open Collective Sponsors

Become a sponsor and get your logo on our README on Github with a link to your site. [Become a sponsor]

License

Copyright © 2012-2019 Tim King, Phil Hagelberg, Bozhidar Batsov, Artur Malabarba and contributors.

Distributed under the GNU General Public License, version 3

You can’t perform that action at this time.