Thanks to visit codestin.com
Credit goes to Github.com

Skip to content

atgreen/icl

Repository files navigation

ICL - Interactive Common Lisp

ICL is an enhanced REPL for Common Lisp. It provides a modern interactive experience with readline-style editing, persistent history, tab completion, and an extensible command system. ICL works in your terminal or in a web browser with an IDE-style interface featuring package browsing, symbol inspection, and an integrated REPL.

ICL Demo

Features

  • Syntax highlighting - Colorized input with distinct colors for keywords, strings, comments, numbers, and symbols
  • Parenthesis matching - Real-time highlighting of matching parentheses as you type
  • Paredit mode - Structural editing with auto-close parens, safe deletion, and sexp navigation
  • Multi-line input - Automatically detects incomplete expressions with smart indentation
  • Persistent history - Command history saved across sessions
  • Tab completion - Complete symbols, package-qualified names, and keywords
  • Command system - Built-in commands prefixed with comma (e.g., ,help)
  • Multiple Lisp support - Works with SBCL, CCL, ECL, CLISP, ABCL, Clasp, and Roswell
  • Error backtraces - Automatic backtrace capture with ,bt command to view stack traces
  • Thread inspection - List and inspect threads in the inferior Lisp
  • Documentation lookup - Quick access to function docs and apropos search
  • Interactive object inspector - TUI for exploring objects with keyboard navigation
  • Tracing - Enable/disable function tracing
  • Source location - Find where functions are defined
  • Terminal-aware colors - Automatically detects light/dark terminal background
  • AI integration - Use ,explain to get AI-powered explanations of code, errors, and results
  • Browser interface - IDE-style web UI with package browser, symbol list, inspector, and xterm.js terminal

Installation

Pre-built Binaries

Download from GitHub Releases:

Platform Formats
Linux RPM, DEB
Windows ZIP, EXE installer, MSI installer

Roswell users can also install with ros install atgreen/icl.

Building from Source

git clone https://github.com/atgreen/icl.git
cd icl
ocicl install
make

Requires SBCL, ocicl, and libfixposix-devel.

Usage

Start ICL (auto-detects available Lisp):

icl

Specify a Lisp implementation:

icl --lisp ccl
icl --lisp ecl
icl --lisp roswell  # Use Roswell's managed environment

Evaluate an expression and exit:

icl -e '(+ 1 2 3)'

Load a file before starting the REPL:

icl -l init.lisp

Connect to an existing Slynk server:

icl --connect localhost:4005

Skip loading config file:

icl --no-config

Start with browser interface (opens IDE alongside terminal REPL):

icl -b

Commands

Commands are prefixed with a comma. Type ,help for a full list.

Navigation

Command Description
,cd <package> Change current package
,pwd Show current package
,ls [filter] List symbols (filters: functions, macros, variables, classes)

Documentation

Command Description
,doc <symbol> Show documentation
,describe <symbol> Full description of symbol
,apropos <pattern> Search for matching symbols
,arglist <function> Show function arguments
,source <symbol> Show source location
,edit <symbol> Open source in $EDITOR (alias: ,ed)

Cross-Reference (Xref)

Command Description
,callers <symbol> Show functions that call symbol (alias: ,xc)
,callees <symbol> Show functions called by symbol (alias: ,xe)
,references <symbol> Show code that references variable (alias: ,xr)

Inspection

Command Description
,inspect <expr> Interactive object inspector (alias: ,i)
,i Inspect last result (*)
,inspect-static <expr> Non-interactive inspection output
,slots <expr> Show slots of a class instance

The interactive inspector (,i or ,inspect) provides a TUI for exploring objects:

Key Action
/ or j/k Navigate entries
Enter Drill into selected entry
b or Backspace Go back to parent object
q or Escape Quit inspector

Macros

Command Description
,macroexpand <form> Expand macro once
,macroexpand-all <form> Fully expand all macros

Development

