Skip to content

Latest commit

 

History

History
72 lines (45 loc) · 4.93 KB

using-the-vs-code-command-palette-in-codespaces.md

File metadata and controls

72 lines (45 loc) · 4.93 KB
title intro versions type topics shortTitle allowTitleToDifferFromFilename redirect_from
Using the Visual Studio Code Command Palette in GitHub Codespaces
You can use the Command Palette feature of {% data variables.product.prodname_vscode %} to access many commands in {% data variables.product.prodname_github_codespaces %}.
fpt ghec
*
*
reference
Codespaces
Visual Studio Code
VS Code Command Palette
true
/codespaces/codespaces-reference/using-the-command-palette-in-codespaces
/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces

About the {% data variables.product.prodname_vscode_command_palette %}

The {% data variables.product.prodname_vscode_command_palette_shortname %} is one of the focal features of {% data variables.product.prodname_vscode %} and is available for you to use in {% data variables.product.prodname_github_codespaces %}. The Command Palette allows you to access many commands for {% data variables.product.prodname_github_codespaces %} and {% data variables.product.prodname_vscode_shortname %}. For more information on using the {% data variables.product.prodname_vscode_command_palette_shortname %}, see "User Interface" in the {% data variables.product.prodname_vscode_shortname %} documentation.

Accessing the {% data variables.product.prodname_vscode_command_palette_shortname %}

You can access the {% data variables.product.prodname_vscode_command_palette_shortname %} in a number of ways.

  • Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux).

    Note that this command is a reserved keyboard shortcut in Firefox.

  • F1

  • From the Application Menu, click View > Command Palette.

Commands for {% data variables.product.prodname_codespaces %}

To see all commands related to {% data variables.product.prodname_github_codespaces %}, access the {% data variables.product.prodname_vscode_command_palette_shortname %}, then start typing "Codespaces".

Screenshot of the Command Palette with "codespaces" entered. The dropdown lists all commands that relate to {% data variables.product.prodname_github_codespaces %}.

Suspending or stopping a codespace

If you add a new secret or change the machine type, you'll have to stop and restart the codespace for it to apply your changes.

To suspend or stop your codespace's container, access the {% data variables.product.prodname_vscode_command_palette_shortname %}, then start typing "stop". Select Codespaces: Stop Current Codespace.

Screenshot of the Command Palette with the search text "stop" and the option "Codespaces: Stop Current Codespace."

Adding a predefined dev container configuration

To add a predefined dev container configuration, access the {% data variables.product.prodname_vscode_command_palette_shortname %}, then start typing "add dev". Click Codespaces: Add Dev Container Configuration Files.

Screenshot of the Command Palette, with "add dev" entered and "Codespaces: Add Dev Container Configuration Files" listed.

Rebuilding a codespace

If you add a dev container or edit any of the configuration files (devcontainer.json and Dockerfile), you'll have to rebuild your codespace for it to apply your changes.

To rebuild your container, access the {% data variables.product.prodname_vscode_command_palette_shortname %}, then start typing "rebuild". Select Codespaces: Rebuild Container.

Screenshot of the Command Palette with the search text "rebuild" and the option "Codespaces: Rebuild Container."

{% data reusables.codespaces.full-rebuild-tip %}

Codespaces logs

You can use the {% data variables.product.prodname_vscode_command_palette_shortname %} to access the codespace creation logs, or you can use it export all logs.

To retrieve the logs for {% data variables.product.prodname_github_codespaces %}, access the {% data variables.product.prodname_vscode_command_palette_shortname %}, then start typing "export". Select Codespaces: Export Logs to export all logs related to {% data variables.product.prodname_github_codespaces %} or select Codespaces: View Creation Logs to view logs related to the setup.

Screenshot of the Command Palette with the search text "export" and the option "Codespaces: Export Logs."

Further reading