Skip to main content

GitHub Codespaces overview

This guide introduces GitHub Codespaces and provides details on how it works and how to use it.

GitHub Codespaces is available for organizations using GitHub Team or GitHub Enterprise Cloud. 詳しい情報については「GitHubの製品」を参照してください。

What is a codespace?

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.

GitHub Codespaces run on a variety of VM-based compute options hosted by GitHub.com, which you can configure from 2 core machines up to 32 core machines. You can connect to your codespaces from the browser or locally using Visual Studio Code.

A diagram showing how Codespaces works

GitHub Codespacesを使用する

You can create a codespace from any branch or commit in your repository and begin developing using cloud-based compute resources. Codespacesを使い始めるには、「GitHub Codespacesのクイックスタート」を参照してください。 Codespacesがどのように動作するのか、詳しく学ぶには「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 don't add a dev container configuration, 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 also personalize aspects of your codespace environment by using a public dotfiles repository and Settings Sync. Personalization can include shell preferences, additional tools, editor settings, and VS Code extensions. For more information, see "Customizing your codespace".

Codespacesの支払いについて

For information on pricing, storage, and usage for Codespaces, see "Managing billing for Codespaces."

ノート: Codespacesを利用するには、利用上限を設定しなければなりません。

デフォルトでは、OrganizationもしくはEnterpriseは$0のGitHub Codespacesの利用上限を持っており、これは新しいcodespaceの作成や、既存のcodespaceのオープンを禁止します。 Organiationでユーザがcodespaceを作成できるようにするには、この上限を$0よりも大きな値に設定してください。

超過料金は、支払いの期間に関係なく(アカウントの支払いが年次であっても)常に月次で請求されます。 For information on how organizations owners and billing managers can manage the spending limit for Codespaces for an organization, see "Managing your spending limit for Codespaces."