How do I set up Emacs for Common Lisp the fastest way?

Emacs4CL provides the quickest setup by using a single .emacs file that automates package installation. Just install SBCL and Emacs, then run the provided curl command to copy the configuration, and start Emacs to get a working environment.

Is Emacs4CL or Portacle better for a beginner?

Emacs4CL is better if you want to learn and customize Emacs from the ground up, while Portacle offers a more complete, pre-configured IDE. Emacs4CL's educational approach helps understanding, but Portacle requires less initial effort.

How can I disable Paredit in Emacs4CL?

You can disable Paredit by modifying the .emacs file: remove or comment out the add-hook lines for enable-paredit-mode and delete Paredit from the package list in the dolist expression, as explained in the Line-by-Line Explanation section.

Does Emacs4CL work on Windows?

It can work experimentally since SBCL runs on Windows, but setup is more complex. The README provides download links, but Windows users may need to manually configure paths and deal with potential compatibility issues not covered in detail.

What packages does Emacs4CL install automatically?

It installs SLIME for Lisp interaction, Paredit for structured editing, and Rainbow Delimiters for colored parentheses. You can see this in the dolist expression in the .emacs file and add more packages by editing that list.

How do I update the packages in Emacs4CL?

The README doesn't automate updates; you need to use Emacs' package manager manually with commands like M-x package-list-packages or modify the .emacs to refresh package contents, which isn't built into the initial setup.

Can I use Emacs4CL with other Lisp implementations besides SBCL?

Yes, but it's configured for SBCL by default. You can change the inferior-lisp-program variable in the .emacs file to point to other Lisp implementations like CLISP or CCL, though setup and compatibility may vary.

Open-Awesome

Emacs4CL

MITEmacs Lisp0.5.0

A tiny DIY kit to set up vanilla Emacs for Common Lisp programming with SLIME, Paredit, and Rainbow Delimiters.

GitHub

393 stars28 forks0 contributors

What is Emacs4CL?

Emacs4CL is a minimal configuration kit that sets up vanilla Emacs for Common Lisp programming. It automates the installation of essential packages like SLIME, Paredit, and Rainbow Delimiters, providing a ready-to-use development environment without the complexity of a full IDE. The project solves the problem of tedious manual Emacs configuration for Lisp beginners by offering a simple, documented starting point.

Target Audience

Absolute beginners to Emacs and Common Lisp who want a quick, understandable setup for learning Lisp programming. It's ideal for those who have tried books like Practical Common Lisp but found setting up Emacs and SLIME daunting.

Value Proposition

Developers choose Emacs4CL because it offers a lightweight, transparent alternative to heavier IDEs like Portacle, promoting a DIY approach that helps users learn Emacs configuration while getting a functional Common Lisp environment quickly.

Overview

A tiny DIY kit to set up vanilla Emacs for Common Lisp programming

Use Cases

Best For

Learning Common Lisp with a minimal Emacs setup
Setting up a basic Common Lisp development environment quickly
Understanding how to configure Emacs for Lisp programming
Avoiding the complexity of full-featured Lisp IDEs
Customizing Emacs incrementally for personal workflow
Following along with Common Lisp tutorials and books

Not Ideal For

Users who prefer a fully pre-configured, battery-included Lisp IDE like Portacle without any manual setup or learning curve.
Teams needing collaborative features, integrated version control, or project management tools within the editor environment.
Developers already proficient with other editors (e.g., Vim, VS Code) who want Lisp support without switching to or learning Emacs.
Projects requiring advanced debugging, profiling, or IDE features beyond basic SLIME and REPL interaction, such as graphical debuggers or performance analysis tools.

Pros & Cons

Pros

Quick and Automated Setup

A single .emacs file automates installation of essential packages like SLIME, Paredit, and Rainbow Delimiters, enabling a functional Common Lisp environment in minutes as demonstrated in the Get Started section.

Educational Transparency

The line-by-line explanation in the README demystifies each configuration step, helping users understand and later customize their Emacs setup, which promotes a DIY learning approach.

Lightweight and Minimal

Focuses only on core Lisp development tools, avoiding bloat and making the configuration easy to grasp and modify, with optional UI tweaks like theme selection and toolbar removal.

Integrated Essential Tools

Includes Paredit for structured editing and Rainbow Delimiters for visual clarity, enhancing the Common Lisp programming experience out of the box without additional setup.

Cons

Platform-Specific Hurdles

On macOS, launching Emacs from the GUI can fail to find SBCL due to path issues, requiring manual workarounds like adding /usr/local/bin to exec-path, as noted in the Inferior Lisp Program section.

Opinionated Defaults

Forces Paredit and Rainbow Delimiters on users by default, which some developers find intrusive or distracting, and the README acknowledges these tools are not universally liked in the Opinion References.

Limited Feature Set

Misses advanced Emacs packages for project management, modern debugging, or integration with other development tools, sticking to a basic setup that may require expansion for complex projects.

External Dependencies

Requires separate manual installation of SBCL and Quicklisp, which isn't automated by the .emacs file, adding extra steps and potential confusion for absolute beginners.

Open Source Alternative To

Emacs4CL is an open-source alternative to the following products:

Portacle

Portacle is a portable, cross-platform development environment for Common Lisp that bundles Emacs, SBCL, Quicklisp, and Git.

Frequently Asked Questions

Related Projects

Sly

Sylvester the Cat's Common Lisp IDE

Stars1,421

Forks154

Last commit3 months ago

Slite

a SLIme-based TEst runner for FiveAM and Parachute Tests

Stars61

Forks4

Last commit1 year ago

Quicklisp systems

Search, browse and load Quicklisp systems from Emacs.

Stars30

Forks1

Last commit3 years ago

SLIME doc contrib

Documentation contribs for SLIME (the Superior Lisp Interaction Mode for Emacs)

Stars26

Forks6

Last commit10 months ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub