Liking cljdoc? Tell your friends :D

nREPL Logo


CircleCI Spell-check Status Clojars Project cljdoc badge downloads badge Backers on Open Collective Sponsors on Open Collective Discord

nREPL is a Clojure network REPL that provides a REPL server and client, along with some common APIs of use to IDEs and other tools that may need to evaluate Clojure code in remote environments.

nREPL powers many well-known development tools.

Usage

  • Start an nREPL server (e.g. with lein repl)
  • Connect to the server using any nREPL client (e.g. CIDER, Calva, vim-fireplace)
  • Start hacking!

See the documentation for way information on the subject.

API Documentation

You can find nREPL's API documentation on cljdoc.

Status

Extremely stable. nREPL's protocol and API are rock-solid and battle tested. nREPL's team pledges to evolve them only in backwards-compatible ways.

That being said, there were a few organizational changes related to the transition out of clojure-contrib that everyone has to keep in mind:

  • [nrepl "0.3.1"] is a drop-in replacement for [org.clojure/tools.nrepl "0.2.13"] (notice the different artifact coordinates).
  • [nrepl "0.4.0"] changes the namespaces from clojure.tools.nrepl.* to nrepl.*.

Future releases will focus on supporting the needs of the essential tools of the Clojure(Script) ecosystem (e.g. Leiningen, CIDER, Cursive).

FAQ

How is this different from the "contrib" tools.nrepl project?

Check the brief history of nREPL, available here.

How does nREPL compare to other REPL servers (e.g. prepl)?

Check out this detailed comparison.

Does nREPL support ClojureScript?

Yes and no. The reference nREPL implementation is Clojure-specific, but it can be extended with ClojureScript support via the Piggieback middleware. In the future there may be implementations of nREPL that target ClojureScript directly.

Does nREPL support other programming languages besides Clojure?

The nREPL protocol is language-agnostic and implementations of nREPL servers exist for several programming languages. Implementing new nREPL servers is pretty simple.

Testing and Hacking around

See Hacking on nREPL.

Contributors

This project exists thanks to all the people who contribute.

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

License

Copyright © 2010-2023 Chas Emerick, Bozhidar Batsov and contributors.

Licensed under the EPL. (See the file epl.html.)

Can you improve this documentation? These fine people already did:
Chas Emerick, Bozhidar Batsov, Sean Corfield, tijsmallaerts, Shen Tian, solar05, Reid D McKenzie, Nikita Prokopov, ikappaki, Andrew Rosa & jess
Edit on GitHub

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close