Lean Elan 安装与使用教程

Lean Elan 安装与使用教程

elanA Lean version manager项目地址:https://gitcode.com/gh_mirrors/el/elan

1. 项目目录结构及介绍

在 elan 开源项目中，目录结构大致如下：

elan/
├── bin/                # 包含可执行文件，如 elan
├── cache/              # 缓存的 Lean 版本和其他构建材料
├── completions/       # 提供自动补全支持的文件
├── docs/               # 项目文档
├── elan.lean           # 主要的 Lean 源代码
├── examples/           # 示例代码
└── src/                 # Rust 语言编写的源代码库

• bin/：存放用于管理 Lean 环境的命令行工具。
• cache/：存储下载的 Lean 发行版和构建时使用的依赖项。
• completions/：提供给各种 shell 的自动补全脚本。
• docs/：项目文档资料。
• elan.lean：主要的 Lean 工具源代码。
• examples/：包含一些使用 Elan 的示例。
• src/：用 Rust 编程语言实现 Elan 功能的源码。

2. 项目的启动文件介绍

elan 的启动通常是通过调用安装路径下的 elan 可执行文件来完成的，例如：

$ elan init
$ elan install <version>
$ elan which lean

上述命令分别用于初始化一个新的 Lean 项目、安装指定版本的 Lean 和查找已安装的 Lean 实际路径。

初始化 Lean 项目

$ elan init

此命令会在当前目录创建一个 .elan 目录，用于存储 Lean 环境的信息。

安装 Lean 版本

$ elan install <version>

替换 <version> 为你想要安装的 Lean 版本号（如 3.4.2）。这将在 cache/ 目录下下载并准备该版本。

查找 Lean 可执行文件位置

$ elan which lean

这个命令可以用来确定当前活跃的 Lean 版本的路径。

3. 项目的配置文件介绍

Elan 使用 .elan/config.toml 文件进行配置。通常情况下，这个文件会在首次运行 elan init 命令时自动生成。以下是可能的配置选项示例：

[default]
version = "3.4.2"

[toolchains]
"3.4.2" = "/path/to/lean/3.4.2"
"nightly" = "https://LeanProver.github.io/nightlies/master.zip"

• [default] 部分定义了默认使用的 Lean 版本。
• [toolchains] 部分列出了可用的 Lean 版本及其对应的路径或 URL。你可以在这里添加、编辑或删除 Lean 版本来管理多个环境。

注意，如果你没有修改过默认的配置，.elan/config.toml 可能是空的或者只包含了 [default] 的部分，因为 Elan 通常能够自动处理好 Lean 版本的管理和选择。如有需要，你可以手动添加 toolchains 条目以管理额外的 Lean 版本。

以上就是关于 Lean Elan 的基本安装和配置指南。更多的细节和高级功能，建议参考项目的官方文档或在 GitHub 上查看相关说明。

elanA Lean version manager项目地址:https://gitcode.com/gh_mirrors/el/elan