Changing the machine type for your codespace

You can change the type of machine that's running your codespace, so that you're using resources appropriate for the work you're doing.

In this article

About machine types

Typically, you can run your codespace on a choice of remote machine types. These machine types offer a choice of hardware specifications ranging from 2 cores to 32 cores, although the full range of machine types may not always be available. Each machine type has a different level of resources and a different billing tier. For information, see "About billing for GitHub Codespaces."

By default the machine type with the lowest valid resources is used when you create a codespace. You can choose an alternative machine type either when you create a codespace or at any time after you've created a codespace.

For information on choosing a machine type when you create a codespace, see "Creating a codespace for a repository."

Unpublished codespaces (codespaces created from a template that are not linked to a repository on GitHub Enterprise Cloud) always run on a virtual machine with the same specifications. You can't change the machine type of an unpublished codespace. For more information, see "Creating a codespace from a template."

Changing the machine type

Note

Your choice of available machine types may be limited by a number of factors. These can include a policy configured for your organization, or a minimum machine type specification for your repository. For more information, see "Restricting access to machine types" and "Setting a minimum specification for codespace machines."

  1. In the top-left corner of GitHub, select , then click Codespaces to take you to the "Your codespaces" page at github.com/codespaces.

    The number of cores, memory, storage capacity, and currently used storage are displayed for each codespace. Some details are omitted if you are using a narrow browser window.

    Screenshot of a list of three codespaces on the https://github.com/codespaces page."

  2. Click the ellipsis (...) to the right of the codespace you want to modify.

  3. Click Change machine type.

    Screenshot of the dropdown menu for a codespace. The "Change machine type" option is highlighted.

  4. If multiple machine types are available for your codespace, choose the type of machine you want to use.

    Screenshot of a dialog showing two available machine types: 2-core and 4-core.

  5. Click Update codespace.

  1. In VS Code, open the Command Palette with Command+Shift+P (Mac) or Ctrl+Shift+P (Windows/Linux).

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

    Screenshot of "change machine" entered as a search string and "Codespaces: Change Machine Type" in the dropdown list.

  3. If you're not following these instructions within a codespace, click the codespace that you want to change.

    Screenshot of a dropdown list of four codespaces.

    If you are following these instructions in a codespace, the change will apply to the codespace you're working in.

  4. Select the machine type you want to use.

  5. If you're changing to a machine type with a different storage capacity, a prompt will appear asking if you would like to continue. Read the prompt and click Yes to accept.

If you have installed GitHub CLI, you can use it to work with GitHub Codespaces. For installation instructions for GitHub CLI, see the GitHub CLI repository.

You can use the gh codespace edit --machine MACHINE-TYPE-NAME GitHub CLI command to change the machine type of a codespace. To use this command, you'll first need to find out the available machine types for your codespace.

  1. To view your list of codespaces, in a terminal, enter the following command.

    gh codespace list

  2. Optionally, to find the current machine type for a codespace, enter the following command.

    gh api /user/codespaces/CODESPACE-NAME

    Replace CODESPACE-NAME with the permanent name of the codespace, for example literate-space-parakeet-w5vg5ww5p793g7g9. The permanent names are listed under the NAME column in the list returned by gh codespace list.

    If you're prompted to request the codespace scope, follow the instructions in the terminal.

    Details for the current machine are listed under the machine field.

  3. To find the available machine types for a codespace, enter the following command.

    gh api /user/codespaces/CODESPACE-NAME/machines

    Replace CODESPACE-NAME with the permanent name of the codespace, for example literate-space-parakeet-w5vg5ww5p793g7g9.

  4. To change the machine type for a codespace, enter the following command.

    gh codespace edit --machine MACHINE-TYPE-NAME

    Replace MACHINE-TYPE-NAME with the name of an available machine type for your codespace, for example standardLinux32gb.

  5. Using the arrow keys, navigate to the codespace you want to change, then press Enter.

If you changed to a virtual machine with a different storage capacity (for example, from 32 GB to 64 GB), your codespace will be unavailable for a short time while the machine type is changed. If the codespace is currently active, it will automatically be stopped. When the change is complete, you'll be able to restart the codespace running on the new machine type.

If you changed to a virtual machine with the same storage capacity, the change will be applied the next time you restart the codespace. An active codespace will not be stopped automatically. For more information on restarting a codespace, see "Stopping and starting a codespace."

Further reading