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 開発コンテナーの概要.

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.

GitHub Codespaces の概要については、「Quickstart for GitHub Codespaces」を参照してください。 codespace の作成の詳細については、「リポジトリの codespace を作成する」または「テンプレートから codespace を作成する」を参照してください。 既に作成した codespace に戻る場合は、「既存の codespace を開く」を参照してください。 GitHub Codespaces のしくみの詳細については、「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.

毎月含まれているストレージとコンピューティングの使用量を超えて GitHub Codespaces を使い続けるには、支払い情報を入力して、利用限度を設定します。 「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 組織内の codespace を誰が所有し、支払うかの選択. You can set a spending limit for use of GitHub Codespaces on your organization or enterprise account. See GitHub Codespaces の使用制限の管理.

If use of a codespace will be billed to an organization or enterprise, this is shown when the codespace is created. See リポジトリの codespace を作成する. 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 codespace を削除する.

組織所有のリポジトリから codespace を作成できるかどうかは、リポジトリの可視性、組織またはその親企業の設定など、いくつかの要因によって異なります。 詳しくは、「codespace の作成と削除のトラブルシューティング」をご覧ください。

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 開発コンテナーの概要.

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 codespace のカスタマイズ.

Billing for Codespaces

For information on pricing, storage, and usage for GitHub Codespaces, see GitHub Codespaces の請求について.

既定で、GitHub Codespaces の使用制限は、すべてのアカウントで 0 米ドルです。 これにより、個人、Organization または Enterprise に課金対象のコストが発生してしまうため、新しい codespace を作成したり、既存の codespace を開くことを防ぐことができます。 個人用アカウントについては、codespace を作成するアクセス権があれば、アカウントが毎月含まれる使用量の制限に達していない限り、これを行うことができます。 Organization と Enterprise の既定の使用制限は、請求先を Organization またはその親 Enterprise とする codespace をユーザーが作成する場合には、上限を 0 米ドルを超える値に変更する必要があることを意味します。

GitHub Codespaces のコストは、お使いのアカウントが年単位の請求になっているとしても、常に毎月請求されます。 For information on how organizations owners and billing managers can manage the spending limit for GitHub Codespaces for an organization, see GitHub Codespaces の使用制限の管理.