clfoundation/cmucl repository overview

⁠Supported Tags

⁠Simple Tags

• 21d 21d-bullseye 21d-buster 21d-slim 21d-slim-bullseye 21d-slim-buster 21d-slim-stretch 21d-stretch
• 21f 21f-bookworm 21f-bookworm-slim 21f-trixie 21f-trixie-slim

⁠Shared Tags

• latest
  • 21f

⁠Quick Reference

CMUCL Home Page
http://cmucl.org⁠

Where to file Docker image related issues
https://gitlab.common-lisp.net/cl-docker-images/cmucl⁠

Where to file issues for CMUCL itself
https://gitlab.common-lisp.net/cmucl/cmucl/⁠

Maintained by
CL Docker Images Project⁠

Supported platforms
linux/amd64

⁠What is CMUCL?

From CMUCL's Home Page⁠

⁠How to use this image

⁠Create a Dockerfile in your CMUCL project

FROM clfoundation/cmucl:latest
COPY . /usr/src/app
WORKDIR /usr/src/app
CMD [ "cmucl", "-load", "./your-daemon-or-script.lisp" ]

You can then build and run the Docker image:

$ docker build -t my-cmucl-app
$ docker run -it --rm --name my-running-app my-cmucl-app

⁠Run a single Common Lisp script

For many simple, single file projects, you may find it inconvenient to write a complete Dockerfile. In such cases, you can run a Lisp script by using the CMUCL Docker image directly:

$ docker run -it --rm --name my-running-script -v "$PWD":/usr/src/app -w /usr/src/app clfoundation/cmucl:latest cmucl -load ./your-daemon-or-script.lisp

⁠Developing using SLIME

SLIME⁠ provides a convenient and fun environment for hacking on Common Lisp. To develop using SLIME, first start the Swank server in a container:

$ docker run -it --rm --name cmucl-slime -p 127.0.0.1:4005:4005 -v /path/to/slime:/usr/src/slime -v "$PWD":/usr/src/app -w /usr/src/app clfoundation/cmucl:latest cmucl -load /usr/src/slime/swank-loader.lisp -eval '(swank-loader:init)' -eval '(swank:create-server :dont-close t :interface "0.0.0.0")'

Then, in an Emacs instance with slime loaded, type:

M-x slime-connect RET RET RET

⁠What's in the image?

This image contains CMUCL binaries provided by the CMUCL devs.

⁠Image variants

This image comes in several variants, each designed for a specific use case.

⁠clfoundation/cmucl:<version>

This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.

Some of these tags may have names like trixie or bookworm in them. These are the suite code names for releases of Debian and indicate which release the image is based on. If your image needs to install any additional packages beyond what comes with the image, you'll likely want to specify one of these explicitly to minimize breakage when there are new releases of Debian.

These images are built off the buildpack-deps image. It, by design, has a large number of extremely common Debian packages.

These images contain the Quicklisp installer, located at /usr/local/share/common-lisp/source/quicklisp/quicklisp.lisp. Additionally, there is a script at /usr/local/bin/install-quicklisp that will use the bundled installer to install Quicklisp. You can configure the Quicklisp install with the following environment variables:

QUICKLISP_DIST_VERSION
The dist version to use. Of the form yyyy-mm-dd. latest means to install the latest version (the default).

QUICKLISP_CLIENT_VERSION
The client version to use. Of the form yyyy-mm-dd. latest means to install the latest version (the default).

QUICKLISP_ADD_TO_INIT_FILE
If set to true, (ql:add-to-init-file) is used to add code to the implementation's user init file to load Quicklisp on startup. Not set by default.

Additionally, these images contain cl-launch to provide a uniform interface to running a Lisp implementation without caring exactly which implementation is being used (for instance to have uniform CI scripts).

⁠clfoundation/cmucl:<version>-slim

This image does not contain the common packages contained in the default tag and only contains the minimal packages needed to run CMUCL. Unless you are working in an environment where only this image will be deployed and you have space constraints, we highly recommend using the default image of this repository.

⁠License

CMUCL is freely redistributable: free, with full source code (most of which is in the public domain) and no strings attached (and no warranty).

The Dockerfiles used to build the images are licensed under BSD-2-Clause.

As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.