4.4 KiB
title, shortTitle, intro, allowTitleToDifferFromFilename, redirect_from, versions, type, topics
| title | shortTitle | intro | allowTitleToDifferFromFilename | redirect_from | versions | type | topics | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GitHub Codespaces overview | Overview | This guide introduces {% data variables.product.prodname_github_codespaces %} and provides details on how it works and how to use it. | true |
|
|
overview |
|
What is a codespace?
A codespace is a development environment that's hosted in the cloud. You can customize your project for {% data variables.product.prodname_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.
Each codespace runs on a virtual machine hosted by {% data variables.product.prodname_dotcom_the_website %}. You can choose the type of machine you want to use, depending on the resources you need. Various types of machine are available, starting with a 2-core processor, 4 GB of RAM, and 32 GB of storage.
You can connect to your codespaces from your browser, from {% data variables.product.prodname_vscode %}, from the JetBrains Gateway application, or by using {% data variables.product.prodname_cli %}.
Using {% data variables.product.prodname_github_codespaces %}
You can create a codespace from any branch or commit in your repository and begin developing using cloud-based compute resources. {% data reusables.codespaces.links-to-get-started %}
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 don't add a dev container configuration, {% data variables.product.prodname_github_codespaces %} will clone your repository into an environment with the default codespace image that includes many tools, languages, and runtime environments. For more information, see "Introduction to dev containers".
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 {% data variables.product.prodname_github_codespaces %} in the browser, or in {% data variables.product.prodname_vscode %}, 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 {% data variables.product.prodname_vscode %}.
For more information, see "Customizing your codespace".
About billing for {% data variables.product.prodname_codespaces %}
For information on pricing, storage, and usage for {% data variables.product.prodname_github_codespaces %}, see "About billing for {% data variables.product.prodname_github_codespaces %}."
{% data reusables.codespaces.codespaces-spending-limit-requirement %}
{% data reusables.codespaces.codespaces-monthly-billing %} For information on how organizations owners and billing managers can manage the spending limit for {% data variables.product.prodname_github_codespaces %} for an organization, see "Managing spending limits for {% data variables.product.prodname_github_codespaces %}."
You can see who will pay for a codespace before you create it. For more information, see "Creating a codespace."