The cl-info Reference Manual

This is the cl-info Reference Manual, version 0.5.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Tue Jul 15 03:59:22 2025 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 cl-info

A helper to an answer a question about OS, Lisp and Everything.

Author

Alexander Artemenko <>

Home Page

https://40ants.com/cl-info

Source Control

(GIT https://github.com/40ants/cl-info)

Bug Tracker

https://github.com/40ants/cl-info/issues

License

Unlicense

Long Description

<a id="x-28CL-INFO-DOCS-2FINDEX-3A-40README-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

# CL-INFO - Common Lisp Environment Reporter

<a id="cl-info-asdf-system-details"></a>

## CL-INFO ASDF System Details

* Description: A helper to an answer a question about ‘OS‘, Lisp and Everything.
* Licence: Unlicense
* Author: Alexander Artemenko <svetlyak.40wt@gmail.com>
* Homepage: [https://40ants.com/cl-info][c5b1]
* Bug tracker: [https://github.com/40ants/cl-info/issues][eaff]
* Source control: [GIT][c2be]

[![](https://github-actions.40ants.com/40ants/cl-info/matrix.svg?only=ci.run-tests)][3904]

![](http://quickdocs.org/badge/cl-info.svg)

This is a small utility, useful to display information about you Common
Lisp environment. You might want to call it in the ‘CI‘ pipeline or
to use it when rendering a crash report in some client applications.

<a id="x-28CL-INFO-DOCS-2FINDEX-3A-3A-40INSTALLATION-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

## Installation

You can install this library from Quicklisp, but you want to receive updates quickly, then install it from Ultralisp.org:

“‘
(ql-dist:install-dist "http://dist.ultralisp.org/"
:prompt nil)
(ql:quickload :cl-info)
“‘
Or you can install the script using Roswell:

“‘
ros install 40ants/cl-info
“‘
<a id="x-28CL-INFO-DOCS-2FINDEX-3A-3A-40USAGE-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

## Usage

<a id="usage-from-common-lisp"></a>

### Usage from Common Lisp

It’s main entry point is [‘cl-info:get-cl-info‘][5b06] function. It returns an object with
customized ‘PRINT-OBJECT‘ method. You can use it to output debug
information in your programs.

‘cl-info‘ ([‘1‘][047c] [‘2‘][32e1]) collects inforrmation about ‘OS‘, Lisp Implementation, ‘ASDF‘, installed Quicklisp distributions:

“‘text
CL-USER> (cl-info:get-cl-info)
OS: Darwin 15.6.0
Lisp: SBCL 1.4.8
ASDF: 3.3.1.1
QL: ceramic github-e0d905187946f8f2358f7b05e1ce87b302e34312
cl-prevalence github-c163c227ed85d430b82cb1e3502f72d4f88e3cfa
log4cl-json github-c4f786e252d89a45372186aaf32fb8e8736b444b
log4cl github-6a857b0b41c030a8a3b04096205e221baaa1755f
quicklisp 2018-04-30
slynk github-3314cf8c3021cb758e0e30fe3ece54accf1dcf3d
weblocks-lass github-1b043afbf2f3e84e495dfeae5e63fe67a435019f
weblocks-parenscript github-8ef4ca2f837403a05c4e9b92dcf1c41771d16f17
weblocks-ui github-5afdf238534d70edc2447d0bc8bc63da8e35999f
weblocks-websocket github-b098db7f179dce3bfb045afd4e35e7cc868893f0
weblocks github-282483f97d6ca351265ebfebb017867c295d01ad
websocket-driver github-a3046b11dfb9803ac3bff7734dd017390c2b54bb
CL-USER>
“‘
Also, you can gather information about separate systems using [‘cl-info:get-system-info‘][9306]
function:

“‘text
CL-USER> (cl-info:get-system-info :hamcrest)
System: HAMCREST 0.4.2
/Users/art/common-lisp/cl-hamcrest/src/
“‘
<a id="usage-from-command-line"></a>

### Usage From Command-line

Also, you can use ‘cl-info‘ ([‘1‘][047c] [‘2‘][32e1]) as a command-line utility. It is useful to
output information about common lisp environment running on ‘CI‘ server.

Here is how to do it:

“‘shell
# Here we use a Roswell, to install utility
[art@art-osx:~]% ros install 40ants/cl-info

# And now request information about lisp and some systems
[art@art-osx:~]% cl-info weblocks clack jonathan some-other-system
OS: Darwin 15.6.0
Lisp: Clozure Common Lisp Version 1.11.5/v1.11.5 (DarwinX8664)
ASDF: 3.3.1.1
QL: org.borodust.bodge 20180214223017
quicklisp 2017-10-23
System: weblocks 0.31.1
/Users/art/common-lisp/weblocks/src/
System: clack 2.0.0
/Users/art/common-lisp/clack/
System: jonathan 0.1
/Users/art/.roswell/lisp/quicklisp/dists/quicklisp/software/jonathan-20170630-git/
System: some-other-system is not available
“‘
<a id="x-28CL-INFO-DOCS-2FINDEX-3A-3A-40API-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

## API

<a id="x-28CL-INFO-DOCS-2FINDEX-3A-3A-40CL-INFO-3FPACKAGE-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

### CL-INFO

<a id="x-28-23A-28-287-29-20BASE-CHAR-20-2E-20-22CL-INFO-22-29-20PACKAGE-29"></a>

#### [package](ff28) ‘cl-info‘

<a id="x-28CL-INFO-DOCS-2FINDEX-3A-3A-7C-40CL-INFO-3FClasses-SECTION-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

#### Classes

<a id="x-28CL-INFO-DOCS-2FINDEX-3A-3A-40CL-INFO-24CL-INFO-3FCLASS-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

##### CL-INFO

<a id="x-28CL-INFO-3ACL-INFO-20CLASS-29"></a>

###### [class](e363) ‘cl-info:cl-info‘ ()

**Readers**

<a id="x-28CL-INFO-3AGET-ASDF-VERSION-20-2840ANTS-DOC-2FLOCATIVES-3AREADER-20CL-INFO-3ACL-INFO-29-29"></a>

###### [reader](12cb) ‘cl-info:get-asdf-version‘ (cl-info) (= (asdf/upgrade:asdf-version))

Returns ‘ASDF‘ version.

<a id="x-28CL-INFO-3AGET-LISP-TYPE-20-2840ANTS-DOC-2FLOCATIVES-3AREADER-20CL-INFO-3ACL-INFO-29-29"></a>

###### [reader](759d) ‘cl-info:get-lisp-type‘ (cl-info) (= (lisp-implementation-type))

<a id="x-28CL-INFO-3AGET-LISP-VERSION-20-2840ANTS-DOC-2FLOCATIVES-3AREADER-20CL-INFO-3ACL-INFO-29-29"></a>

###### [reader](888e) ‘cl-info:get-lisp-version‘ (cl-info) (= (lisp-implementation-version))

<a id="x-28CL-INFO-3AGET-QL-DISTS-20-2840ANTS-DOC-2FLOCATIVES-3AREADER-20CL-INFO-3ACL-INFO-29-29"></a>

###### [reader](42de) ‘cl-info:get-ql-dists‘ (cl-info) (= (ql-dist:all-dists))

<a id="x-28CL-INFO-3AGET-SOFTWARE-TYPE-20-2840ANTS-DOC-2FLOCATIVES-3AREADER-20CL-INFO-3ACL-INFO-29-29"></a>

###### [reader](f2c2) ‘cl-info:get-software-type‘ (cl-info) (= (software-type))

<a id="x-28CL-INFO-3AGET-SOFTWARE-VERSION-20-2840ANTS-DOC-2FLOCATIVES-3AREADER-20CL-INFO-3ACL-INFO-29-29"></a>

###### [reader](6e31) ‘cl-info:get-software-version‘ (cl-info) (= (software-version))

<a id="x-28CL-INFO-DOCS-2FINDEX-3A-3A-40CL-INFO-24SYSTEM-INFO-3FCLASS-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

##### SYSTEM-INFO

<a id="x-28CL-INFO-3ASYSTEM-INFO-20CLASS-29"></a>

###### [class](272e) ‘cl-info:system-info‘ ()

**Readers**

<a id="x-28CL-INFO-3AABSENT-P-20-2840ANTS-DOC-2FLOCATIVES-3AREADER-20CL-INFO-3ASYSTEM-INFO-29-29"></a>

###### [reader](44e1) ‘cl-info:absent-p‘ (system-info) (:absent = nil)

<a id="x-28CL-INFO-3AGET-NAME-20-2840ANTS-DOC-2FLOCATIVES-3AREADER-20CL-INFO-3ASYSTEM-INFO-29-29"></a>

###### [reader](eca5) ‘cl-info:get-name‘ (system-info) (:name)

<a id="x-28CL-INFO-3AGET-PATH-20-2840ANTS-DOC-2FLOCATIVES-3AREADER-20CL-INFO-3ASYSTEM-INFO-29-29"></a>

###### [reader](abe2) ‘cl-info:get-path‘ (system-info) (:path)

<a id="x-28CL-INFO-3AGET-VERSION-20-2840ANTS-DOC-2FLOCATIVES-3AREADER-20CL-INFO-3ASYSTEM-INFO-29-29"></a>

###### [reader](6e40) ‘cl-info:get-version‘ (system-info) (:version)

<a id="x-28CL-INFO-DOCS-2FINDEX-3A-3A-7C-40CL-INFO-3FFunctions-SECTION-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

#### Functions

<a id="x-28CL-INFO-3AGET-CL-INFO-20FUNCTION-29"></a>

##### [function](754d) ‘cl-info:get-cl-info‘

Returns information about lisp implementation, asdf and quicklisp.

<a id="x-28CL-INFO-3AGET-SYSTEM-INFO-20FUNCTION-29"></a>

##### [function](e6d1) ‘cl-info:get-system-info‘ system-name

[c5b1]: https://40ants.com/cl-info
[047c]: https://40ants.com/cl-info/#x-28-23A-28-287-29-20BASE-CHAR-20-2E-20-22CL-INFO-22-29-20PACKAGE-29
[32e1]: https://40ants.com/cl-info/#x-28-23A-28-287-29-20BASE-CHAR-20-2E-20-22cl-info-22-29-20ASDF-2FSYSTEM-3ASYSTEM-29 [5b06]: https://40ants.com/cl-info/#x-28CL-INFO-3AGET-CL-INFO-20FUNCTION-29
[9306]: https://40ants.com/cl-info/#x-28CL-INFO-3AGET-SYSTEM-INFO-20FUNCTION-29
[c2be]: https://github.com/40ants/cl-info
[3904]: https://github.com/40ants/cl-info/actions
[ff28]: https://github.com/40ants/cl-info/blob/b968de002e83818b16d30f4918a3210f1ffdf7fb/src/core.lisp#L1
[e363]: https://github.com/40ants/cl-info/blob/b968de002e83818b16d30f4918a3210f1ffdf7fb/src/core.lisp#L21
[12cb]: https://github.com/40ants/cl-info/blob/b968de002e83818b16d30f4918a3210f1ffdf7fb/src/core.lisp#L22
[759d]: https://github.com/40ants/cl-info/blob/b968de002e83818b16d30f4918a3210f1ffdf7fb/src/core.lisp#L25
[888e]: https://github.com/40ants/cl-info/blob/b968de002e83818b16d30f4918a3210f1ffdf7fb/src/core.lisp#L27
[f2c2]: https://github.com/40ants/cl-info/blob/b968de002e83818b16d30f4918a3210f1ffdf7fb/src/core.lisp#L29
[6e31]: https://github.com/40ants/cl-info/blob/b968de002e83818b16d30f4918a3210f1ffdf7fb/src/core.lisp#L31
[42de]: https://github.com/40ants/cl-info/blob/b968de002e83818b16d30f4918a3210f1ffdf7fb/src/core.lisp#L34
[272e]: https://github.com/40ants/cl-info/blob/b968de002e83818b16d30f4918a3210f1ffdf7fb/src/core.lisp#L43
[eca5]: https://github.com/40ants/cl-info/blob/b968de002e83818b16d30f4918a3210f1ffdf7fb/src/core.lisp#L44
[6e40]: https://github.com/40ants/cl-info/blob/b968de002e83818b16d30f4918a3210f1ffdf7fb/src/core.lisp#L46
[abe2]: https://github.com/40ants/cl-info/blob/b968de002e83818b16d30f4918a3210f1ffdf7fb/src/core.lisp#L48
[44e1]: https://github.com/40ants/cl-info/blob/b968de002e83818b16d30f4918a3210f1ffdf7fb/src/core.lisp#L50
[754d]: https://github.com/40ants/cl-info/blob/b968de002e83818b16d30f4918a3210f1ffdf7fb/src/core.lisp#L93
[e6d1]: https://github.com/40ants/cl-info/blob/b968de002e83818b16d30f4918a3210f1ffdf7fb/src/core.lisp#L98
[eaff]: https://github.com/40ants/cl-info/issues

* * *
###### [generated by [40ANTS-DOC](https://40ants.com/doc/)]

Version

0.5.0

Defsystem Dependency

40ants-asdf-system (system).

Dependency

cl-info/core (system).

Source

cl-info.asd.


2.2 cl-info/core

Author

Alexander Artemenko <>

Home Page

https://40ants.com/cl-info

Source Control

(GIT https://github.com/40ants/cl-info)

Bug Tracker

https://github.com/40ants/cl-info/issues

License

Unlicense

Source

cl-info.asd.


3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


3.1 Lisp


3.1.1 cl-info/cl-info.asd

Source

cl-info.asd.

Parent Component

cl-info (system).

ASDF Systems

3.1.2 cl-info/core/file-type.lisp

Source

cl-info.asd.

Parent Component

cl-info/core (system).

Packages

cl-info.

Public Interface

4 Packages

Packages are listed by definition order.


4.1 cl-info

Source

file-type.lisp.

Nickname

cl-info/core

Use List

common-lisp.

Public Interface

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


5.1 Public Interface


5.1.1 Ordinary functions

Function: get-cl-info ()

Returns information about lisp implementation, asdf and quicklisp.

Package

cl-info.

Source

file-type.lisp.

Function: get-system-info (system-name)
Package

cl-info.

Source

file-type.lisp.


5.1.2 Generic functions

Generic Reader: absent-p (object)
Package

cl-info.

Methods
Reader Method: absent-p ((system-info system-info))

automatically generated reader method

Source

file-type.lisp.

Target Slot

absent.

Generic Reader: get-asdf-version (object)
Package

cl-info.

Methods
Reader Method: get-asdf-version ((cl-info cl-info))

Returns ASDF version.

Source

file-type.lisp.

Target Slot

asdf-version.

Generic Reader: get-lisp-type (object)
Package

cl-info.

Methods
Reader Method: get-lisp-type ((cl-info cl-info))

automatically generated reader method

Source

file-type.lisp.

Target Slot

lisp-type.

Generic Reader: get-lisp-version (object)
Package

cl-info.

Methods
Reader Method: get-lisp-version ((cl-info cl-info))

automatically generated reader method

Source

file-type.lisp.

Target Slot

lisp-version.

Generic Reader: get-name (object)
Package

cl-info.

Methods
Reader Method: get-name ((system-info system-info))

automatically generated reader method

Source

file-type.lisp.

Target Slot

name.

Generic Reader: get-path (object)
Package

cl-info.

Methods
Reader Method: get-path ((system-info system-info))

automatically generated reader method

Source

file-type.lisp.

Target Slot

path.

Generic Reader: get-ql-dists (object)
Package

cl-info.

Methods
Reader Method: get-ql-dists ((cl-info cl-info))

automatically generated reader method

Source

file-type.lisp.

Target Slot

ql-dists.

Generic Reader: get-software-type (object)
Package

cl-info.

Methods
Reader Method: get-software-type ((cl-info cl-info))

automatically generated reader method

Source

file-type.lisp.

Target Slot

software-type.

Generic Reader: get-software-version (object)
Package

cl-info.

Methods
Reader Method: get-software-version ((cl-info cl-info))

automatically generated reader method

Source

file-type.lisp.

Target Slot

software-version.

Generic Reader: get-version (object)
Package

cl-info.

Methods
Reader Method: get-version ((system-info system-info))

automatically generated reader method

Source

file-type.lisp.

Target Slot

version.


5.1.3 Standalone methods

Method: print-object ((info cl-info) stream)
Source

file-type.lisp.

Method: print-object ((info system-info) stream)
Source

file-type.lisp.


5.1.4 Classes

Class: cl-info
Package

cl-info.

Source

file-type.lisp.

Direct methods
Direct slots
Slot: asdf-version

Returns ASDF version.

Initform

(asdf/upgrade:asdf-version)

Readers

get-asdf-version.

Writers

This slot is read-only.

Slot: lisp-type
Initform

(lisp-implementation-type)

Readers

get-lisp-type.

Writers

This slot is read-only.

Slot: lisp-version
Initform

(lisp-implementation-version)

Readers

get-lisp-version.

Writers

This slot is read-only.

Slot: software-type
Package

common-lisp.

Initform

(software-type)

Readers

get-software-type.

Writers

This slot is read-only.

Slot: software-version
Package

common-lisp.

Initform

(software-version)

Readers

get-software-version.

Writers

This slot is read-only.

Slot: ql-dists
Initform

(ql-dist:all-dists)

Readers

get-ql-dists.

Writers

This slot is read-only.

Class: system-info
Package

cl-info.

Source

file-type.lisp.

Direct methods
Direct slots
Slot: name
Initargs

:name

Readers

get-name.

Writers

This slot is read-only.

Slot: version
Initargs

:version

Readers

get-version.

Writers

This slot is read-only.

Slot: path
Initargs

:path

Readers

get-path.

Writers

This slot is read-only.

Slot: absent
Initargs

:absent

Readers

absent-p.

Writers

This slot is read-only.


5.2 Internals


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   A   F   G   M   P  
Index Entry  Section

A
absent-p: Public generic functions
absent-p: Public generic functions

F
Function, get-cl-info: Public ordinary functions
Function, get-system-info: Public ordinary functions

G
Generic Function, absent-p: Public generic functions
Generic Function, get-asdf-version: Public generic functions
Generic Function, get-lisp-type: Public generic functions
Generic Function, get-lisp-version: Public generic functions
Generic Function, get-name: Public generic functions
Generic Function, get-path: Public generic functions
Generic Function, get-ql-dists: Public generic functions
Generic Function, get-software-type: Public generic functions
Generic Function, get-software-version: Public generic functions
Generic Function, get-version: Public generic functions
get-asdf-version: Public generic functions
get-asdf-version: Public generic functions
get-cl-info: Public ordinary functions
get-lisp-type: Public generic functions
get-lisp-type: Public generic functions
get-lisp-version: Public generic functions
get-lisp-version: Public generic functions
get-name: Public generic functions
get-name: Public generic functions
get-path: Public generic functions
get-path: Public generic functions
get-ql-dists: Public generic functions
get-ql-dists: Public generic functions
get-software-type: Public generic functions
get-software-type: Public generic functions
get-software-version: Public generic functions
get-software-version: Public generic functions
get-system-info: Public ordinary functions
get-version: Public generic functions
get-version: Public generic functions

M
Method, absent-p: Public generic functions
Method, get-asdf-version: Public generic functions
Method, get-lisp-type: Public generic functions
Method, get-lisp-version: Public generic functions
Method, get-name: Public generic functions
Method, get-path: Public generic functions
Method, get-ql-dists: Public generic functions
Method, get-software-type: Public generic functions
Method, get-software-version: Public generic functions
Method, get-version: Public generic functions
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods

P
print-object: Public standalone methods
print-object: Public standalone methods