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 Présentation des conteneurs de développement.

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.

Pour bien commencer avec GitHub Codespaces, consultez Quickstart for GitHub Codespaces. Pour plus d’informations sur la création d’un codespace, consultez Création d’un codespace pour un dépôt ou Création d’un codespace à partir d’un modèle. Si vous souhaitez revenir à un codespace que vous avez déjà créé, consultez Ouverture d’un codespace existant. Pour en savoir plus sur le fonctionnement de GitHub Codespaces, consultez 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.

Vous pouvez continuer à utiliser GitHub Codespaces au-delà de votre utilisation mensuelle de stockage et de calcul comprise, en fournissant des détails de paiement et en définissant une limite de dépense. Consultez À propos de la facturation pour 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 Choisir qui possède et achète les codespaces dans votre organisation. You can set a spending limit for use of GitHub Codespaces on your organization or enterprise account. See Gestion de la limite de dépense pour GitHub Codespaces.

If use of a codespace will be billed to an organization or enterprise, this is shown when the codespace is created. See Création d’un codespace pour un dépôt. 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 Suppression d’un codespace.

Votre capacité à créer des codespaces à partir de dépôts appartenant à l’organisation dépend de plusieurs facteurs, notamment la visibilité du dépôt et les paramètres de l’organisation ou de son entreprise parente. Pour plus d’informations, consultez « Résolution des problèmes de création et de suppression 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 Présentation des conteneurs de développement.

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 Personnalisation de votre codespace.

Billing for Codespaces

For information on pricing, storage, and usage for GitHub Codespaces, see À propos de la facturation pour GitHub Codespaces.

Par défaut, tous les comptes ont une limite de dépense GitHub Codespaces de 0 USD. Cette limite empêche de créer de nouveaux codespaces et d’ouvrir des codespaces existants, sous peine d’entraîner un coût facturable à votre compte personnel, d’organisation ou d’entreprise. Pour les comptes personnels, si vous avez accès à la création d’un codespace, vous pouvez le faire tant que le compte n’a pas atteint les limites fixées pour son utilisation mensuelle. Pour les organisations et les entreprises, la limite de dépense par défaut signifie que, pour permettre aux utilisateurs de créer des codespaces facturés à l’organisation ou à son entreprise parente, la limite doit être remplacée par une valeur supérieure à 0 USD.

Les coûts de GitHub Codespaces sont toujours facturés mensuellement, même si votre compte est par ailleurs facturé annuellement. For information on how organizations owners and billing managers can manage the spending limit for GitHub Codespaces for an organization, see Gestion de la limite de dépense pour GitHub Codespaces.