dfab0d1601
These are the changes in the pre-review version of PR: https://github.com/github/docs-internal/pull/29794 This version of the Codespaces docs forms the base for the Universe megabranch.
6.5 KiB
title, shortTitle, intro, product, versions, type, topics, redirect_from
| title | shortTitle | intro | product | versions | type | topics | redirect_from | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Troubleshooting GitHub Codespaces clients | Codespaces clients | This article provides troubleshooting information for issues you may encounter with the client you use for {% data variables.product.prodname_github_codespaces %}. | {% data reusables.gated-features.codespaces %} |
|
reference |
|
|
{% webui %}
Troubleshooting the {% data variables.product.prodname_vscode %} web client
If you encounter issues using {% data variables.product.prodname_github_codespaces %} in a browser that is not Chromium-based, try switching to a Chromium-based browser, such as Google Chrome or Microsoft Edge. Alternatively, check for known issues with your browser in the microsoft/vscode repository by searching for issues labeled with the name of your browser, such as firefox or safari.
If you encounter issues using {% data variables.product.prodname_github_codespaces %} in a Chromium-based browser, you can check if you're experiencing another known issue with {% data variables.product.prodname_vscode_shortname %} in the microsoft/vscode repository.
Differences from working in {% data variables.product.prodname_vscode_shortname %} locally
When you open a codespace in your browser, using the {% data variables.product.prodname_vscode_shortname %} web client, you will notice some differences from working in a local workspace in the {% data variables.product.prodname_vscode_shortname %} desktop application. For example, some key bindings will be different or missing, and some extensions may behave differently. For a summary, see: "Known limitations and adaptions" in the {% data variables.product.prodname_vscode_shortname %} docs.
You can check for known issues and log new issues with the {% data variables.product.prodname_vscode_shortname %} experience in the microsoft/vscode repository.
{% data variables.product.prodname_vscode %} Insiders
{% data variables.product.prodname_vscode %} Insiders is the most frequent release of {% data variables.product.prodname_vscode_shortname %}. It has all the latest features and bug fixes, but may also occasionally contain new issues that result in a broken build.
If you are using an Insiders build and notice broken behavior, we recommend switching to {% data variables.product.prodname_vscode %} Stable and trying again.
Click {% octicon "gear" aria-label="The manage icon" %} in the bottom left of the editor and select Switch to Stable Version.... If the {% data variables.product.prodname_vscode_shortname %} web client doesn't load, or the {% octicon "gear" aria-label="The manage icon" %} icon isn't available, you can force switching to {% data variables.product.prodname_vscode %} Stable by appending ?vscodeChannel=stable to your codespace URL and loading the codespace at that URL.
If the problem isn't fixed in {% data variables.product.prodname_vscode %} Stable, check for known issues and, if required, log a new issue with the {% data variables.product.prodname_vscode_shortname %} experience, in the microsoft/vscode repository.
{% endwebui %}
{% vscode %}
{% data variables.product.prodname_vscode_shortname %} troubleshooting
When you open a codespace in the {% data variables.product.prodname_vscode_shortname %} desktop application, you may notice a few differences compared with working in a local workspace, but the experience should be similar.
If you encounter problems, you can check for known issues and log new issues with the {% data variables.product.prodname_vscode_shortname %} experience in the microsoft/vscode repository.
{% data variables.product.prodname_vscode %} Insiders
{% data variables.product.prodname_vscode %} Insiders is the most frequent release of {% data variables.product.prodname_vscode_shortname %}. It has all the latest features and bug fixes, but may also occasionally contain new issues that result in a broken build.
If you are using an Insiders build and notice broken behavior, we recommend switching to {% data variables.product.prodname_vscode %} Stable and trying again.
To switch to {% data variables.product.prodname_vscode %} Stable, close the {% data variables.product.prodname_vscode %} Insiders application, open the {% data variables.product.prodname_vscode %} Stable application, and re-open your codespace.
If the problem isn't fixed in {% data variables.product.prodname_vscode %} Stable, check for known issues and, if required, log a new issue with the {% data variables.product.prodname_vscode_shortname %} experience, in the microsoft/vscode repository.
{% endvscode %}
{% jetbrains %}
Troubleshooting JetBrains IDEs
Performance issues
If the performance you are experiencing using a codespace in JetBrains feels a little sluggish, you may need to increase the maximum Java heap size.
-
Click Localhost at the left of the navigation bar, at the top of the application window.
-
In the Performance tab, note the CPU Load and Memory details. These will indicate whether the machine is overloaded.
-
Click the Settings tab and edit the heap size, increasing it to no more than 60% of the available memory for your codespace.
-
Click Save and restart.
JetBrains IDE issues
For help with issues specific to the JetBrains IDE you are using, or the JetBrains Gateway application, see "Product Support" on the JetBrains website.
{% endjetbrains %}