What are GitHub Codespaces?

Introduction

A codespace is a development environment that's hosted in the cloud. You can customize your project for GitHub Codespaces by committing configuration files to your repository (often known as Configuration-as-Code), which creates a repeatable codespace configuration for all users of your project. See Introdução aos contêineres de desenvolvimento.

Each codespace you create is hosted by GitHub in a Docker container, running on a virtual machine. You can choose from a selection of virtual machine types, from 2 cores, 8 GB RAM, and 32 GB storage, up to 32 cores, 64 GB RAM, and 128 GB storage.

By default, the codespace development environment is created from an Ubuntu Linux image that includes a selection of popular languages and tools, but you can use an image based on a Linux distribution of your choice and configure it for your particular requirements. Regardless of your local operating system, your codespace will run in a Linux environment. Windows and macOS are not supported operating systems for the remote development container.

You can connect to your codespaces from your browser, from Visual Studio Code, or by using GitHub CLI. When you connect, you are placed within the Docker container. You have limited access to the outer Linux virtual machine host.

Using GitHub Codespaces

To begin developing using cloud-based compute resources, you can create a codespace from a template or from any branch or commit in a repository. When you create a codespace from a template, you can start from a blank template or choose a template suitable for the work you're doing.

Para começar a usar o GitHub Codespaces, confira Quickstart for GitHub Codespaces. Para obter mais informações sobre como criar um codespace, confira Como criar um codespace para um repositório ou Como criar um codespace com base em um modelo. Se você quiser retornar a um codespace que já criou, confira Como abrir um codespace existente. Para saber mais sobre como funciona o GitHub Codespaces, confira Deep dive into GitHub Codespaces.

Using codespaces owned by your personal account

All personal GitHub accounts have a monthly quota of free use of GitHub Codespaces included in the Free or Pro plan. You can get started using GitHub Codespaces on your personal account without changing any settings or providing payment details.

If you create a codespace from an organization-owned repository, use of the codespace will either be charged to the organization (if the organization is configured for this), or to your personal account.

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. Confira Sobre o faturamento do GitHub Codespaces.

Using organization-owned codespaces

Owners of organizations on GitHub Team and GitHub Enterprise plans can pay for their members' and collaborators' use of GitHub Codespaces. This applies to codespaces created from repositories owned by the organization. See Como escolher quem tem a propriedade e paga pelos codespaces em sua organização. You can set a spending limit for use of GitHub Codespaces on your organization or enterprise account. See Gerenciar o limite de gastos do GitHub Codespaces.

If use of a codespace will be billed to an organization or enterprise, this is shown when the codespace is created. See Como criar um codespace para um repositório. Codespaces that are billed to an organization, or its parent enterprise, are owned by the organization and can be deleted by an organization owner. See Excluir um codespace.

A capacidade de criar codespaces com base em repositórios de propriedade da organização depende de vários fatores, como a visibilidade do repositório e as configurações da organização ou da empresa-mãe. Para saber mais, confira Solucionar problemas de criação e exclusão de codespaces.

Customizing GitHub Codespaces

To customize the runtimes and tools in your codespace, you can create one or more dev container configurations for your repository. Adding dev container configurations to your repository allows you to define a choice of different development environments that are appropriate for the work people will do in your repository.

If you create a codespace from a repository without any dev container configurations, GitHub Codespaces will clone your repository into an environment with the default dev container image that includes many tools, languages, and runtime environments. If you create a codespace from a template, you might start with some initial configuration on top of the default image. See Introdução aos contêineres de desenvolvimento.

You can personalize aspects of your codespace environment by using a public dotfiles repository. You can use dotfiles to set shell aliases and preferences, or to install your personal preference of the tools you like to use. If you use GitHub Codespaces in the browser, or in Visual Studio Code, you can use Settings Sync to give your codespace editor the same settings, keyboard shortcuts, snippets, and extensions that you have set up in your local installation of Visual Studio Code.

See Personalizando seu codespace.

Billing for Codespaces

For information on pricing, storage, and usage for GitHub Codespaces, see Sobre o faturamento do GitHub Codespaces.

Por padrão, todas as contas têm um limite de gastos de US$ 0 para GitHub Codespaces. Isso impede que novos codespaces sejam criados ou que os codespaces existentes sejam abertos, se isso incorrer em um custo faturável para sua conta pessoal, corporativa ou da organização. Para contas pessoais, se você tiver acesso para criar um codespace, poderá fazê-lo desde que a conta não tenha atingido o limite de seu uso mensal incluído. Para organizações e empresas, o limite de gastos padrão significa que, para permitir que as pessoas criem codespaces que são cobrados para a organização ou sua empresa-mãe, o limite precisa ser alterado para um valor acima de US$ 0.

Os custos de GitHub Codespaces são sempre cobrados mensalmente, mesmo que os outros itens de sua conta sejam cobrados anualmente. For information on how organizations owners and billing managers can manage the spending limit for GitHub Codespaces for an organization, see Gerenciar o limite de gastos do GitHub Codespaces.