envd

环境要求

• 已安装 Python 与 pip（envd 通过 PyPI 分发）
• 网络可访问 PyPI，或能手动下载 GitHub Releases 二进制
• 构建容器环境需本机具备 Docker（bootstrap 会涉及 docker.io registry 配置）

安装与启动步骤

1. 1安装 envd

   用 pip 安装或升级 envd，也可以直接从 GitHub Releases 下载二进制文件。

   pip install --upgrade envd

   复制

2. 2初始化 bootstrap

   安装完成后必须执行 bootstrap，它会准备构建环境所需的组件。

   envd bootstrap

   复制

3. 3配置 Docker 镜像

   网络受限或拉取慢时，可在 bootstrap 时加 --dockerhub-mirror 或 -m 指定 docker.io 镜像源。

   envd bootstrap --dockerhub-mirror https://docker.mirrors.sjtug.sjtu.edu.cn

   复制

4. 4编写 build.envd

   在项目目录创建 build.envd，用 Python DSL 声明基础环境、依赖包、shell 与 Jupyter。

   def build():
       base(dev=True)
       install.conda()
       install.python()
       # Configure the pip index if needed.
       # config.pip_index(url = "https://pypi.tuna.tsinghua.edu.cn/simple")
       install.python_packages(name = [
           "numpy",
       ])
       shell("fish")
       config.jupyter()

   复制

5. 5启动开发环境

   在 build.envd 所在目录执行 envd up，构建镜像并进入容器；加 --detach 可后台运行。

   envd up

   复制

6. 6查看环境信息

   后台启动后用 envd envs ls 查看环境名、Jupyter 地址、SSH 目标与运行状态。

   envd up --detach
   envd envs ls

   复制

关键配置

如何确认成功

执行 envd envs ls，STATUS 列显示 Up 即启动成功，JUPYTER 列会给出访问地址。

常见问题

注意事项

• 安装完成后务必先执行 envd bootstrap，否则无法构建环境。
• build.envd 需放在执行 envd up 的项目目录中，两者要保持一致。
• 可通过 include("https://github.com/tensorchord/envdlib") 复用团队共享的环境函数。