个性化您的 GitHub Codespaces 帐户

关于个性化 Codespaces

在使用任何开发环境时，根据您的偏好和工作流程自定义设置和工具都是一个重要步骤。GitHub Codespaces 提供两种主要方法来个性化您的 codespaces。

设置同步 - 您可以同步桌面应用程序和 VS Code Web 客户端之间的 Visual Studio Code 设置。
Dotfiles – 您可以使用dotfiles 代码库来指定脚本、shell 偏好设置和其他配置。

GitHub Codespaces 个性化设置适用于您创建的任何 codespace。

项目维护者还可以定义一个默认配置，该配置适用于任何人都可以为代码库创建的每个 codespace。有关更多信息，请参阅“开发容器简介”。

设置同步

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

您的同步设置缓存在云中。如果在 codespace 中打开了设置同步，则您对 codespace 中设置所做的任何更新都将推送到云中，并且您从其他地方推送到云中的任何更新都将拉取到您的 codespace 中。

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

在桌面应用程序中启用设置同步。有关更多信息，请参阅 VS Code 文档中的设置同步。
在您的 GitHub Codespaces 用户偏好设置中启用设置同步。有关更多信息，请参阅“管理您的设置同步偏好设置”。
可选：如果您希望将设置更改从 codespace 同步回您的桌面应用程序，请在 codespace 中启用设置同步，并将您从中创建 codespace 的存储库添加到您的受信任存储库列表中。有关更多信息，请参阅“在 codespace 中启用设置同步”。

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

在 Codespace 中，按照您想要的方式配置您的设置，然后在 Codespace 中启用设置同步以将设置推送到云端。执行此操作时，GitHub Codespaces 的用户偏好设置中会自动启用设置同步，因此您的设置将被提取到所有新的 Codespaces 中。有关更多信息，请参阅“在 codespace 中启用设置同步”。
在桌面应用程序中，保持设置同步关闭，或将您的设置同步到不同的帐户。

关于 Codespaces 中的设置同步

Codespace 中是否默认启用设置同步，以及缓存的设置与 Codespace 中的设置之间的关系，取决于几个因素。这些因素包括您打开 Codespace 的编辑器、您在 GitHub 上的用户偏好设置以及您的受信任存储库列表。

对于在 VS Code 桌面应用程序中打开的 Codespaces，如果您之前已在应用程序中启用设置同步，则设置同步将保持开启状态。如果设置同步已开启，则您的设置将同步到云端和从云端同步。

对于在 VS Code Web 客户端中打开的 Codespaces，默认情况下设置同步处于禁用状态。这意味着 Codespace 中的 VS Code 实例使用默认主题和设置。

如果您使用 Web 客户端并希望您的 Codespaces 使用您缓存的同步设置，您可以在 GitHub 上的用户偏好设置中启用设置同步。有关更多信息，请参阅“管理您的设置同步偏好设置”。如果您在 Web 客户端中打开 Codespace 并在 Codespace 中启用设置同步，则会在您的用户偏好设置中自动启用设置同步。

在您的用户偏好设置中启用设置同步后，对于在 Web 客户端中打开的 Codespaces，设置同步的行为取决于您的受信任存储库列表。

如果您从受信任的存储库创建 Codespace，则 Codespace 中会默认启用设置同步，因此您的设置将同步到云端和从云端同步。
如果您从尚未添加到受信任存储库列表中的存储库创建 Codespace，则同步将仅在一个方向和一次进行。创建 Codespace 时，您的设置将从云端的缓存设置中提取到 Codespace 中，但从那时起，Codespace 中的设置同步将被关闭。这意味着您在 Codespace 中对设置所做的更新不会推回云端，并且您从其他地方对缓存设置所做的任何更新在您创建 Codespace 后都不会反映在 Codespace 中。

如果您在 Codespace 中启用设置同步，系统会提示您将存储库添加到您的受信任存储库列表中。有关更多信息，请参阅“在 codespace 中启用设置同步”。

您的 GitHub Codespaces 受信任存储库列表在 GPG 验证和设置同步功能之间共享。假设您已启用这两个功能，如果您已为 GPG 验证添加了选定的受信任存储库列表，则会在从这些存储库创建的 Codespaces 中启用设置同步。如果您信任用于设置同步的新存储库，则会为同一存储库启用 GPG 验证。尽管这些功能共享相同的受信任存储库列表，但您可以独立启用或禁用 GPG 验证和设置同步。

注意

如果您之前已为所有存储库启用 GPG 验证，我们建议您更改偏好设置以使用选定的受信任存储库列表。有关更多信息，请参阅GitHub Codespaces 中的安全。

有关管理 GPG 验证偏好设置的更多信息，请参阅管理 GitHub Codespaces 的 GPG 验证。

管理您的设置同步偏好设置

如果您在用户偏好设置中启用设置同步，则在 VS Code Web 客户端中打开的 Codespaces 将从云端提取您的缓存设置，并且从受信任存储库创建的 Codespaces 将双向同步您的缓存设置。

