Using GitHub Codespaces in Visual Studio Code

About GitHub Codespaces in Visual Studio Code

You can use your local install of Visual Studio Code to create, manage, work in, and delete codespaces. To use GitHub Codespaces in VS Code, you need to install the Codespaces extension. For more information on setting up Codespaces in VS Code, see "Prerequisites."

By default, if you create a new codespace on GitHub.com, it will open in the browser. If you would prefer to open any new codespaces in VS Code automatically, you can set your default editor to be VS Code. For more information, see "Setting your default editor for GitHub Codespaces."

If you prefer to work in the browser, but want to continue using your existing VS Code extensions, themes, and shortcuts, you can turn on Settings Sync. For more information, see "Personalizing GitHub Codespaces for your account."

Prerequisites

To develop in a codespace directly in VS Code, you must install and sign into the Codespaces extension with your GitHub credentials. The Codespaces extension requires VS Code October 2020 Release 1.51 or later.

Use the Visual Studio Code Marketplace to install the Codespaces extension. For more information, see Extension Marketplace in the VS Code documentation.

Creating a codespace in VS Code

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

1. In VS Code, in the left sidebar, click the Remote Explorer icon.

   

   Note: If the Remote Explorer is not displayed in the Activity Bar:

   1. Access the Command Palette. For example, by pressing Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux).
   2. Type: codespaces.
   3. Click Codespaces: Details.

2. [追加] アイコン をクリックします。

   

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

   

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

   

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

   

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

   

   注: 使用可能なマシンの種類の選択は、組織に設定されたポリシーまたはリポジトリの最低限のマシンのタイプの仕様によって制限される場合があります。 詳細については、「マシンのタイプへのアクセスの制限」および「コードスペース マシンの最低限の仕様の設定」を参照してください。

Opening a codespace in VS Code

1. In VS Code, in the left sidebar, click the Remote Explorer icon.

   

   Note: If the Remote Explorer is not displayed in the Activity Bar:

   1. Access the Command Palette. For example, by pressing Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux).
   2. Type: codespaces.
   3. Click Codespaces: Details.

2. Under "Codespaces", click the codespace you want to develop in.

3. Click the Connect to Codespace icon.

   

Changing the machine type in VS Code

通常、2 コアから 32 コアの任意のリモート マシン上で codespace を実行できます。 これらはそれぞれ、異なるレベルのリソースと支払い層を持っています。 詳しくは、「GitHub Codespaces の支払いについて」をご覧ください。

既定では、codespace を作成するときに、有効なリソースが最も少ないマシンの種類が使われます。 You can change the machine type of your codespace at any time.

1. In VS Code, open the Command Palette (shift command P / shift control P).

2. Search for and select "Codespaces: Change Machine Type."

   

3. Click the codespace that you want to change.

   

4. Choose the machine type you want to use.

   Note: 使用可能なマシンの種類の選択は、組織に設定されたポリシーまたはリポジトリの最低限のマシンのタイプの仕様によって制限される場合があります。 詳細については、「マシンのタイプへのアクセスの制限」および「コードスペース マシンの最低限の仕様の設定」を参照してください。

5. If the codespace is currently running, a message is displayed asking if you would like to restart and reconnect to your codespace now.

   Click Yes if you want to change the machine type used for this codespace immediately.

   If you click No, or if the codespace is not currently running, the change will take effect the next time the codespace restarts.

Deleting a codespace in VS Code

現在 codespace で作業していない場合、VS Code 内から codespace を削除できます。

1. In VS Code, in the left sidebar, click the Remote Explorer icon.

   

   Note: If the Remote Explorer is not displayed in the Activity Bar:

   1. Access the Command Palette. For example, by pressing Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux).
   2. Type: codespaces.
   3. Click Codespaces: Details.

2. [GITHUB CODESPACE] で、削除する codespace を右クリックします。

3. [Codespace の削除] をクリックします。

   

Switching to the Insiders build of VS Code

You can use the Insiders Build of VS Code within Codespaces.

1. In bottom left of your Codespaces window, select Settings.

2. From the list, select "Switch to Insiders Version".

   

3. Once selected, Codespaces will continue to open in Insiders Version.