This document explains how to get started with Lean and mathlib on a generic Linux distribution (there is a specific page for Debian and derived distribtions such as Ubuntu).
All commands below should be typed inside a terminal.
-
Lean itself doesn't depend on much infrastructure, but supporting tools needed by most users require
git
,curl
, andpython3
(on Debian and Ubuntu alsopython3-pip
). So the first step is to get those. -
The next step installs a small tool called
elan
which will handle updating Lean according to the needs of your current project (hit Enter when a question is asked). It will live in$HOME/.elan
and add a line to$HOME/.profile
.curl https://raw.githubusercontent.com/Kha/elan/master/elan-init.sh -sSf | sh
-
You will also need a code editor that has a Lean plugin. The recommended choice is Visual Studio Code. The alternative is to use Emacs, and its lean-mode.
- Install VS Code.
- Launch VS Code.
- Click on the extension icon
(or in older versions) in the side bar on the left edge of
the screen (or press ShiftCtrlX) and search for
leanprover
. - Click "install" (In old versions of VSCode, you might need to click "reload" afterwards)
- Verify Lean is working, for example by saving a file
test.lean
and entering#eval 1+1
. A green line should appear underneath#eval 1+1
, and hovering the mouse over it you should see2
displayed.
-
Then we install a small tool called
leanproject
that will handle updating mathlib according to the needs of your current project.sudo pip3 install mathlibtools
Note however that you cannot use mathlib, and in particular any imports,
in the file test.lean
created above.
👉 If you want to use mathlib, you should now read the instructions about creating and working on Lean projects.