创建代码空间

您可以为仓库中的分支创建代码空间以便在线开发。

Codespaces are available for repositories owned by organizations using GitHub Team and GitHub Enterprise Cloud.

代码空间可用于使用 GitHub Team 或 GitHub Enterprise Cloud 的组织。 更多信息请参阅“GitHub 的产品”。

关于代码空间的创建

You can create a codespace on GitHub.com, in Visual Studio Code, or by using GitHub CLI. 您创建的每个代码空间只有您才可以使用。 其他任何人都不能在您的代码空间中工作。

代码空间与仓库的特定分支相关联,且仓库不能为空。 每个仓库甚至每个分支可创建多个代码空间。 However, each user account has a limit of 10 codespaces. 如果您已达到上限,想要创建一个新的代码空间,必须先删除一个旧代码空间。 更多信息请参阅“删除代码空间”。

创建代码空间时,需要执行一些步骤并将您连接到开发环境。

  • 第 1 步:虚拟机和存储被分配到您的代码空间。
  • 第 2 步:创建容器并克隆仓库。
  • 第 3 步:您可以连接到代码空间。
  • 第 4 步:代码空间继续创建后设置。

有关创建代码空间时会发生什么的更多信息,请参阅“深潜”。

For more information on the lifecycle of a codespace, see "Codespaces lifecycle."

If you want to use Git hooks for your codespace, then you should set up hooks using the devcontainer.json lifecycle scripts, such as postCreateCommand, during step 4. Since your codespace container is created after the repository is cloned, any git template directory configured in the container image will not apply to your codespace. Hooks must instead be installed after the codespace is created. For more information on using postCreateCommand, see the devcontainer.json reference in the Visual Studio Code documentation.

使用 Visual Studio Code 在代码空间中开发时,您可以编辑代码、调试和使用 Git 命令。 更多信息请参阅 Visual Studio Code 文档

您可以在 github.com/codespaces 上查看您创建的每一个可用代码空间。

访问 Codespaces

Codespaces are available for repositories owned by organizations using GitHub Team and GitHub Enterprise Cloud.

当您访问 Codespaces 时,在查看仓库时会看到 Code(代码)下拉菜单中的“Codespaces(代码空间)”选项卡。

在以下条件下,您可以访问代码空间:

  • 您是已启用 Codespaces 并设定支出限额的组织的成员。
  • 组织所有者已授予您访问 Codespaces。
  • 仓库归启用 Codespaces 的组织所有。

注意: 已使用个人 GitHub 帐户加入测试版的个人不会失去 Codespaces 访问权限,但个人的 Codespaces 将继续保留在测试版中。

组织所有者可以允许组织的所有成员创建代码空间,将代码空间创建限制为选定的组织成员,或者禁用代码空间的创建。 有关管理对组织内代码空间的访问的更多信息,请参阅“为组织中的用户启用代码空间”。

在组织中使用 Codespaces 之前,所有者或帐单管理员必须设定支出限额。 更多信息请参阅“关于代码空间的支出限额”。

如果想为您的个人帐户或其他用户拥有的仓库创建代码空间, 并且您有权在已启用 Codespaces 的组织中创建仓库, 您可以将用户拥有的仓库复刻到该组织,然后为该复刻创建一个代码空间。

创建代码空间

  1. 在 GitHub.com 上,导航到仓库的主页面。

  2. 在仓库名称下,使用“Branch(分支)”下拉菜单选择您要为其创建代码的分支。

    分支下拉菜单

  3. Under the repository name, use the Code drop-down menu, and in the Codespaces tab, click New codespace.

    新建代码空间按钮

    如果您是组织的成员,并且在该组织拥有的仓库上创建代码空间,您可以选择不同机器类型的选项。 From the dialog box, choose a machine type and then click Create codespace.

    机器类型选择

    Note: Your choice of available machine types may be limited by a policy configured for your organization, or by a minimum machine type specification for your repository. For more information, see "Restricting access to machine types" and "Setting a minimum specification for codespace machines."

After you connect your account on GitHub.com to the GitHub Codespaces extension, you can create a new codespace.

  1. 在 Visual Studio Code 中,从左侧边栏单击 Remote Explorer 图标。 Visual Studio Code 中的 Remote Explorer 图标

  2. 单击 Add(添加)图标,然后单击 Create New Codespace(创建新代码空间)

    Codespaces 中的 Create new Codespace(创建新代码空间)选项

  3. 键入,然后单击要在其中开发仓库的名称。

    搜索仓库以创建新的 Codespaces

  4. 单击要在其中开发的分支。

    搜索分支以创建新的 Codespaces

  5. Click the machine type you want to develop in.

    新 Codespaces 的实例类型

    Note: Your choice of available machine types may be limited by a policy configured for your organization, or by a minimum machine type specification for your repository. For more information, see "Restricting access to machine types" and "Setting a minimum specification for codespace machines."

要了解有关 GitHub CLI 的更多信息,请参阅“关于 GitHub CLI”。

To create a new codespace, use the gh codespace create subcommand.

gh codespace create 

You are prompted to choose a repository, a branch, and a machine type (if more than one is available).

Alternatively, you can use flags to specify some or all of the options:

gh codespace create -r owner/repo -b branch -m machine-type 

Replace owner/repo with the repository identifier. Replace branch with the name of the branch, or the full SHA hash of the commit, that you want to be initially checked out in the codespace. If you use the -r flag without the b flag, the codespace is created from the default branch.

Replace machine-type with a valid identifier for an available machine type. Identifiers are strings such as: basicLinux32gb and standardLinux32gb. The type of machines that are available depends on the repository, your user account, and your location. If you enter an invalid or unavailable machine type, the available types are shown in the error message. If you omit this flag and more than one machine type is available you will be prompted to choose one from a list.

For more information about this command, see the GitHub CLI manual.

此文档对您有帮助吗?

隐私政策

帮助我们创建出色的文档!

所有 GitHub 文档都是开源的。看到错误或不清楚的内容了吗?提交拉取请求。

做出贡献

或者, 了解如何参与。