Skip to main content
We publish frequent updates to our documentation, and translation of this page may still be in progress. For the most current information, please visit the English documentation.

リポジトリの codespace を作成する

リポジトリのブランチの codespace を作成して、オンラインで開発できます。

リポジトリの codespace の作成について

codespace は、GitHub.com、Visual Studio Code、または GitHub CLI を使用して作成できます。 この記事のタブを使用して、codespace を作成するこれらの各方法の手順を表示します。

新しいプロジェクトを始める場合は、テンプレートから codespace を作成して、後で GitHub でリポジトリを発行できます。 詳細については、「テンプレートから codespace を作成する」を参照してください。

: JetBrains IDE を使用する場合は、GitHub CLI を使用して codespace を作成できます。 その後、JetBrains Gateway アプリケーションを使用して、JetBrains IDE で codespace を開くことができます。 詳細については、「JetBrains IDE での Codespaces の使用」を参照してください。

個人の GitHub.com アカウントで GitHub Codespaces を使用できます。Free プランと Pro プランのアカウントには毎月無料使用のクォータが含まれています。 毎月含まれているストレージとコンピューティングの使用量を超えて GitHub Codespaces を使い続けるには、支払い情報を入力して、利用限度を設定します。 詳しくは、「GitHub Codespaces の支払いについて」をご覧ください。

組織は、メンバーと外部コラボレーターが組織の費用で codespace を作成して使用できるようにすることができます。 詳しくは、「Organization での GitHub Codespaces の有効化」をご覧ください。

各コードスペースは、作成者だけが利用できます。 他者のcodespaceで作業することはできません。

リポジトリから codespace を作成すると、codespace は特定のブランチに関連付けられます。空にすることはできません。 リポジトリごと、さらにはブランチごとに1つ以上のcodespaceを作成できます。

github.com/codespaces で作成したすべての使用可能な codespace を確認できます。

codespace の作成プロセス

codespace を作成すると、開発環境を作成して開発環境に接続するためのいくつかの手順が発生します。

  • 手順 1: VM とストレージが codespace に割り当てられます。
  • 手順 2: コンテナーが作成され、リポジトリが複製されます。
  • 手順 3: codespace に接続できます。
  • 手順 4: codespace では、作成後のセットアップが続行されます。

codespace を作成した場合に起きることの詳細については、詳細情報に関するページを参照してください。

codespace のライフサイクルの詳細については、「Codespace のライフサイクル」を参照してください。

codespace に Git フックを使用する場合は、手順 4. で devcontainer.jsonライフサイクル スクリプト (例: postCreateCommand) を使用してフックを設定する必要があります。 リポジトリの複製後に codespace コンテナーが作成されるため、コンテナー イメージで構成された Git テンプレート ディレクトリ は codespace には適用されません。 代わりに、codespace の作成後にフックをインストールする必要があります。 postCreateCommand の使用について詳しくは、VS Code ドキュメントの「devcontainer.json リファレンス」を参照してください。

VS Code の codespace で開発をする際に、コードを編集し、デバッグし、Gti のコマンドを使うことができます。 詳しい情報については、VS Code のドキュメントを参照してください。

コードスペースの作成を高速化するために、リポジトリ管理者はリポジトリの GitHub Codespaces プレビルドを有効にすることができます。 詳しくは、「GitHub Codespaces プレビルドについて」をご覧ください。

リポジトリの codespace を作成する

  1. GitHub.com で、リポジトリのメイン ページへ移動します。

  2. リポジトリ名の下で、[ブランチ] ドロップダウンメニューを使用して、codespace を作成するブランチを選びます。

    [ブランチ] ドロップダウンメニュー

  3. [ コード] ボタンをクリックし、 [Codespaces] タブをクリックします。

    [New codespace] ボタン

    このリポジトリの codespace が組織、またはその親エンタープライズに対して課金可能な場合は、 [<ブランチ名> で codespace を作成する] ボタンの下に、codespace の料金を支払うユーザーを示すメッセージが表示されます。

  4. 既定のオプションを使用するか、詳細オプションを構成した後に、codespace を作成します。

    • 既定のオプションを使用する

      既定のオプションを使用して codespace を作成するには、プラス記号 () をクリックします。 または、現在このリポジトリの codespace がない場合は、 [ブランチで codespace を作成する] をクリックできます。

    • 構成オプション

      別のマシンの種類や特定の devcontainer.json ファイルなど、codespace の詳細オプションを構成するには:

      1. [Codespaces] タブの右上にある省略記号 ( ... ) をクリックし、 [オプションを含む新規] を選びます。

        既定のマシンの種類を表示する

      2. codespace のオプション ページで、ドロップダウン メニューから任意のオプションを選びます。

        codespace のオプション ページ

        メモ

        • オプション ページをブックマークすると、このリポジトリとブランチの codespace をすばやく作成できるようになります。
        • https://github.com/codespaces/new ページでは、リポジトリとブランチの codespace をすばやく作成できます。 ブラウザーのアドレス バーに「codespace.new」と入力すると、このページにすばやくアクセスできます。
        • devcontainer.json ファイルの詳細については、「開発コンテナーの概要」をご覧ください。
        • マシンの種類について詳しくは、「codespace のマシンの種類を変更する」をご覧ください。
        • 使用可能なマシンは、数多くの要因によって、選択の幅が制限されます。 これには、Organization に対して構成されているポリシーや、リポジトリでの最低限の種類のマシン仕様が含まれます。 詳細については、「マシンのタイプへのアクセスの制限」および「コードスペース マシンの最低限の仕様の設定」を参照してください。
      3. [Create codespace](codespace の作成) をクリックします。