Command Description
,load-system <name> Load system via ocicl/Quicklisp/ASDF (alias: ,ql)
,libyear Show dependency freshness metric (requires ocicl)
,changes [system] Show LLM-generated changelogs (requires ocicl)
,time <form> Time expression evaluation
,load <file> Load a Lisp file
,compile-file <file> Compile a file
,disassemble <fn> Disassemble a function

Debugging

Command Description
,bt Show backtrace from last error
,step <form> Show traced function calls during evaluation
,threads List all threads in inferior Lisp
,trace <function> Enable tracing
,untrace <function> Disable tracing
,untrace-all Disable all tracing

Profiling (SBCL only)

Command Description
,profile <form> Profile a form with the statistical profiler
,profile-start Start ongoing profiling
,profile-stop Stop profiling and show results
,profile-reset Reset profiler data
,flame <form> Profile and show interactive flame graph in browser

The ,flame command (aliases: ,flamegraph, ,fg) profiles the expression and opens an interactive Speedscope flame graph in the browser. Requires browser mode (,browser or icl -b).

Browser Visualization

Command Description
,browser Start browser-based IDE interface
,viz <expr> Visualize data in browser (class hierarchies, hash-tables, FSet sets)

The ,viz command automatically detects the type and displays an appropriate visualization:

  • Class names: 'standard-object → interactive class hierarchy graph with slots
  • Hash-tables: *my-ht* → key-value table
  • FSet sets: *my-set* → circle with members listed inside

Venn Diagrams for FSet Sets

Visualize one or more FSet sets as Venn diagrams:

,viz *fruits*                    ; Single set as circle with members
,viz *fruits* *red-things*       ; Two-set Venn diagram showing overlap
,viz *set-a* *set-b* *set-c*     ; Three-set Venn diagram
  • Single set: Circle displaying members inside
  • Two sets: Classic Venn diagram with left-only, intersection, and right-only regions
  • Three sets: Triangle arrangement showing all 7 regions with counts

Venn diagrams automatically refresh after each REPL evaluation to reflect data changes.

Class Hierarchy Graph

The class hierarchy graph supports interactive exploration:

  • Click a node to see available subclasses and add them one at a time
  • Hover over a node to highlight all ancestor classes up to the root
  • Drag to pan, scroll to zoom the graph

Configuration

Command Description
,show-config Show config file location and customization options
,reload-config Reload config file
,paredit [on/off] Toggle paredit structural editing mode

Session

Command Description
,help Show all commands
,info Show session information
,history Show value history variables
,lisp [name] Show or switch Lisp backend
,clear Clear terminal
,quit Exit ICL

AI Integration

Command Description
,explain Explain last result or error using AI
,explain <code> Explain specific code
,ai-cli [name] Show or set AI backend (gemini, claude, codex)

The ,explain command uses an AI CLI (auto-detected from PATH) to provide explanations of Lisp code, errors, and results. When using Gemini or Claude CLI, ICL provides an MCP server that gives the AI read-only access to the live Lisp environment - it can query documentation, describe symbols, and search for functions, but cannot execute any code.

Requires one of: Gemini CLI, Claude CLI, or Codex CLI

History Variables

ICL maintains history of recent values and inputs:

Variable Description
icl:_ / icl:icl-* Last result
icl:__ / icl:icl-** Second-to-last result
icl:___ / icl:icl-*** Third-to-last result
icl:icl-+ Last input form
icl:icl-/ Last returned values (all values)

Configuration

ICL loads a config file on startup (unless --no-config is specified). This file can contain any Common Lisp code.

Config file locations:

  • Linux/macOS: $XDG_CONFIG_HOME/icl/config.lisp (default: ~/.config/icl/config.lisp)
  • Windows: %APPDATA%\icl\config.lisp

History file locations:

  • Linux/macOS: $XDG_STATE_HOME/icl/history (default: ~/.local/state/icl/history)
  • Windows: %LOCALAPPDATA%\icl\history

