Skip to main content

Creating a codespace for a repository

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

About creating a codespace for a repository

Você pode criar um codespace em GitHub.com, em Visual Studio Code, ou usando GitHub CLI. Use the tabs in this article to display instructions for each of these ways of creating a codespace.

Ao iniciar um novo projeto, você pode criar um codespace com base em um modelo e publicá-lo mais tarde em um repositório no GitHub. For more information, see "Creating a codespace from a template."

Note: If you use a JetBrains IDE, you can use GitHub CLI to create a codespace. You can then use the JetBrains Gateway application to open the codespace in a JetBrains IDE. For more information, see "Using Codespaces in your JetBrains IDE."

You can use GitHub Codespaces on your personal GitHub.com account, with the quota of free use included each month for accounts on the Free and Pro plans. Você pode continuar usando o GitHub Codespaces além do uso mensal incluído de armazenamento e computação fornecendo detalhes de pagamento e definindo um limite de gastos. Para obter mais informações, confira "Sobre a cobrança do GitHub Codespaces".

Organizations can enable members and outside collaborators to create and use codespaces at the organization's expense. For more information, see "Enabling GitHub Codespaces for your organization."

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.

If you create a codespace from a repository, the codespace will be associated with a specific branch, which cannot be empty. You can create more than one codespace per repository or even per branch.

Você poderá ver todos os codespaces disponíveis que criou em github.com/codespaces.

The codespace creation process

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 "The codespace 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 VS Code documentation.

Você pode editar código, depurar e usar comandos do Git ao mesmo tempo que faz o desenvolvimento em um codespace com VS Code. Para obter mais informações, confira a documentação do VS Code.

To speed up codespace creation, repository administrators can enable GitHub Codespaces prebuilds for a repository. For more information, see "About GitHub Codespaces prebuilds."

Creating a codespace for a repository

  1. On GitHub.com, navigate to the main page of the repository.

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

    Branch dropdown menu

  3. Click the Code button, then click the Codespaces tab.

    New codespace button

    If codespaces for this repository are billable to an organization, or its parent enterprise, a message is displayed below the Create codespace on BRANCH button telling you who will pay for the codespace.

  4. Create your codespace, either using the default options, or after configuring advanced options:

    • Use the default options

      To create a codespace using the default options, click the plus sign (). Alternatively, if you don't currently have any codespaces for this repository, you can click Create codespace on BRANCH.

    • Configure options

      To configure advanced options for your codespace, such as a different machine type or a particular devcontainer.json file:

      1. Click the ellipsis (...) at the top right of the Codespaces tab and select New with options.

        View the default machine type

      2. On the options page for your codespace, choose your preferred options from the dropdown menus.

        The codespace options page

        Notes

      3. Click Create codespace.

Depois de conectar a conta no GitHub.com à extensão GitHub Codespaces, você poderá criar um codespace. Para obter mais informações sobre a extensão GitHub Codespaces, veja o VS Code Marketplace.

  1. Em VS Code, na barra lateral esquerda, clique no ícone do Gerenciador Remoto.

    O ícone do Remote Explorer no Visual Studio Code

    Note: If the Remote Explorer is not displayed in the Activity Bar:

    1. Access the Command Palette. For example, by pressing Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux).
    2. Type: codespaces.
    3. Click Codespaces: Details.
  2. Clique no ícone de Adição: .

    A opção Criar codespace nos GitHub Codespaces

  3. Digite o nome do repositório no qual você deseja desenvolver e selecione-o.

    Como procurar um repositório para criar um codespace

    Se o repositório escolhido pertencer a uma organização e a organização tiver configurado os codespaces desse repositório como faturáveis para a organização ou empresa matriz, uma mensagem será exibida nos próximos prompts informando quem pagará pelo codespace.

  4. Clique no branch que você deseja desenvolver.

    Como procurar um branch para criar um codespace

  5. Se solicitado a escolher um arquivo de configuração de contêiner de desenvolvimento, escolha um arquivo na lista.

    Como escolher um arquivo de configuração de contêiner de desenvolvimento para GitHub Codespaces

  6. Clique no tipo de computador que você quer usar.

    Tipos de instância para um novo codespace

    Observação: Sua escolha de tipos de computador disponíveis pode ser limitada por vários fatores. Esses fatores podem incluir uma política configurada para a organização ou uma especificação mínima de tipo de computador para o repositório. Para obter mais informações, confira "Como restringir o acesso aos tipos de computadores" e "Como definir uma especificação mínima para computadores de codespace".

Para saber mais sobre a GitHub CLI, confira "Sobre a GitHub CLI".

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

gh codespace create 

You are prompted to choose a repository. If codespaces for this repository are billable to an organization, or its parent enterprise, a message is displayed telling you who will pay for the codespace. You are then prompted to choose a branch, a dev container configuration file (if more than one is available), 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 --devcontainer-path PATH -m MACHINE-TYPE

In this example, 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 path with the path to the dev container configuration file you want to use for the new codespace. If you omit this flag and more than one dev container file is available you will be prompted to choose one from a list. For more information about the dev container configuration file, see "Introduction to dev containers."

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 personal 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 full details of the options for this command, see the GitHub CLI manual.

Further reading