GitHub Codespaces 提供云端 VS Code 环境,支持通过仓库页面、GitHub CLI 或复用实例快速启动,并可通过 devcontainer.json 自定义配置。

如果您希望在任何设备上快速启动一个预配置的开发环境,而无需在本地安装和配置开发工具,则可以使用 GitHub Codespaces 提供的云端 VS Code 实例。以下是启用和使用该服务的具体方式:
本文运行环境:MacBook Air,macOS Sequoia。
一、通过仓库页面直接创建 Codespace
此方法适用于已有 GitHub 仓库且希望立即进入编码状态的场景,Codespace 将基于仓库根目录下的 devcontainer.json 配置自动初始化环境。
1、访问目标 GitHub 仓库主页。
2、点击绿色代码按钮,选择 Open with Codespaces 选项。
3、点击 Create codespace on main(或指定分支)启动构建流程。
4、等待环境构建完成,VS Code 界面在浏览器中加载后即可开始编辑。
二、从 GitHub CLI 启动 Codespace
此方法适合习惯命令行操作的开发者,可快速在终端中触发远程环境创建,并支持指定机器类型与配置文件路径。
1、确保已安装最新版 GitHub CLI(gh) 并完成身份认证。
2、在本地终端中切换至对应仓库的克隆目录,或直接使用仓库所有者/名称组合。
3、执行命令:gh codespace create --repo owner/repo-name --branch main。
4、运行 gh codespace code 在本地 VS Code 桌面客户端中连接该实例(需已安装 GitHub Codespaces 扩展)。
三、复用已有 Codespace 实例
GitHub 默认为每个仓库保留最近一次活跃的 Codespace,关闭浏览器标签页不会自动销毁实例,再次访问时可快速恢复工作状态。
1、进入 GitHub 仓库页面,点击绿色代码按钮。
2、在下拉菜单中查看 Your codespaces 区域列出的运行中或已停止的实例。
3、点击对应实例右侧的 Connect 按钮。
4、确认连接后,编辑器将加载上次关闭前的文件、终端会话及未保存更改(若启用自动保存)。
四、自定义 devcontainer.json 配置
通过编写 devcontainer.json 文件可声明容器镜像、预安装扩展、端口转发规则及启动脚本,使 Codespace 行为与团队本地开发环境保持一致。
1、在仓库根目录新建 .devcontainer/devcontainer.json 文件。
2、写入基础配置,例如指定 mcr.microsoft.com/vscode/devcontainers/python:3.11 作为基础镜像。
3、在 extensions 字段中添加 ms-python.python 和 esbenp.prettier-vscode 等必需扩展 ID。
4、提交并推送该文件至远程仓库,后续创建的 Codespace 将自动应用该配置。










