1
0
mirror of synced 2025-12-19 18:10:59 -05:00
Files
docs/content/codespaces/codespaces-reference/using-the-github-codespaces-plugin-for-jetbrains.md
hubwriter dfab0d1601 Changes from JetBrains PR
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.
2022-10-06 12:48:44 +01:00

3.2 KiB

title, shortTitle, intro, versions, type, topics, product
title shortTitle intro versions type topics product
Using the GitHub Codespaces plugin for JetBrains Plugin for JetBrains You can use the {% data variables.product.prodname_github_codespaces %} plugin to find out about your codespace or stop it when you've finished working.
fpt ghec
* *
reference
Codespaces
{% data reusables.gated-features.codespaces %}

About the {% data variables.product.prodname_github_codespaces %} plugin

The {% data variables.product.prodname_github_codespaces %} plugin is already installed in the JetBrains client when you connect to a codespace from the JetBrains Gateway. The plugin adds the {% data variables.product.prodname_github_codespaces %} tool window to the user interface.

Click {% data variables.product.prodname_github_codespaces %} at the bottom left of the JetBrains client's application window to open the {% data variables.product.prodname_github_codespaces %} tool window.

Screenshot of the {% data variables.product.prodname_github_codespaces %} tool window

Using the {% data variables.product.prodname_github_codespaces %} tool window

The {% data variables.product.prodname_github_codespaces %} tool window shows:

  • The repository from which you created this codespace.
  • The display name of the codespace.
  • The current branch.
  • The machine specifications.
  • The time for which this codespace can remain idle before it is automatically stopped.
  • The age of the codespace.
  • The period for which a stopped codespace will be retained before it is automatically deleted.

The icons at the top of the {% data variables.product.prodname_github_codespaces %} tool window provide the following functions.

  • Refresh active codespace

    Screenshot of the refresh button

    Refresh the details in the {% data variables.product.prodname_github_codespaces %} tool window. For example, if you used {% data variables.product.prodname_cli %} to change the display name, you could click this button to show the new name.

  • Disconnect and stop

    Screenshot of the stop button

    Stop the codespace, stop the backend IDE on the remote machine, and close the local JetBrains client.

  • Manage your codespaces from the web

    Screenshot of the list button

    Open your list of codespaces at https://github.com/codespaces.

  • View the codespace creation log

    Screenshot of the log button

    Open the codespace creation log in the editor window. For more information, see "GitHub Codespaces logs."

  • Rebuild the dev container

    Screenshot of the rebuild button

    Rebuild your codespace to apply changes you've made to the dev container configuration. The JetBrains client will close and you must reopen the codespace. For more information, see "Codespaces lifecycle."