为您的账户个性化 GitHub Codespaces

关于代码空间的个性化

在使用任何开发环境时，将设置和工具自定义为符合您的偏好和工作流是重要的一步。GitHub Codespaces 提供两种主要方式来个性化您的代码空间。

设置同步 - 您可以在桌面应用程序和 VS Code Web 客户端之间同步您的 Visual Studio Code 设置。
点文件 – 您可以使用 dotfiles 仓库来指定脚本、Shell 首选项及其他配置。

GitHub Codespaces 的个性化适用于您创建的任何代码空间。

项目维护者还可以为每个仓库定义一个适用于任何人创建的代码空间的默认配置。更多信息，请参阅 Dev 容器简介。

设置同步

设置同步允许您在机器和 VS Code 实例之间同步配置，例如设置、键盘快捷键、代码片段、扩展和 UI 状态。欲了解更多信息，请参阅 VS Code 文档中的设置同步。

您同步的设置会缓存在云端。如果在代码空间中开启了设置同步，您在代码空间中对设置所做的任何更新都会推送到云端，而您在其他地方推送到云端的更新也会被拉取到代码空间中。

例如，设置同步的常见用法是将您在本地使用的 VS Code 桌面应用程序中的设置同步到浏览器中打开的代码空间。为此，您需要执行以下操作。

在桌面应用程序中开启设置同步。欲了解更多信息，请参阅 VS Code 文档中的设置同步。
在 GitHub Codespaces 的用户首选项中启用设置同步。欲了解更多信息，请参阅管理设置同步首选项。
可选地，如果您想将设置更改从代码空间同步回桌面应用程序，请在代码空间中开启设置同步，并将创建该代码空间的仓库添加到受信任仓库列表中。欲了解更多信息，请参阅在代码空间中开启设置同步。

或者，您可能希望在 Web 客户端打开的所有代码空间中使用相同的设置，同时保持本地 VS Code 应用程序不受影响。为此，您需要执行以下操作。

在代码空间中，将设置配置为您想要的状态，然后在代码空间中开启设置同步，将设置推送到云端。这样做时，设置同步会自动在 GitHub Codespaces 的用户首选项中启用，因此您的设置会被拉取到所有新的代码空间中。欲了解更多信息，请参阅在代码空间中开启设置同步。
在桌面应用程序中，保持设置同步关闭，或将您的设置同步到其他账户。

关于代码空间中的设置同步

设置同步默认是否在代码空间中开启，以及缓存设置与代码空间设置之间的关系，取决于多个因素。这些因素包括您打开代码空间所使用的编辑器、您在 GitHub 上的用户首选项以及受信任仓库列表。

对于在 VS Code 桌面应用程序中打开的代码空间，如果您之前已在该应用程序中开启设置同步，则设置同步保持开启。如果设置同步已开启，您的设置会在云端进行双向同步。

对于在 VS Code Web 客户端中打开的代码空间，设置同步默认是关闭的。这意味着代码空间中的 VS Code 实例使用默认主题和设置。

如果您使用 Web 客户端且希望代码空间使用您缓存的同步设置，可以在 GitHub 上的用户首选项中启用设置同步。欲了解更多信息，请参阅管理设置同步首选项。如果您在 Web 客户端打开代码空间并在代码空间中开启设置同步，设置同步会自动在您的用户首选项中启用。

当设置同步在您的用户首选项中启用时，对于在 Web 客户端打开的代码空间，设置同步的行为取决于您的受信任仓库列表。

如果您从受信任的仓库创建代码空间，设置同步默认在代码空间中开启，因此您的设置会在云端进行双向同步。
如果您从未添加到受信任仓库列表的仓库创建代码空间，则同步仅在单个方向且一次性进行。当您创建代码空间时，您的缓存设置会从云端拉取到代码空间，但此后代码空间中的设置同步会关闭。这意味着您在代码空间中对设置所做的更新不会推送回云端，且您在其他地方对缓存设置所做的更新在代码空间创建后也不会反映出来。

如果您在代码空间中开启设置同步，系统会提示您将该仓库添加到受信任仓库列表中。欲了解更多信息，请参阅在代码空间中开启设置同步。

GitHub Codespaces 的受信任仓库列表在 GPG 验证和设置同步两个功能之间共享。假设您已同时启用这两个功能，如果您为 GPG 验证添加了受信任仓库列表，则从这些仓库创建的代码空间会自动开启设置同步。如果您为设置同步信任了新仓库，GPG 验证也会对同一仓库开启。虽然这两个功能共享同一列表，但您可以独立启用或禁用 GPG 验证和设置同步。

注意

如果您之前已为所有仓库启用 GPG 验证，建议改为使用受信任仓库的选定列表。欲了解更多信息，请参阅 GitHub Codespaces 安全性。

有关管理 GPG 验证首选项的更多信息，请参阅管理 GitHub Codespaces 的 GPG 验证。

管理设置同步的首选项

如果您在用户首选项中启用设置同步，VS Code Web 客户端打开的代码空间会从云端拉取您的缓存设置，而从受信任仓库创建的代码空间则会在两个方向上与缓存设置同步。

