joaotavora / Sly

          _____    __   __  __        
         / ___/   / /   \ \/ /               |\      _,,,---,,_
         \__ \   / /     \  /                /,`.-'`'    -.  ;-;;,_
        ___/ /  / /___   / /                |,4-  ) )-,_..;\ (  `'-'
       /____/  /_____/  /_/                '---''(_/--'  `-'\_)

SLY is Sylvester the Cat's Common Lisp IDE for Emacs:

• 🤔 Read a short illustrated guide
• 📽️ Scroll down this README for some pretty gifs
• 📣 Read the NEWS file
• 📚 Read the manual

SLY's highlights are:

• A full-featured REPL based on Emacs's comint.el. Everything can be copied to the REPL;
• Stickers, or live code annotations that record values as code traverses them.
• Flex-style completion out-of-the-box, using Emacs's completion API. Company, Helm, and other supported natively, no plugin required;
• An interactive Trace Dialog;
• Cleanly ASDF-loaded by default, including contribs, enabled out-of-the-box;
• Multiple inspectors and multiple REPLs;
• "Presentations" replaced by interactive backreferences which highlight the object and remain stable throughout the REPL session;
• Support for NAMED-READTABLES, macrostep.el and quicklisp
• A portable, annotation-based stepper in early but functional prototype stage.

SLY is a fork of SLIME. We tracks its bugfixes, particularly to the implementation backends. All SLIME's familar features (debugger, inspector, xref, etc...) are still available, with improved overall UX.

Installation

Ensure that MELPA is setup as usual and ask M-x package-install to install the package sly.

That's it. sly-mode will automatically come up in every .lisp file. To fire up SLY, connect to a Lisp and get a friendly REPL, use M-x sly.

Even if you already have SLIME installed, SLY will ask you and temporarily disable it for the Emacs session.

Obligatory animated gif section

Flex completion

Backreferences

Reverse i-search

Stickers

Install from git

Clone this repository, add this to your ~/.emacs file and fill in the appropriate file names:

(add-to-list 'load-path "~/dir/to/cloned/sly")
(require 'sly-autoloads)
(setq inferior-lisp-program "/opt/sbcl/bin/sbcl")

If you wish to byte-compile SLY yourself (not needed generally) you can do make compile compile-contrib in the dir where you cloned SLY.

Running the server standalone

This also works

$ sbcl
...
* (push #p"~/dir/to/sly" asdf:*central-registry*)
* (asdf:load-system :slynk)
* (slynk:create-server :port 4008)

Now in Emacs you can do sly-connect and give it the host and the 4008 port as a destination.

Faster startup

If the Lisp program doesn't start fast enough for you, look in the manual, for ways to make it faster.

Additional Contribs

• https://github.com/joaotavora/sly-quicklisp
• https://github.com/joaotavora/sly-named-readtables
• https://github.com/joaotavora/sly-macrostep
• https://github.com/joaotavora/sly-stepper
• https://github.com/mmgeorge/sly-asdf
• https://github.com/40ants/sly-package-inferred

Completion UIs

SLY works with most Emacs "completion UIs" out of the box, providing completion in source files and inputting Common Lisp symbol names from the minibuffer. Company, Emacs 27's Fido-mode, and Helm are well-supported, as is "vanilla" completion. For consistency, SLY defaults to its own UI, sly-symbol-completion-mode, useful if you don't have or like any of those. You can turn it off. Also, if you use Helm and wish to have even more Helm-based fanciness, you can use helm-sly.

License

SLY is free software. All files, unless explicitly stated otherwise, are public domain. ASCII artwork is copyright by Felix Lee, Joan G. Stark and Hayley Jane Wakenshaw.

Fork

SLIME is the work of Eric Marsden, Luke Gorrie, Helmut Eller, Tobias C. Rittweiler and many others. I forked SLIME because I used it daily, for work, had a long list of hacks developed for myself, and wanted to share them with others.

In 2013, SLIME development was stalling, patches and issues rotting. In early 2014, Luís Oliveira and myself moved SLIME to Github and set up its Travis CI system. I brought in the old bug reports from the Launchpad tracker, fixed long-standing problems and submitted many changes, particularly to the under-curated but popular "contrib" section.

Now, the changes that SLY brings to the table are too deep at the Elisp and Lisp level to be accepted to SLIME, given its current focus on stability (for the record, I find this perfectly reasonable). The new features, such as stickers or multiple inspectors, cannot be realized well using only the existing "contrib" system. Finally, SLY frees itself from the shackles of Emacs 23 and supports Emacs 24.3+ only, allowing for much cleaner code and liberal use of lexical binding.

The list of technical reasons is bigger than this though, and you can read up on them in the CONTRIBUTING.md file.

Contributing

Open an issue or a pull request, but at least have a quick look at the first part CONTRIBUTING.md file for instructions on how to contribute.