在 GitHub 上任何页面的右上角，单击您的个人资料照片，然后单击设置.
在侧边栏的“代码、规划和自动化”部分，单击 Codespaces。
要启用或禁用设置同步，请在“设置同步”下选择或取消选择启用。
要更改 GPG 验证和设置同步的受信任存储库，请在“受信任存储库”下选择所有存储库，或选择选定存储库，然后使用“选择存储库”下拉菜单添加您信任的存储库。

注意

我们建议使用选定的受信任存储库列表。有关更多信息，请参阅GitHub Codespaces 中的安全。

您的更新将在新的 Codespaces 中生效。但是，您可以在现有的 Codespace 中启用设置同步。有关更多信息，请参阅“在 codespace 中启用设置同步”。

在 codespace 中启用设置同步

注意

您应该只在从您信任的存储库创建的 Codespaces 中启用设置同步。有关更多信息，请参阅GitHub Codespaces 中的安全。

以下过程描述了如何在 Web 客户端中打开的 Codespace 中启用设置同步。有关在 VS Code 桌面应用程序中启用设置同步的信息，请参阅 VS Code 文档中的设置同步。

在 VS Code 中，在活动栏底部选择，然后单击登录以同步设置。
如果您从中创建 Codespace 的存储库不在您的受信任存储库列表中，则会打开一个浏览器窗口，要求您授权设置同步的其他权限。如果您信任该存储库，请单击授权，然后关闭浏览器窗口。Codespace 将重新加载并显示您最新的同步设置。

注意

如果您在用户偏好设置中禁用了设置同步，并将受信任的存储库设置为所有存储库，您将看到有关为所有存储库启用设置同步的警告。查看警告并选择是否为所有存储库启用设置同步或修改您的受信任存储库列表。
要配置要同步的设置，请使用Shift+Command+P（Mac）/Ctrl+Shift+P（Windows/Linux）打开命令面板，然后开始键入“设置同步”。单击设置同步：配置...。
选择要同步的设置，然后单击确定。

在 codespace 中关闭设置同步

您可以关闭设置同步以停止将设置同步到 VS Code 实例和从 VS Code 实例同步设置。

当您在 Codespace 中关闭设置同步时，新的 Codespaces 将继续使用上次将您的设置推送到云端时缓存的设置。如果您对 Codespaces 使用 VS Code Web 客户端，并且希望 Codespaces 使用默认设置而不是您的缓存设置，您可以禁用设置同步。有关更多信息，请参阅“管理您的设置同步偏好设置”。

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

如果您的 VS Code 实例中当前已关闭设置同步，并且您想要清除缓存的设置，您必须先将其打开。有关说明，请参阅“个性化您的 GitHub Codespaces 帐户”。
在活动栏底部选择并单击设置同步已开启。
在下拉菜单中，单击设置同步：关闭。
要清除缓存的设置，请在对话框中选择关闭所有设备上的同步并清除云中的数据。
单击关闭。

配置文件

配置文件是在类 Unix 系统上以.开头的文件和文件夹，用于控制系统上应用程序和 shell 的配置。您可以将您的配置文件存储在 GitHub 上的存储库中。有关在配置文件存储库中包含哪些内容的建议和教程，请参阅GitHub does dotfiles。

您的配置文件存储库可能包含您的 shell 别名和首选项、您想要安装的任何工具或您想要进行的任何其他 Codespace 个性化设置。

您可以通过在您的个人 GitHub Codespaces 设置中选择该存储库来配置 GitHub Codespaces 以使用您拥有的任何存储库中的配置文件。

创建新的 Codespace 时，GitHub 会将您选择的配置文件存储库克隆到 Codespace 环境，并查找以下文件之一以设置环境。

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

如果找不到这些文件，则将您选择的 dotfiles 仓库中以.开头的任何文件或文件夹符号链接到 codespace 的~或$HOME目录。

对您选择的 dotfiles 仓库的任何更改都仅适用于每个新的 codespace，不会影响任何现有的 codespace。

注意

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

为 Codespaces 启用您的 dotfiles 仓库

您可以使用您选择的 dotfiles 仓库来个性化您的 GitHub Codespaces 环境。选择 dotfiles 仓库后，您可以向其中添加脚本、首选项和配置。然后，您需要从您的个人 GitHub Codespaces 设置页面启用您的 dotfiles。

警告

Dotfiles 能够运行任意脚本，这些脚本可能包含意外或恶意代码。在安装 dotfiles 仓库之前，我们建议检查脚本以确保它们不会执行任何意外操作。

在 GitHub 上任何页面的右上角，单击您的个人资料照片，然后单击设置.
在侧边栏的“代码、规划和自动化”部分，单击 Codespaces。
在“Dotfiles”下，选择自动安装 dotfiles，以便 GitHub Codespaces 自动将您的 dotfiles 安装到您创建的每个新的 codespace 中。
使用下拉菜单选择您要从中安装 dotfiles 的仓库。