GitHub.com のアカウントを GitHub Codespaces 拡張機能に接続したら、新しい codespace を作成することができます。 GitHub Codespaces 拡張機能の詳しい情報については、VS Code Marketplace に関するページを参照してください。

  1. VS Code の左サイドバーで、[リモート エクスプローラー] のアイコンをクリックします。

    Visual Studio Code のリモート エクスプローラー アイコン

    : リモート エクスプローラーがアクティビティ バーに表示されない場合:

    1. コマンド パレットにアクセスします。 たとえば、Shift + Command + P (Mac) / Ctrl + Shift + P (Windows/Linux) を押します。
    2. 次のコマンドを入力します: codespaces
    3. [コードスペース: 詳細] をクリックします。
  2. [追加] アイコン をクリックします。

    GitHub Codespaces の [Create New Codespace] オプション

  3. 開発するリポジトリの名前を入力し、それを選択します。

    新しい codespace を作成するためのリポジトリを検索する

    選択したリポジトリが組織所有であり、このリポジトリの料金がその組織かその親会社に請求されるよう、codespace が設定されている場合、後続のプロンプトにメッセージが表示され、codespace の料金の支払者が伝えられます。

  4. 開発するブランチをクリックします。

    新しい codespace を作成するためのブランチを検索する

  5. 開発コンテナー構成ファイルの選択を求められたら、一覧からファイルを選びます。

    GitHub Codespaces の開発コンテナー構成ファイルの選択

  6. 使用するマシンの種類をクリックします。

    新しい codespace のインスタンス型

    : 使用可能なマシンは、数多くの要因によって、選択の幅が制限されます。 これには、Organization に対して構成されているポリシーや、リポジトリでの最低限の種類のマシン仕様が含まれます。 詳細については、「マシンのタイプへのアクセスの制限」および「コードスペース マシンの最低限の仕様の設定」を参照してください。

GitHub CLI の詳細については、「GitHub CLI について」を参照してください。

新しい codespace を作成するには、gh codespace create サブコマンドを使用します。

gh codespace create

リポジトリの選択を求められます。 このリポジトリの codespace が組織、またはその親エンタープライズに対して課金可能な場合は、codespace の料金を支払うユーザーを示すメッセージが表示されます。 その場合、ブランチ、開発コンテナー構成ファイル (複数ある場合)、コンピューターの種類 (複数ある場合) を選ぶように求められます。

または、フラグを使用して、次に示すオプションの一部またはすべてを特定することもできます。

gh codespace create -r OWNER/REPO -b BRANCH --devcontainer-path PATH -m MACHINE-TYPE

この例の owner/repo をリポジトリ識別子に置き換えます。 branch を codespace で最初にチェックアウトするブランチの名前、またはコミットの完全な SHA ハッシュに置き換えます。 b フラグなしで -r フラグを使用する場合、codespace は既定のブランチから作成されます。

新しいコードスペースで使用する開発コンテナー構成ファイルへのパスに path を置き換えます。 このフラグを省略し、複数の開発コンテナー ファイルを使用できる場合は、リストから 1 つを選ぶダイアログが表示されます。 開発コンテナーの構成ファイルについて詳しくは、「開発コンテナーの概要」を参照してください。

machine-type を使用可能なマシンの種類の有効な識別子に置き換えます。 識別子は、basicLinux32gbstandardLinux32gb のような文字列です。 使用可能なマシンの種類は、リポジトリ、個人用アカウント、場所によって異なります。 無効または使用できないマシンの種類を入力すると、使用可能な種類がエラー メッセージに表示されます。 このフラグを省略し、複数のマシンの種類を使用できる場合は、リストから 1 つを選択するダイアログが表示されます。

このコマンドのオプションについて詳しくは、GitHub CLI マニュアルを参照してください。

参考資料