Skip to main content

Creating a codespace for a repository

You can create a codespace for a branch in a repository to develop online.

About creating a codespace for a repository

codespace は、GitHub.com、Visual Studio Code、または GitHub CLI を使用して作成できます。 Use the tabs in this article to display instructions for each of these ways of creating a codespace.

新しいプロジェクトを始める場合は、テンプレートから codespace を作成して、後で GitHub でリポジトリを発行できます。 For more information, see "Creating a codespace from a template."

Note: If you use a JetBrains IDE, you can use GitHub CLI to create a codespace. You can then use the JetBrains Gateway application to open the codespace in a JetBrains IDE. For more information, see "Using Codespaces in your JetBrains IDE."

You can use GitHub Codespaces on your personal GitHub.com account, with the quota of free use included each month for accounts on the Free and Pro plans. 毎月含まれているストレージとコンピューティングの使用量を超えて GitHub Codespaces を使い続けるには、支払い情報を入力して、利用限度を設定します。 詳しくは、「GitHub Codespaces の支払いについて」をご覧ください。

Organizations can enable members and outside collaborators to create and use codespaces at the organization's expense. For more information, see "Enabling GitHub Codespaces for your organization."

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

If you create a codespace from a repository, the codespace will be associated with a specific branch, which cannot be empty. You can create more than one codespace per repository or even per branch.

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

The codespace creation process

When you create a codespace, a number of steps happen to create and connect you to your development environment:

  • Step 1: VM and storage are assigned to your codespace.
  • Step 2: Container is created and your repository is cloned.
  • Step 3: You can connect to the codespace.
  • Step 4: Codespace continues with post-creation setup.

For more information on what happens when you create a codespace, see "Deep Dive."

For more information on the lifecycle of a codespace, see "The codespace lifecycle."

If you want to use Git hooks for your codespace, then you should set up hooks using the devcontainer.json lifecycle scripts, such as postCreateCommand, during step 4. Since your codespace container is created after the repository is cloned, any git template directory configured in the container image will not apply to your codespace. Hooks must instead be installed after the codespace is created. For more information on using postCreateCommand, see the devcontainer.json reference in the VS Code documentation.

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

To speed up codespace creation, repository administrators can enable GitHub Codespaces prebuilds for a repository. For more information, see "About GitHub Codespaces prebuilds."

Creating a codespace for a repository

  1. On GitHub.com, navigate to the main page of the repository.

  2. Under the repository name, use the "Branch" dropdown menu, and select the branch you want to create a codespace for.

    Branch dropdown menu

  3. Click the Code button, then click the Codespaces tab.

    New codespace button

    If codespaces for this repository are billable to an organization, or its parent enterprise, a message is displayed below the Create codespace on BRANCH button telling you who will pay for the codespace.

  4. Create your codespace, either using the default options, or after configuring advanced options:

    • Use the default options

      To create a codespace using the default options, click the plus sign (). Alternatively, if you don't currently have any codespaces for this repository, you can click Create codespace on BRANCH.

    • Configure options

      To configure advanced options for your codespace, such as a different machine type or a particular devcontainer.json file:

      1. Click the ellipsis (...) at the top right of the Codespaces tab and select New with options.

        View the default machine type

      2. On the options page for your codespace, choose your preferred options from the dropdown menus.

        The codespace options page

        Notes

      3. Click Create 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 について」を参照してください。

To create a new codespace, use the gh codespace create subcommand.

gh codespace create 

You are prompted to choose a repository. If codespaces for this repository are billable to an organization, or its parent enterprise, a message is displayed telling you who will pay for the codespace. You are then prompted to choose a branch, a dev container configuration file (if more than one is available), and a machine type (if more than one is available).

Alternatively, you can use flags to specify some or all of the options:

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

In this example, replace owner/repo with the repository identifier. Replace branch with the name of the branch, or the full SHA hash of the commit, that you want to be initially checked out in the codespace. If you use the -r flag without the b flag, the codespace is created from the default branch.

Replace path with the path to the dev container configuration file you want to use for the new codespace. If you omit this flag and more than one dev container file is available you will be prompted to choose one from a list. For more information about the dev container configuration file, see "Introduction to dev containers."

Replace machine-type with a valid identifier for an available machine type. Identifiers are strings such as: basicLinux32gb and standardLinux32gb. The type of machines that are available depends on the repository, your personal account, and your location. If you enter an invalid or unavailable machine type, the available types are shown in the error message. If you omit this flag and more than one machine type is available you will be prompted to choose one from a list.

For full details of the options for this command, see the GitHub CLI manual.

Further reading