Creating a codespace

You can create a codespace for a branch in a repository to develop online.

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

Codespaces is available for organizations using GitHub Team or GitHub Enterprise Cloud. Para obter mais informações, consulte os "produtos do GitHub".

About codespace creation

You can create a codespace on GitHub.com, in Visual Studio Code, or by using GitHub CLI. Cada espaço de código que criar só está disponível para você. Ninguém mais pode trabalhar no seu espaço de código.

Codespaces are associated with a specific branch of a repository and the repository cannot be empty. Você pode criar mais de um código de espaço por repositório ou até mesmo por branch. No entanto, cada conta de usuário tem um limite de 10 codespaces. Se você atingiu o limite e deseja criar um novo espaço de código, você deve primeiro excluir um código. For more information, see "Deleting a codespace."

When you create a codespace, a number of steps happen to create and connect you to your development environment:

  • Step 1: VM and storage are assigned to your codespace.
  • Step 2: Container is created and your repository is cloned.
  • Step 3: You can connect to the codespace.
  • Step 4: Codespace continues with post-creation setup.

For more information on what happens when you create a codespace, see "Deep Dive."

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.

Você pode editar código, depurar e usar comandos do Git ao mesmo tempo que faz o desenvolvimento em um codespace com Visual Studio Code. For more information, see the Visual Studio Code documentation.

Você pode ver todos os códigos disponíveis que você criou em github.com/codespaces.

Access to Codespaces

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

When you have access to Codespaces, you'll see a "Codespaces" tab within the Code drop-down menu when you view a repository.

You'll have access to codespaces under the following conditions:

  • You are a member of an organization that has enabled Codespaces and set a spending limit.
  • An organization owner has granted you access to Codespaces.
  • The repository is owned by the organization that has enabled Codespaces.

Note: Individuals who have already joined the beta with their personal GitHub account will not lose access to Codespaces, however Codespaces for individuals will continue to remain in beta.

Organization owners can allow all members of the organization to create codespaces, limit codespace creation to selected organization members, or disable codespace creation. For more information about managing access to codespaces within your organization, see "Enable Codespaces for users in your organization."

Before Codespaces can be used in an organization, an owner or billing manager must have set a spending limit. For more information, see "About spending limits for Codespaces."

If you would like to create a codespace for a repository owned by your personal account or another user, and you have permission to create repositories in an organization that has enabled Codespaces, you can fork user-owned repositories to that organization and then create a codespace for the fork.

Creating a codespace

  1. No GitHub.com, navegue até a página principal do repositório.

  2. Under the repository name, use the "Branch" drop-down menu, and select the branch you want to create a codespace for.

    Branch drop-down menu

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

    New codespace button

    If you are a member of an organization and are creating a codespace on a repository owned by that organization, you can select the option of a different machine type. From the dialog, choose a machine type and then click Create codespace. Machine type choice

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

  1. Em Visual Studio Code, na barra lateral esquerda, clique no ícone Remote Explorer. O ícone do Remote Explorer em Visual Studio Code

  2. Clique no ícone Adicionar e, em seguida, clique em Criar novo codespace.

    A opção "Criar novo codespace" em Codespaces

  3. Digite e, em seguida, clique no nome do repositório no qual você deseja desenvolver.

    Pesquisar um repositório para criar um novo Codespaces

  4. Clique no branch que você deseja desenvolver.

    Pesquisar um branch para criar um novo Codespaces

  5. Clique no tipo de máquina na qual você deseja desenvolver.

    Tipos de instância para um novo Codespaces

Para saber mais sobre GitHub CLI, consulte "Sobre 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.

Esse documento ajudou você?

Política de Privacidade

Ajude-nos a tornar esses documentos ótimos!

Todos os documentos do GitHub são de código aberto. Você percebeu que algo que está errado ou não está claro? Envie um pull request.

Faça uma contribuição

Ou, aprenda como contribuir.