Dev Containers CLI

2022 年 5 月 18 日，作者：Brigit Murtaugh，@BrigitMurtaugh

长话短说

使用 Dev Containers CLI 在任何地方提供一致的环境

Microsoft 和 GitHub 的 Dev Containers 团队很高兴发布开源命令行界面 (CLI)，作为新 Dev Containers 规范的一部分。我们希望收到您对此问题的反馈，或者devcontainers/cli存储库中的新问题和拉取请求。

一致性=快乐

一致、可预测的环境是高效、愉快的软件开发体验的关键。

容器历来用于在部署时标准化应用程序，但现在有很大的机会支持其他场景，包括持续集成 (CI)、测试自动化和全功能编码环境。 Dev Containers 提供了这种功能齐全的编码环境，并确保您的项目拥有所需的工具和软件，无论它是复杂的分布式项目还是只有一些要求。

Dev Containers 与生产容器的比较图

自 2019 年宣布 Dev Containers 扩展以来，Visual Studio Code 一直支持 Dev Containers ，最近GitHub Codespaces也支持 Dev Containers 。此支持由devcontainer.json支持，这是一种带有注释的结构化 JSON (jsonc) 元数据格式，用于配置容器化环境。

随着生产工作负载容器化变得越来越普遍， Dev Containers 对于 VS Code 之外的场景也变得广泛有用。我们很高兴地宣布， Dev Containers 规范的工作已经开始，它使任何人都可以使用任何工具来配置一致的开发环境。此外，今天我们很高兴与您分享该规范的一个主要组件，您现在可以尝试它，即 Dev Containers CLI。

什么是 Dev Containers CLI？

Dev Containers CLI 是 Dev Containers 规范的参考实现。

当 VS Code 和 Codespaces 等工具检测到devcontainer.json用户项目中的文件时，它们会使用 CLI 来配置 Dev Containers 。我们现在开放了这个 CLI 作为参考实现，以便个人用户和其他工具可以读取devcontainer.json元数据并从中创建 Dev Containers 。

该 CLI 可以直接使用，也可以集成到产品体验中，类似于当今与 Dev Containers 和 Codespaces 的集成方式。它目前支持简单的单容器选项，并与Docker Compose集成以实现多容器场景。

CLI 可在新的devcontainers/cli存储库中进行审查，您可以在本期的规范存储库中阅读有关其开发的更多信息。

我怎样才能尝试呢？

我们希望您尝试 Dev Containers CLI 并让我们知道您的想法。您只需几个简单的步骤即可快速尝试它，无论是安装其 npm 软件包还是从源代码构建 CLI 存储库。

您可以在CLI 存储库的 README中了解有关从源代码构建的更多信息。在这篇文章中，我们将重点关注 npm 包的使用。

要安装 npm 包，您需要安装 Python、Node.js（版本 14 或更高版本）和 C/C++ 来构建依赖项之一。VS Code如何贡献wiki 包含有关推荐工具集的详细信息。

npm 安装

npm install -g @devcontainers/cli

验证您可以运行 CLI 并查看其帮助文本：

devcontainer <command>

Commands:
  devcontainer up                   Create and run dev container
  devcontainer build [path]         Build a dev container image
  devcontainer run-user-commands    Run user commands
  devcontainer read-configuration   Read configuration
  devcontainer exec <cmd> [args..]  Execute a command on a running dev container

Options:
  --help     Show help                                                 [boolean]
  --version  Show version number                                       [boolean]

尝试 CLI

拥有 CLI 后，您可以使用示例项目进行尝试，例如Rust 示例。

将 Rust 示例克隆到您的计算机，并使用 CLI 的up命令启动 Dev Containers ：

git clone https://github.com/microsoft/vscode-remote-try-rust
devcontainer up --workspace-folder <path-to-vscode-remote-try-rust>

这将从容器注册表下载容器映像并启动容器。您的 Rust 容器现在应该正在运行：

[88 ms] dev-containers-cli 0.1.0.
[165 ms] Start: Run: docker build -f /home/node/vscode-remote-try-rust/.devcontainer/Dockerfile -t vsc-vscode-remote-try-rust-89420ad7399ba74f55921e49cc3ecfd2 --build-arg VARIANT=bullseye /home/node/vscode-remote-try-rust/.devcontainer
[+] Building 0.5s (5/5) FINISHED
 => [internal] load build definition from Dockerfile                       0.0s
 => => transferring dockerfile: 38B                                        0.0s
 => [internal] load .dockerignore                                          0.0s
 => => transferring context: 2B                                            0.0s
 => [internal] load metadata for mcr.microsoft.com/vscode/devcontainers/r  0.4s
 => CACHED [1/1] FROM mcr.microsoft.com/vscode/devcontainers/rust:1-bulls  0.0s
 => exporting to image                                                     0.0s
 => => exporting layers                                                    0.0s
 => => writing image sha256:39873ccb81e6fb613975e11e37438eee1d49c963a436d  0.0s
 => => naming to docker.io/library/vsc-vscode-remote-try-rust-89420ad7399  0.0s
[1640 ms] Start: Run: docker run --sig-proxy=false -a STDOUT -a STDERR --mount type=bind,source=/home/node/vscode-remote-try-rust,target=/workspaces/vscode-remote-try-rust -l devcontainer.local_folder=/home/node/vscode-remote-try-rust --cap-add=SYS_PTRACE --security-opt seccomp=unconfined --entrypoint /bin/sh vsc-vscode-remote-try-rust-89420ad7399ba74f55921e49cc3ecfd2-uid -c echo Container started
Container started
{"outcome":"success","containerId":"f0a055ff056c1c1bb99cc09930efbf3a0437c54d9b4644695aa23c1d57b4bd11","remoteUser":"vscode","remoteWorkspaceFolder":"/workspaces/vscode-remote-try-rust"}

然后您可以在此 Dev Containers 中运行命令：

devcontainer exec --workspace-folder <path-to-vscode-remote-try-rust> cargo run

这将编译并运行 Rust 示例，输出：

[33 ms] dev-containers-cli 0.1.0.
   Compiling hello_remote_world v0.1.0 (/workspaces/vscode-remote-try-rust)
    Finished dev [unoptimized + debuginfo] target(s) in 1.06s
     Running `target/debug/hello_remote_world`
Hello, VS Code Dev Containers!
{"outcome":"success"}

恭喜，您刚刚运行了 Dev Containers CLI 并看到了它的运行情况！

CLI 存储库的README中也提供了这些步骤。

我怎样才能参与其中？

您的反馈对于制定和扩展规范非常有帮助，我们很高兴收到您迄今为止对 CLI 的反馈。请查看 CLI 并告诉我们您的想法。我们专门打开了一个问题供人们留下评论和问题，您也可以在存储库中打开新问题或 PR，就像其他开源项目一样。

CLI 和整体规范正在积极开发中（该规范仍在制定中，尚未发布），因此请继续关注令人兴奋的新进展。到目前为止，我们欢迎您对 CLI 提供反馈，我们将继续提供有关您可以尝试什么以及何时尝试的更新，例如规范何时可用。

我们对基于容器的开发的未来感到非常兴奋，并且迫不及待地想听到您的反馈。我们期待提供一种跨工具和用户的普遍、高效的格式。

快乐编码！

布里吉特·墨塔夫，@BrigitMurtaugh