在 GitHub 任意页面的右上角，点击您的头像，然后点击设置。
在侧边栏的“代码、计划和自动化”部分，点击 代码空间。
要启用或禁用设置同步，请在 “Settings Sync” 下选择或取消选择 Enable。
要更改用于 GPG 验证和设置同步的受信任仓库，在 “Trusted repositories” 下，可选择 All repositories，或选择 Selected repositories 并使用 “Select repositories” 下拉框添加您信任的仓库。

注意

我们建议使用受信任仓库的选定列表。更多信息，请参阅 GitHub Codespaces 安全性。

您的更改将在新代码空间中生效。但您也可以在已有代码空间中开启设置同步。更多信息，请参阅在代码空间中开启设置同步。

在代码空间中开启设置同步

注意

您仅应在受信任仓库创建的代码空间中开启设置同步。更多信息，请参阅 GitHub Codespaces 安全性。

以下步骤说明了如何在 Web 客户端打开的代码空间中开启设置同步。有关在 VS Code 桌面应用程序中开启设置同步的信息，请参阅 VS Code 文档中的设置同步。

在 VS Code 中，活动栏底部，选择，然后点击 Sign in to Sync Settings。
如果您创建代码空间的仓库不在受信任仓库列表中，浏览器会打开一个窗口，要求您为设置同步授权额外权限。若您信任该仓库，点击 Authorize，随后关闭浏览器窗口。代码空间将重新加载并显示最新同步的设置。

注意

如果您在用户首选项中关闭了设置同步，并且受信任仓库已设置为所有仓库，系统会显示有关为所有仓库开启设置同步的警告。请检查该警告，并决定是为所有仓库开启设置同步，还是修改受信任仓库列表。
要配置要同步的设置，请使用 Shift+Command+P（Mac）/ Ctrl+Shift+P（Windows/Linux）打开命令面板，然后输入 “Settings Sync”。点击 Settings Sync: Configure...。
选择您想要同步的设置，然后点击 OK。

在代码空间中关闭设置同步

您可以关闭设置同步，以停止 VS Code 实例之间的设置同步。

当您在代码空间中关闭设置同步后，新的代码空间仍会使用上一次将设置推送到云端时缓存的设置。如果您使用 VS Code Web 客户端进行代码空间开发，并希望代码空间使用默认设置而不是缓存设置，可禁用设置同步。更多信息，请参阅管理设置同步首选项。

如果您希望所有 VS Code 实例（包括桌面应用程序）恢复使用默认的 VS Code 设置，可以在关闭设置同步时清除云端缓存。

如果当前在 VS Code 实例中关闭了设置同步且想要清除缓存设置，必须先重新开启它。操作说明请参阅为您的账户个性化 GitHub Codespaces。
在活动栏底部，选择，然后点击 Settings Sync is On。
在下拉菜单中，点击 Settings Sync: Turn Off。
要清除缓存设置，请在弹窗中选择 Turn off sync on all your devices and clear the data from the cloud。
点击 Turn off。

点文件

点文件是 Unix 类系统上以 . 开头的文件和文件夹，用于控制系统上应用程序和 shell 的配置。您可以将点文件存放在 GitHub 的仓库中并进行管理。有关点文件仓库应包含哪些内容的建议和教程，请访问 GitHub does dotfiles。

您的点文件仓库可能包含 shell 别名和偏好、您希望安装的工具，或其他您想要的代码空间个性化内容。

您可以通过在个人 GitHub Codespaces 设置中选择相应的仓库，让 GitHub Codespaces 使用您拥有的任意仓库中的点文件。

创建新代码空间时，GitHub 会将您选择的点文件仓库克隆到代码空间环境，并查找以下任意文件以完成环境设置。

install.sh
install
bootstrap.sh
bootstrap
script/bootstrap
setup.sh
setup
script/setup

如果未找到上述文件，则会将您所选点文件仓库中所有以 . 开头的文件或文件夹符号链接（symlink）到代码空间的 ~ 或 $HOME 目录。

对所选点文件仓库的任何更改仅在新创建的代码空间中生效，对已有代码空间没有影响。

注意

目前，Codespaces 不支持使用 dotfiles 仓库为 VS Code 的用户范围设置进行个性化。您可以在项目仓库中为特定项目设置默认的工作区和远程（Codespaces）设置。更多信息，请参阅 Dev 容器简介。

为 Codespaces 启用您的点文件仓库

您可以使用已选的点文件仓库来个性化 GitHub Codespaces 环境。选择点文件仓库后，您可以向其中添加脚本、偏好和配置文件。随后需要在个人 GitHub Codespaces 设置页面中启用点文件。

警告

点文件能够运行任意脚本，可能包含意外或恶意代码。在安装点文件仓库之前，建议检查脚本以确保其不会执行任何意外操作。

在 GitHub 任意页面的右上角，点击您的头像，然后点击设置。
在侧边栏的“代码、计划和自动化”部分，点击 代码空间。
在 “Dotfiles” 下，选择 Automatically install dotfiles，这样 GitHub Codespaces 将在您创建的每个新代码空间中自动安装点文件。
使用下拉框选择您希望从中安装点文件的仓库。