Skip to main content

GitHub Codespaces の概要

このガイドでは、GitHub Codespaces について紹介し、そのしくみと使用方法について詳しく説明します。

codespace とは

codespace は、クラウドでホストされている開発環境です。 構成ファイルをリポジトリにコミットすることで、GitHub Codespaces のプロジェクトをカスタマイズできます (コードとしての構成とよく呼ばれます)。これにより、プロジェクトのすべてのユーザーに対して繰り返し可能な codespace 構成が作成されます。

各 codespace は、GitHub によってホストされる仮想マシン上で実行されます。 必要なリソースに応じて、使用するマシンの種類を選ぶことができます。 2 コア プロセッサ、4 GB の RAM、32 GB のストレージから始まるさまざまな種類のマシンをお使いいただけます。

codespace への接続には、ブラウザー、Visual Studio Code、JetBrains Gateway アプリケーション、または GitHub CLI を使うことができます。

GitHub Codespaces のしくみを示す図

GitHub Codespaces の使用

クラウドベースのコンピューティング リソースを使用して開発を開始するには、テンプレートまたは任意のブランチから codespace を作成するか、リポジトリにコミットします。 テンプレートから codespace を作成する場合は、空白のテンプレートから開始するか、作業に適したテンプレートを選ぶことができます。

GitHub Codespaces で作業を開始するには、「GitHub Codespaces のクイックスタート」を参照してください。 codespace の作成に関する詳細については、「リポジトリの codespace の作成」と「テンプレートから codespace を作成する」を参照してください。 既に作成した codespace に戻る場合は、「既存の codespace を開く」を参照してください。 GitHub Codespaces のしくみについて詳しくは、「GitHub Codespaces の詳細」をご覧ください。

個人アカウントが所有する codespace の使用

すべての個人 GitHub.com アカウントには、無料または Pro プランに含まれる GitHub Codespaces の無料使用の月次クォータがあります。 設定を変更したり、支払いの詳細を指定したりせずに、個人アカウントで GitHub Codespaces を使い始めることができます。

クローンできる任意のリポジトリに対して codespace を作成して使うことができます。 テンプレートを使用して、最初はリポジトリに関連付けられていない codespace を作成することもできます。 Organization 所有のリポジトリから codespace を作成した場合、codespace の使用は Organization (Organization がこれに対して構成されている場合) または個人アカウントに対して課金されます。 テンプレートから作成された codespace は、常に個人アカウントに課金されます。

毎月含まれているストレージとコンピューティングの使用量を超えて GitHub Codespaces を使い続けるには、支払い情報を入力して、利用限度を設定します。 詳しくは、「GitHub Codespaces の支払いについて」をご覧ください。

Organization 所有の codespace の使用

Organization の所有者は、GitHub Codespaces の使用を有効にすることができ、Organization または Enterprise アカウントに対して課金できます。 これは、Organization が所有するリポジトリから作成された codespace に適用されます。 詳しくは、「Organization での GitHub Codespaces の有効化」をご覧ください。 Organization または Enterprise アカウントで GitHub Codespaces を使用するための使用制限を設定できます。 詳しくは、「GitHub Codespaces の利用上限の管理」をご覧ください。

codespace の使用が Organization または Enterprise に課金される場合は、codespace の作成時に表示されます。 詳しくは、「リポジトリの codespace を作成する」を参照してください。 組織、またはその親エンタープライズに課金される codespace は、組織によって所有され、組織の所有者が削除できます。 詳細については、「codespace の削除」を参照してください。

GitHub Codespaces のカスタマイズ

codespace のランタイムとツールをカスタマイズするには、リポジトリ用に 1 つ以上の開発コンテナー構成を作成できます。 開発コンテナー構成をリポジトリに追加すると、ユーザーがリポジトリで実行する作業に適したさまざまな開発環境の選択肢を定義できます。

開発コンテナーを構成せずに、リポジトリから codespace を作成する場合、GitHub Codespaces によって、多くのツール、言語、ランタイム環境が含まれる既定の codespace イメージを含む環境に、リポジトリがクローンされます。 テンプレートから codespace を作成する場合は、既定のイメージの上のいくつかの初期構成から開始できます。 詳細については、開発コンテナーの概要に関するページをご覧ください。

パブリック ドットファイル リポジトリを使用して、codespace 環境の側面をカスタマイズできます。 ドットファイルを使用して、シェルのエイリアスと基本設定を設定したり、使用するツールの個人用設定をインストールしたりすることができます。 ブラウザーまたは Visual Studio Code で GitHub Codespaces を使う場合は、設定同期 を使用して、Visual Studio Code のローカル インストールで設定したのと同じ設定、キーボード ショートカット、スニペット、拡張機能を codespace エディターに付与できます。

詳細については、「codespace のカスタマイズ」を参照してください。

Codespaces への請求

GitHub Codespaces の価格、ストレージ、使用方法について詳しくは、「GitHub Codespaces の課金について」を参照してください。

注: 個人、Organization、または Enterprise アカウントに対する GitHub Codespaces の使用の課金が発生する前に、そのアカウントにゼロ以外の使用制限を設定する必要があります。

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

Costs for GitHub Codespaces are always billed monthly, even if your account is otherwise billed annually. Organization オーナーと課金マネージャーが Organization での GitHub Codespaces の利用制限を管理する方法については、「GitHub Codespaces の利用制限の管理」を参照してください。