Use ,show-config to see the actual paths on your system.

Configuration Variables

Variable Description
*default-lisp* Lisp implementation to use (:sbcl, :ccl, :ecl, :clisp, :abcl, :clasp, :roswell)
*prompt-string* Prompt format string (default: "~A> ")
*result-prefix* Prefix for results (default: "=> ")
*colors-enabled* Enable syntax coloring (default: t)
*history-size* Maximum history entries (default: 1000)
*paredit-mode* Enable structural editing (default: nil)
*ai-cli* AI CLI for ,explain (:gemini, :claude, :codex, or :auto)

Customizing Lisp Invocation

Use configure-lisp to customize how ICL invokes a Lisp implementation:

(icl:configure-lisp impl &key program args eval-arg)
  • :program - Path to the executable
  • :args - List of command-line arguments
  • :eval-arg - The eval flag (e.g., "--eval")

Example Config File

;; Use CCL instead of SBCL
(setf icl:*default-lisp* :ccl)

;; Custom SBCL with more memory
(icl:configure-lisp :sbcl
  :program "/opt/sbcl/bin/sbcl"
  :args '("--dynamic-space-size" "8192"))

;; Enable paredit mode
(setf icl:*paredit-mode* t)

;; Custom prompt
(setf icl:*prompt-string* "λ ~A> ")

;; Load commonly used systems
(asdf:load-system :alexandria)

;; Define custom utilities
(defun reload ()
  (asdf:load-system :my-project :force t))

Keyboard Shortcuts

Key Description
Enter Submit form if complete, otherwise insert newline
Alt+Enter Always insert newline (works in most terminals)
Shift+Enter Always insert newline (requires kitty keyboard protocol)
Tab Complete symbol or show completion menu
Ctrl+A / Home Move to beginning of line
Ctrl+E / End Move to end of line
Ctrl+K Kill to end of line
Ctrl+U Clear entire line
Ctrl+L Clear screen
Ctrl+D Delete character at cursor, or EOF if line empty (Emacs-style)
Ctrl+C Cancel current input
Ctrl+R Reverse history search (substring match)
Ctrl+G Cancel search
Up/Down Navigate history (on first/last line) or move cursor
Alt+P History search backward (prefix match)
Alt+N History search forward (prefix match)
Alt+Q Reindent current form
Alt+F Forward sexp (paredit mode only)
Alt+B Backward sexp (paredit mode only)

Notes:

  • In paredit mode, Enter only submits when the cursor is at the end of the buffer (allowing multi-line editing of balanced forms)
  • Use Alt+Enter in gnome-terminal and most other terminals. Shift+Enter only works in terminals with kitty keyboard protocol support (kitty, WezTerm, Alacritty, etc.).

Environment Variables

Variable Description
ICL_SLYNK_PATH Override path to Slynk directory
ICL_ASDF_PATH Override path to bundled ASDF (for backends without ASDF)
ICL_BACKGROUND Override terminal background detection (dark or light)
NO_COLOR When set to any non-empty value, disables colored output (see no-color.org)

Supported Lisp Implementations

ICL aims to support multiple Common Lisp implementations. SBCL is the primary development and testing platform.

Implementation Status
SBCL Tested
CCL Tested
ECL Tested
ABCL Tested
Roswell Tested
Clasp Untested
CLISP Experimental

Architecture

ICL operates as a frontend that communicates with a backend Lisp process via the Slynk protocol (from SLY). This architecture allows ICL to work with any Common Lisp implementation, provide consistent features regardless of backend, and connect to remote Lisp processes.

┌──────────────────────────────────┐   ┌──────────────────────────────────┐
│          USER TERMINAL           │   │          WEB BROWSER             │
│                                  │   │  ┌────────────────────────────┐  │
│  $ icl                           │   │  │  Packages │ Symbols │ Insp │  │
│  COMMON-LISP-USER> _             │   │  ├───────────┴─────────┴──────┤  │
│                                  │   │  │     xterm.js Terminal      │  │
│                                  │   │  │  COMMON-LISP-USER> _       │  │
└────────────────┬─────────────────┘   └──┼────────────────────────────┴──┘
                 │                        │
                 │ stdin/stdout           │ WebSocket + HTTP
                 │                        │ (localhost:random-port)
                 ▼                        ▼
┌─────────────────────────────────────────────────────────────────────────┐
│                                 ICL                                     │
│                       (Interactive Common Lisp)                         │
│                                                                         │
│  ┌─────────────┐  ┌─────────────┐  ┌─────────────┐  ┌─────────────┐     │
│  │  Multiline  │  │   Command   │  │     Tab     │  │   History   │     │
│  │   Editor    │  │ Dispatcher  │  │ Completion  │  │   Manager   │     │
│  └─────────────┘  └─────────────┘  └─────────────┘  └─────────────┘     │
│                                                                         │
│  ┌───────────────────────────┐  ┌────────────────┐  ┌───────────────┐   │
│  │      Slynk Client         │  │ Browser Server │  │ MCP Server    │   │
│  │  (Backend Communication)  │  │  (Hunchentoot) │  │ (AI Tools)    │   │
│  └─────────────┬─────────────┘  └────────────────┘  └───────▲───────┘   │
└────────────────┼────────────────────────────────────────────┼───────────┘
                 │                                            │
                 │ Slynk Protocol                             │ HTTP (MCP)
                 │ (localhost:random-port)                    │
                 │                                            │
                 ▼                                            │
┌────────────────────────────────┐  ┌─────────────────────────┴───────────┐
│        INFERIOR LISP           │  │          AI CLI TOOLS               │
│       (Backend Process)        │  │                                     │
│                                │  │  ┌─────────┐ ┌────────┐ ┌────────┐  │
│  ┌──────────────────────────┐  │  │  │ Claude  │ │ Gemini │ │ Codex  │  │
│  │      Slynk Server        │  │  │  │   CLI   │ │  CLI   │ │  CLI   │  │
│  │                          │  │  │  └────┬────┘ └───┬────┘ └───┬────┘  │
│  │  • Evaluation            │  │  │       └──────────┼──────────┘       │
│  │  • Completion            │  │  │                  │                  │
│  │  • Xref                  │  │  │                  ▼                  │
│  │  • Inspection            │  │  │  ┌───────────────────────────────┐  │
│  │  • Macroexpansion        │  │  │  │    MCP Protocol Client        │  │
│  └──────────────────────────┘  │  │  │                               │  │
│                                │  │  │  Read-only tools:             │  │
│  ┌──────────────────────────┐  │  │  │  • get_documentation          │  │
│  │   User's Lisp Image      │  │  │  │  • describe_symbol            │  │
│  │                          │  │  │  │  • apropos_search             │  │
│  │  • Loaded libraries      │  │  │  │  • get_function_arglist       │  │
│  │  • User definitions      │  │  │  │  • get_repl_history           │  │
│  │  • REPL state            │  │  │  │  • list/read_project_files    │  │
│  └──────────────────────────┘  │  │  └───────────────────────────────┘  │
│                                │  │                                     │
│  SBCL │ CCL │ ECL │ ABCL │ ... │  │  AI cannot execute code             │
└────────────────────────────────┘  └─────────────────────────────────────┘

All connections use randomly-assigned ports on localhost. When ICL starts an inferior Lisp, it finds an available port and configures Slynk to listen there. The browser interface (started with ,browser or icl -b) serves a Dockview-based IDE with package browser, symbol list, inspector panels, and class hierarchy visualization. The browser automatically closes when ICL terminates. The MCP server (started on-demand by ,explain) provides read-only AI tool integration.

License

MIT License. See LICENSE file for details.

Author

Anthony Green [email protected]

About

Interactive Common Lisp: an enhanced REPL

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •