README.org 11.2 KB
Newer Older
1
#+TITLE: Common Lisp Package Manager - CLPM
Eric Timmons's avatar
Eric Timmons committed
2
3
#+AUTHOR: CLPM Developers
#+EMAIL: clpm-devel@common-lisp.net
Eric Timmons's avatar
Eric Timmons committed
4
#+OPTIONS: email:t toc:1 num:ni
5

Eric Timmons's avatar
Eric Timmons committed
6
7

*WARNING*: This software is BETA quality. I use it as my daily driver, but it
Eric Timmons's avatar
Eric Timmons committed
8
9
is still a little rough around the edges and it may accidentally eat your
files.
10
11
12

* Description

Eric Timmons's avatar
Eric Timmons committed
13
14
  CLPM is a package manager for Common Lisp. It can manage packages in both
  global and project specific contexts.
15

Eric Timmons's avatar
Eric Timmons committed
16
  It consists of two major pieces. First is a standalone program that is
Eric Timmons's avatar
Eric Timmons committed
17
18
19
20
21
22
23
24
25
26
  responsible for all the heavy lifting of downloading and unpacking releases
  in the correct place, resolving dependencies, and managing project specific
  environments. This piece is generally referred to as CLPM, the CLPM core, or
  =clpm= and is distributed as a precompiled executable using SBCL (but it is
  possible to compile it from source). The second is a small client library
  written in portable Common Lisp that interfaces with ASDF and calls CLPM as
  necessary to find and install missing systems. This piece is generally
  referred to as the CLPM client or =clpm-client= and is meant to be loaded
  when you are interactively developing code.

Eric Timmons's avatar
Eric Timmons committed
27
28
29
30
31
32
33
34
35
36
  CLPM is licensed under the two clause BSD license (BSD-2). So, basically do
  what you want with it (while providing appropriate attribution) and don't
  complain if it breaks things. CLPM is currently beta quality so expect some
  breakage and incompatibilites going forward.

  To receive help or report issues please send email to
  [[mailto:clpm-devel@common-lisp.net][clpm-devel@common-lisp.net]]. Additionally, feel free to join the email list at
  [[https://mailman.common-lisp.net/listinfo/clpm-devel]]. To join in the
  development of CLPM, you can find the project hosted on the common-lisp.net
  Gitlab server at [[https://gitlab.common-lisp.net/clpm/clpm]].
Eric Timmons's avatar
Eric Timmons committed
37

Eric Timmons's avatar
Eric Timmons committed
38
* Installing
Eric Timmons's avatar
Eric Timmons committed
39

Eric Timmons's avatar
Eric Timmons committed
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
  CLPM is distributed in both source and binary form. For either version, first
  install the dependencies:

  * tar :: Required.
  * git :: If you want to use development versions of your dependencies.
  * sbcl or ccl :: Either is required if systems need to be groveled for
    dependencies (likely needed if you use development versions of any
    dependency). SBCL is required if you are installing from source.

** Prebuilt binaries
   To install CLPM in binary form, download the appropriate file from
   [[https://common-lisp.net/project/clpm/downloads/][https://common-lisp.net/project/clpm/downloads/]]. Each release of CLPM
   consists of the following files:

   + =clpm-amd64-linux-gnu-$VERSION.tar.gz= :: CLPM compiled for 64bit Linux
     using GNU libc (by far the most common).
   + =clpm-amd64-linux-musl-$VERSION.tar.gz= :: CLPM compiled for 64bit Linux
     using musl libc (e.g., Alpine Linux).
   + =clpm-arm64-linux-gnu-$VERSION.tar.gz= :: CLPM compiled for 64bit Linux on
     ARM processors using GNU libc.
   + =clpm-arm64-linux-musl-$VERSION.tar.gz= :: CLPM compiled for 64bit Linux
     on ARM processors using musl libc.
   + =clpm-armv7-linux-gnu-$VERSION.tar.gz= :: CLPM compiled for 32bit Linux on
     ARM processors using GNU libc.
   + =clpm-armv7-linux-musl-$VERSION.tar.gz= :: CLPM compiled for 32bit Linux
     on ARM processors using musl libc.
   + =clpm-amd64-windows-$VERSION.msi= :: CLPM installer for 64 bit Windows.
   + =clpm-$VERSION.DIGESTS= :: Text file containing the SHA512 sums for every
     previously mentioned file.
   + =clpm-$VERSION.DIGESTS.asc= :: Same as =clpm-$VERSION.DIGESTS=, but signed
     with GPG key =0x10327DE761AB977333B1AD7629932AC49F3044CE=.

*** GNU/Linux

    After downloading the tarball and validating the SHA512 sum, unpack it and
    run =sh install.sh=. By default, it is installed to =/usr/local/=, but that
    prefix con be changed using the =INSTALL_ROOT= environment
    variable. However, if you change the prefix, you will also likely need to
    set the =CLPM_HOME= environment variable to point to
    =$INSTALL_ROOT/lib/clpm/=.

*** Windows

    After downloading the installer and validating the SHA512 sum, simply run
    the installer and follow the directions.

** Source Install

   See [[file:INSTALL.org][INSTALL]] for more details on installing from source.
Eric Timmons's avatar
Eric Timmons committed
89
90
91

* Quickstart

Eric Timmons's avatar
Eric Timmons committed
92
93
94
95
96
97
  Now that you have CLPM installed, this section walks you through how to set
  it up as a Quicklisp alternative.

  First, configure CLPM to use the Quicklisp index as a source for packages and
  to use HTTPS to fetch files from it [fn:1]. Create a file called
  =~/.config/clpm/sources.conf= with the following contents:
Eric Timmons's avatar
Eric Timmons committed
98
99

  #+begin_src common-lisp
Eric Timmons's avatar
Eric Timmons committed
100
101
102
    ("quicklisp"
     :type :quicklisp
     :url "https://beta.quicklisp.org/dist/quicklisp.txt")
Eric Timmons's avatar
Eric Timmons committed
103
104
  #+end_src

Eric Timmons's avatar
Eric Timmons committed
105
  See [[file:docs/sources.org][sources]] for more details on configuring sources.
Eric Timmons's avatar
Eric Timmons committed
106

Eric Timmons's avatar
Eric Timmons committed
107
108
  Next, configure your favorite Lisp to load the client by placing the output
  of the following command in your Lisp's init file (such as =~/.sbclrc=).
Eric Timmons's avatar
Eric Timmons committed
109
110

  #+begin_src shell
Eric Timmons's avatar
Eric Timmons committed
111
    clpm client rc --quicklisp-alternative
Eric Timmons's avatar
Eric Timmons committed
112
113
  #+end_src

Eric Timmons's avatar
Eric Timmons committed
114
  Then, sync your local copy of the Quicklisp metadata by running:
Eric Timmons's avatar
Eric Timmons committed
115
116

  #+begin_src shell
Eric Timmons's avatar
Eric Timmons committed
117
    clpm sync
Eric Timmons's avatar
Eric Timmons committed
118
119
  #+end_src

Eric Timmons's avatar
Eric Timmons committed
120
121
  Syncing may take a while the first time as it needs to fetch and process the
  metadata for every Quicklisp release.
Eric Timmons's avatar
Eric Timmons committed
122

Eric Timmons's avatar
Eric Timmons committed
123
124
  Then you can start your favorite lisp and try loading a system, such as
  alexandria:
Eric Timmons's avatar
Eric Timmons committed
125

Eric Timmons's avatar
Eric Timmons committed
126
127
  #+begin_src common-lisp
    (asdf:load-system :alexandria)
Eric Timmons's avatar
Eric Timmons committed
128
129
  #+end_src

Eric Timmons's avatar
Eric Timmons committed
130
131
  CLPM will see that alexandria is not present locally and automatically
  install it before loading it.
Eric Timmons's avatar
Eric Timmons committed
132

Eric Timmons's avatar
Eric Timmons committed
133
134
135
136
137
138
* Project Goals

  CLPM is far from the only package manager available for Common Lisp[fn:2], but
  it makes very different assumptions and design choices than the other
  available solutions. In this section we describe our high level goals and how
  they affect our design decisions.
Eric Timmons's avatar
Eric Timmons committed
139

Eric Timmons's avatar
Eric Timmons committed
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
** Use existing libraries where possible

   If you look at Quicklisp, you'll quickly notice that the client does not
   rely on any third party code and all functionality, from an HTTP client to
   untaring, are implemented completely as part of the Quicklisp client
   project. The upsides of this strategy are that only required functionality
   is loaded into the development image, it prevents version conflicts between
   code the Quicklisp client depends on and the code you're developing depends
   on, and it helps ensure that Quicklisp works on a broad set of Common Lisp
   implementations. However, it has a major downside: the maintenance and
   development costs of the package manager are high, potentially making it
   difficult to implement new features and the package manager does not really
   drive the quality of code in the community at large higher.

   The desire to use existing libraries drives the decision for the CLPM core
   and client to be separated. The client has no external dependencies which
   allows it to share all the benefits of Quicklisp's model, and the core never
   needs to be loaded into a development image, so it can leverage any
   dependency that makes sense without impacting the development image in the
   slightest.

** Support HTTPS

   HTTPS is becoming more and more ubiquitous. Some websites (such as Github
Eric Timmons's avatar
Eric Timmons committed
164
   and Gitlab) are only served over HTTPS and some people insist on HTTPS
Eric Timmons's avatar
Eric Timmons committed
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
   everywhere possible. This trend is not going away, therefore CLPM should
   natively support HTTPS.

   As no Lisp implementation I am aware of has native support for TLS, this
   means that CLPM has to use third party tools to achieve this support. This
   further drives the separation of the core and client, as CLPM can use
   foreign libraries to provide TLS support and this is not something that
   should be brought into a development image that does not need it
   otherwise.

   Additionally, Quicklisp packages are served over HTTPS. While the Quicklisp
   client cannot take advantage of that (without
   [[https://github.com/snmsts/quicklisp-https]]), CLPM can, providing a little
   more of a guarantee that packages have not been tampered with.

** Minimize footprint in development images and deployments

   Many Common Lisp implementations allow you to deliver programs by dumping an
   image to file. For most programs generated this way there is no need to have
   a bundled package manager. Therefore, there should be an easy way to use a
   package manager without leaving traces if it in your deployed system.

   To this end, CLPM can be used without ever loading the client (for example,
   =clpm bundle exec= configures ASDF entirely through environment variables)
   and if you do choose to use the client for better interactive development,
   CLPM is able to remove itself from the image when it is dumped.

** Support CI/CD workflows

   CI and CD are nice to have and nicer still when the jobs can run quickly and
   give fast feedback. To that end, CLPM is distributed in both binary and
   source form. Source for hackers or people who want to use a different
   feature set and binary for quick and easy installation in other cases.

** Support installing multiple package versions

   Ideally, updates to packages would never introduce regressions. However, we
   live in reality and this happens frequently (just look at the packages that
   get removed from Quicklisp in any given release for failing to
   build). Additionally, sometimes you just really need to use an old version
Eric Timmons's avatar
Eric Timmons committed
205
   of a dependency for some project while using the latest version of the same
Eric Timmons's avatar
Eric Timmons committed
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
   dependency in another project.

   To this end, CLPM supports installing multiple versions of the same package
   simultaneously. This is additionally an enabling feature for managing
   project specific contexts as well as global contexts.

** Support and encourage explicitly versioned systems

   ASDF allows developers to provide version numbers for their systems and
   associate version requirements with dependencies. IMHO this is a criminally
   underutilized feature of ASDF and it should be *required* that any release
   of a package in any package index should declare a version number. However,
   it is a lot of work to convince others to believe the same way and even if a
   critical mass did buy in, things wouldn't change overnight.

   Therefore, CLPM supports both the status quo (a Quicklisp package index
   versioned by date) as well as a work in progress package index (working name
   of CLPI). This new Common Lisp Package Index includes both extra metadata
   about projects (such as the upstream repo which can be used to check out
   development versions) and requires that systems are versioned in order to be
   released.
Eric Timmons's avatar
Eric Timmons committed
227
228
229
230
231

* In-depth Documentation

  For more documentation on CLPM, you may find the following files useful:

Eric Timmons's avatar
Eric Timmons committed
232
233
234
235
  + [[file:docs/client.org][client]] :: Summary of CLPM's client.
  + [[file:docs/config.org][config]] :: Summary of all of CLPM's configuration options.
  + [[file:docs/sources.org][sources]] :: Summary of all supported software repositories.
  + [[file:docs/bundle.org][bundle]] :: Information on how to use CLPM to manage and repeatably
Eric Timmons's avatar
Eric Timmons committed
236
    install dependencies for a single project.
Eric Timmons's avatar
Eric Timmons committed
237
  + [[file:docs/storage.org][storage]] :: Information on where CLPM writes data to your hard drive.
Eric Timmons's avatar
Eric Timmons committed
238

Eric Timmons's avatar
Eric Timmons committed
239
240
* Footnotes

Eric Timmons's avatar
Eric Timmons committed
241
[fn:1] All files in the primary Quicklisp distribution are served over both
Eric Timmons's avatar
Eric Timmons committed
242
243
HTTPS and HTTP, even though the Quicklisp client cannot use HTTPS itself.

Eric Timmons's avatar
Eric Timmons committed
244
[fn:2] See, for example: [[https://www.quicklisp.org/beta/][Quicklisp]], [[https://github.com/fukamachi/qlot/][Qlot]], and [[https://github.com/CodyReichert/qi][Qi]].