关于使用 GitHub Codespaces 进行开发
您可以使用任意工具在代码空间中开发代码
- 命令行,通过使用 GitHub CLI 发起的 SSH 连接
- Visual Studio Code 桌面应用程序
- 基于浏览器的 Visual Studio Code 版本
本文中的标签页允许您在这些工作方式的对应信息之间切换。目前您位于 Web 浏览器版 Visual Studio Code 的标签页。
在浏览器中使用代码空间
在浏览器中使用 Codespaces 可为您提供完整的开发体验。您可以编辑代码、调试、使用 Git 命令并运行您的应用程序。

用户界面的主要组件有
- 侧边栏 - 默认情况下,此区域在资源管理器中显示您的项目文件。
- 活动栏 - 此栏显示视图并提供切换视图的方式。您可以通过拖放来重新排列视图。
- 编辑器 - 在此处编辑文件。您可以右键单击文件标签页以获取诸如在资源管理器中定位文件等选项。
- 面板 - 在此处可以查看输出和调试信息,也是集成终端的默认位置。
- 状态栏 - 此区域提供有关您的代码空间和项目的有用信息。例如,分支名称、已配置的端口等。为获得最佳的 GitHub Codespaces 体验,我们建议使用基于 Chromium 的浏览器,如 Google Chrome 或 Microsoft Edge。更多信息,请参阅 故障排除 GitHub Codespaces 客户端。
自定义仓库的代码空间
您可以通过为仓库创建或更新 dev container 配置来自定义为该仓库创建的代码空间。您可以在代码空间内部完成此操作。在更改 dev container 配置后,您可以通过重新构建代码空间的 Docker 容器来将更改应用到当前代码空间。更多信息,请参阅 dev 容器简介。
个性化您的代码空间
您可以使用 dotfiles 仓库和 Settings Sync 来为您创建的任何代码空间个性化环境。个性化可以包括 shell 偏好设置和其他工具。更多信息,请参阅 为您的账户个性化 GitHub Codespaces。
从代码空间运行您的应用
您可以在代码空间中转发端口以测试和调试您的应用程序。您还可以管理端口协议并在组织内部或公开共享该端口。更多信息,请参阅 在代码空间中转发端口。
提交更改
对代码空间进行更改后(无论是新代码还是配置),你都应提交这些更改。将配置提交到仓库可以确保以后任何人在此仓库创建代码空间时都能获得相同的配置。你所做的任何自定义(例如添加 VS Code 扩展)都将对所有用户生效。
本教程中,你是从模板仓库创建的代码空间,因此代码尚未存储在仓库中。你可以通过将当前分支发布到 GitHub 来创建仓库。
相关信息请参阅 在代码空间中使用源代码管理。
使用 Visual Studio Code 命令面板
Visual Studio Code 命令面板让您可以访问和管理许多针对 Codespaces 和 Visual Studio Code 的功能。更多信息,请参阅 在 GitHub Codespaces 中使用 Visual Studio Code 命令面板。
导航至现有代码空间
-
您可以在“Your codespaces”(您的代码空间)页面查看已创建的所有可用代码空间。要打开此页面,请在 GitHub 左上角选择,然后点击 代码空间。这将带您前往 github.com/codespaces。
-
单击您想要开发的代码空间名称。

或者,您可以通过前往相应的仓库,点击 Code 按钮并选择 Codespaces 选项卡,查看该仓库的任何代码空间。下拉菜单将显示该仓库的所有活动代码空间。
本文中的标签页允许您在这些工作方式的对应信息之间切换。目前您位于 Visual Studio Code 的标签页。
在 VS Code 中使用代码空间
GitHub Codespaces 为您提供了完整的 Visual Studio Code 开发体验。您可以在使用 VS Code 的代码空间中编辑代码、调试以及使用 Git 命令。更多信息,请参阅 VS Code 文档。

用户界面的主要组件有
- 侧边栏 - 默认情况下,此区域在资源管理器中显示您的项目文件。
- 活动栏 - 此栏显示视图并提供切换视图的方式。您可以通过拖放来重新排列视图。
- 编辑器 - 在此处编辑文件。您可以右键单击文件标签页以获取诸如在资源管理器中定位文件等选项。
- 面板 - 在此处可以查看输出和调试信息,也是集成终端的默认位置。
- 状态栏 - 此区域提供有关您的代码空间和项目的有用信息。例如,分支名称、已配置的端口等。
有关使用 VS Code 的更多信息,请参阅 VS Code 文档中的 用户界面指南。
您可以直接从 VS Code 连接到您的代码空间。更多信息,请参阅 在 Visual Studio Code 中使用 GitHub Codespaces。
有关故障排除信息,请参阅 故障排除 GitHub Codespaces 客户端。
自定义仓库的代码空间
您可以通过为仓库创建或更新 dev container 配置来自定义为该仓库创建的代码空间。您可以在代码空间内部完成此操作。在更改 dev container 配置后,您可以通过重新构建代码空间的 Docker 容器来将更改应用到当前代码空间。更多信息,请参阅 dev 容器简介。
个性化您的代码空间
您可以使用 dotfiles 仓库和 Settings Sync 来为您创建的任何代码空间个性化环境。个性化可以包括 shell 偏好设置和其他工具。更多信息,请参阅 为您的账户个性化 GitHub Codespaces。
从代码空间运行您的应用
您可以在代码空间中转发端口以测试和调试您的应用程序。您还可以管理端口协议并在组织内部或公开共享该端口。更多信息,请参阅 在代码空间中转发端口。
提交更改
对代码空间进行更改后(无论是新代码还是配置),你都应提交这些更改。将配置提交到仓库可以确保以后任何人在此仓库创建代码空间时都能获得相同的配置。你所做的任何自定义(例如添加 VS Code 扩展)都将对所有用户生效。
本教程中,你是从模板仓库创建的代码空间,因此代码尚未存储在仓库中。你可以通过将当前分支发布到 GitHub 来创建仓库。
相关信息请参阅 在代码空间中使用源代码管理。
使用 Visual Studio Code 命令面板
Visual Studio Code 命令面板让您可以访问和管理许多针对 Codespaces 和 Visual Studio Code 的功能。更多信息,请参阅 在 GitHub Codespaces 中使用 Visual Studio Code 命令面板。
导航至现有代码空间
-
您可以在“Your codespaces”(您的代码空间)页面查看已创建的所有可用代码空间。要打开此页面,请在 GitHub 左上角选择,然后点击 代码空间。这将带您前往 github.com/codespaces。
-
单击您想要开发的代码空间名称。

或者,您可以通过前往相应的仓库,点击 Code 按钮并选择 Codespaces 选项卡,查看该仓库的任何代码空间。下拉菜单将显示该仓库的所有活动代码空间。
本文中的标签页允许您在这些工作方式的对应信息之间切换。目前您位于 GitHub CLI 的标签页。
在命令行中使用代码空间
注意
要了解更多关于 GitHub CLI 的信息,请参阅 关于 GitHub CLI。
您可以使用 GitHub CLI 创建新代码空间或启动已有代码空间,然后通过 SSH 连接。连接后,您可以使用喜欢的命令行工具在终端中工作。
安装 GitHub CLI 并使用您的 GitHub 账户进行身份验证后,您可以使用命令 gh codespace [<SUBCOMMAND>...] --help 来浏览帮助信息。或者,您也可以在 https://cli.github.com/manual/gh_codespace 查看相同的参考信息。
更多信息,请参阅 使用 GitHub CLI 使用 GitHub Codespaces。