Leiningen

for automating Clojure projects without setting your hair on fire

Leiningen offers the easiest way to get started with Clojure. With a focus on project automation and straightforward configuration, it gets out of your way and lets you focus on your code.

(defproject leiningen.org "1.0.0"
  :description "Generate static HTML for http://leiningen.org"
  :dependencies [[enlive "1.0.0"]
                 [cheshire "2.2.0"]
                 [org.markdownj/markdownj "0.3.0-1.0.2b4"]]
  :main leiningen.web)

Install

Leiningen might already be available in your preferred package manager. If not, or if you want a newer version it's still easy to install the old-fashioned way.

  1. Download the lein script
  2. Place it on your $PATH (eg. ~/bin)
  3. Set it to be executable. (chmod 755 ~/bin/lein)

The link above will get you the 2.x preview release. There is still a lot of extant material on the Web concerning the older Leiningen 1.x version, which is still available if you need to work on older projects that aren't compatible with 2.x yet. The upgrade guide has instructions on migrating to version 2.

On Windows most users can get the batch file If you have wget.exe or curl.exe already installed and in PATH, you can just run `lein self-install`, otherwise get the standalone jar from the downloads page. If you have Cygwin you should be able to use the shell script above rather than the batch file.

Documentation

The tutorial is the best place to start. If you have Leiningen installed, you can read the tutorial by running lein help tutorial.

There is a FAQ available via lein help faq. Documentation for each individual task is available via lein help $TASK. You can also see the sample project.clj file with a reference of all project settings by running lein help sample.

Other guides include profiles, writing plugins and deploying libraries. There is a list of plugins on the wiki. Those interested in using leiningen-core as a library should read the API reference.

Community

Leiningen is the most active open-source Clojure project. We welcome potential contributors and do our best to try to make it easy to help out.

Discussion occurs on the mailing list and in the #leiningen channel on Freenode, while issues should be reported on the Github issue tracker. Simpler issues appropriate for first-time contributors looking to help out are tagged "newbie".

Contributors who have had a single patch accepted may request commit rights on the mailing list or in IRC as well as a free sticker.