Lisp Flavoured Erlang (LFE)
Erlang Emacs Lisp Shell Other
Latest commit 4b58eb0 Aug 17, 2016 @rvirding Fix but so that ERLANG_VERSION is now bound to a string
This caused problems when versions were more complex than just simple
numbers.

This fixes #260.
Permalink
Failed to load latest commit information.
bin Update rebar.config, .travis.yml and bin/lfe Jul 16, 2016
c_src Fix type cast error Nov 4, 2015
dev Add new core form (function <mod> name arity) Jul 1, 2016
doc Add ep/epp repl functions for printing in Erlang form Aug 15, 2016
emacs Fix auto mode alist regex to match .lfe Aug 11, 2016
examples Convert to use comma/comma-at instead of unquote/unquote-splicing Sep 9, 2015
include Added dolist macro that wraps lists:foreach. Nov 14, 2015
src Fix 'function' and #' so core functions are also usable Aug 16, 2016
test Add new core form (function <mod> name arity) Jul 1, 2016
.dockerignore Added initial Docker files. Dec 6, 2014
.gitignore Add missing specs to lfe_doc and clean up tests Apr 13, 2016
.travis.yml Update rebar.config, .travis.yml and bin/lfe Jul 16, 2016
Dockerfile Updated to the latest Erlang release. Mar 27, 2016
Emakefile Fix Makefile and add Emakefile and lfe.app. May 26, 2010
LICENSE Convert to use Apache License, Version 2.0 Feb 12, 2013
Makefile Make new way to get erlang version and set compiletime dependencies Aug 14, 2016
README.md Fix broken link Aug 14, 2016
VERSION Add new core form (function <mod> name arity) Jul 1, 2016
get_comp_opts.escript Fix but so that ERLANG_VERSION is now bound to a string Aug 17, 2016
rebar.config Update rebar.config, .travis.yml and bin/lfe Jul 16, 2016
rebar.config.script Fix but so that ERLANG_VERSION is now bound to a string Aug 17, 2016
rebar.lock Add PropEr tests to lfe_doc Apr 13, 2016

README.md

LFE

Travis Hex.pm version Hex.pm downloads Hex.pm weekly downloads Hex.pm daily downloads

LFE, Lisp Flavoured Erlang, is a lisp syntax front-end to the Erlang compiler. Code produced with it is compatible with "normal" Erlang code. An LFE evaluator and shell is also included.

Building

To compile LFE, simple clone it and compile:

    $ git clone https://github.com/rvirding/lfe.git
    $ cd lfe
    $ make compile

LFE requires Erlang be installed on the system and that the erl binary is in $PATH.

Installation

Should you wish to have LFE available system-wide, you can run the following make target:

    $ make install

By default this will create the programs lfe, lfec and lfescript in the same directory as the erl program. This can changed by defining the make variable DESTBINDIR to point to the desired directory.

Note that the installation target will also install the LFE man pages in the appropriate /usr/local/man/man* directories. This can be changed by defining the make variable MANINSTDIR to point to the desired top man directory.

So:

    $ make install DESTBINDIR=/Users/rv/bin MANINSTDIR=/Users/rv/man

will put the programs in /Users/rv/bin and the man pages in the /Users/rv/man/man* directories.

REPL

If you're running LFE from a git clone working dir, you can start the REPL like so after compiling:

    $ ./bin/lfe
    Erlang 17 (erts-6.0) [source] [64-bit] [smp:8:8] ...

    LFE Shell V6.0 (abort with ^G)
    >

If you have installed LFE, then you may start the REPL from any location:

    $ lfe
    Erlang 17 (erts-6.0) [source] [64-bit] [smp:8:8] ...

    LFE Shell V6.0 (abort with ^G)
    >

Likewise, you may run an LFE shell script in the same style as shell scripts with:

    $ ./bin/lfe script-name script-arg-1 ...

or

    $ lfe script-name script-arg-1 ...

Usage

The docs site has several places to explore that will show you how to start using LFE. However, here's a quick taste:

  • start up an LFE REPL as demonstrated above
  • then, do something like this:
    > (* 2 (+ 1 2 3 4 5 6))
    42
    > (* 2 (lists:foldl #'+/2 0 (lists:seq 1 6)))
    42

Docker Support

LFE now supports Docker. To get started, simply do the following, once you have Docker set up on your machine:

$ docker pull lfex/lfe

Alternatively, you could build the image yourself:

$ cd lfe
$ docker build .

Here are a couple of simple usage examples:

$ docker run lfex/lfe
42

$ docker run -i -t lfex/lfe lfe
Erlang/OTP 18 [erts-7.0] [source-4d83b58] [64-bit] [smp:8:8] ...

LFE Shell V7.0 (abort with ^G)
>

That last command will dump you into the LFE REPL on a running container of the lfex/lfe Docker image. For more information on using Docker with LFE, be sure to read the tutorial.

Documentation

Files with more technical details:

If you would like to make changes to the LFE documentation and then regenerate the docs, you'll want to read the instructions here: