PyCharm is currently in Beta. Gitpod continues to collaborate with JetBrains · Send feedback.

​
Getting started

  1. Install JetBrains Gateway - With the JetBrains Gateway and Gitpod plugin you can create and manage your latest 20 Gitpod workspaces.
  2. Install the Gitpod plugin - Open JetBrains Gateway and you’ll see the Gitpod logo on the main page. Click “install” to install the Gitpod plugin for JetBrains Gateway.
  3. Update your Gitpod preferences - Select PyCharm on the Gitpod preferences page which will set PyCharm as your default IDE for future workspace starts.
  4. Start (or restart) your workspace - Either start a workspace directly from within the JetBrains Gateway via the Gitpod plugin OR open a new workspace directly in Gitpod where on workspace start you will be prompted to open PyCharm for that workspace.
Important: You must restart any started workspaces for your IDE preferences to take effect.

​
Install Plugins

This section relates to plugin management when using JetBrains IDEs in a remote development context. For information on regular plugin management, refer to PyCharm docs.
Unlike with regular development, JetBrains Remote development with PyCharm allows users to install plugins in different locations:
  • PyCharm backend plugins - The JetBrains PyCharm backend runs within the remote Gitpod workspace. Backend plugins contribute functionality for IDE experiences relating to the filesystem, tools or languages and frameworks. When installed, a backend plugin only applies to the currently running Gitpod workspace and is not associated with a user. However, a plugin can be preconfigured for all users of a repository so that the plugin is enabled with every workspace start. It is not currently possible to install a backend plugin that applies to all workspaces of a Gitpod user or organization.
  • JetBrains Client plugins - The JetBrains client runs on the users local machine and can be thought of as the user interface to the remote PyCharm backend. Client plugins are different to backend plugins as they contribute to the user interface aspect of the IDE experience (e.g. keyboard shortcuts and themes). Once installed, a client plugin is enabled for all Gitpod workspaces the user opens (if the workspace is running the exact same version of the PyCharm backend where the plugin was initially installed).
  • JetBrains Gateway plugins - The JetBrains Gateway is an application downloaded onto a users local machine which allows users to start JetBrains Clients that are compatible with the PyCharm backend, running in a Gitpod workspace. JetBrains Gateway plugins are installed directly in JetBrains Gateway and contribute to remote development connection experiences (e.g. the Gitpod JetBrains Gateway plugin).

​
Install on JetBrains Client

The JetBrains client runs on the users local machine and can be thought of as the user interface to the remote PyCharm backend. Client plugins contribute to the user interface aspect of the IDE experience (e.g. keyboard shortcuts and themes). Once installed, a client plugin is enabled for all Gitpod workspaces the user opens (if the workspace is running the exact same version of the PyCharm backend where the plugin was initially installed). To install a plugin on JetBrains Client follow these steps:
  • In JetBrains Client open the IDE settings and select Plugins.
  • Find the plugin in the Marketplace and click Install.

Caption Text

​
Install on PyCharm backend

The JetBrains PyCharm backend runs within the remote Gitpod workspace. Backend plugins contribute functionality requiring access to IDE experiences such as the remote filesystem (e.g. contributing support of languages and frameworks). When installed, a backend plugin only applies to the currently running Gitpod workspace and is not associated with a user. However, a plugin can be preconfigured for all users of a repository so that the plugin is enabled with every workspace start. It is not currently possible to install a backend plugin that applies to all workspaces of a Gitpod user or organization.

​
Install for your current workspace

You can install a plugin only for your current workspace following these steps:
  • In JetBrains Client open the IDE settings and select Plugins On Host.
  • Find the plugin in the Marketplace and click Install.

Install a plugin on PyCharm backend

​
Configure plugins for repository

You can share a plugin on PyCharm backend with everybody working on the repository by adding it to .gitpod.yml and pushing to your Git repository. Each workspace is preconfigured with plugins from the gitpod.yml configuration file. For example:
.gitpod.yml
jetbrains:
    pycharm:
        plugins:
            - zielu.gittoolbox
            - izhangzhihao.rainbow.brackets
To locate the Plugin ID, visit the JetBrains Marketplace website and navigate to the Overview page of the specific plugin you’re interested in. The Plugin ID is usually found at the bottom of this page.

​
Configure custom plugin repositories

If you are using custom repositories, you can directly specify the URL of your custom repository or the identifier of your custom plugin. For example:
.gitpod.yml
jetbrains:
    pycharm:
        plugins:
            - http://my-custom-repository
            - my-custom-plugin
For detailed guidelines on setting up and using custom plugin repositories, please refer to JetBrains’ documentation on custom plugin repositories.

​
Install plugins from a workspace image

Within your Dockerfile for the workspace image, copy the plugin archive (.zip file) to one of the following directories:
  • /home/gitpod/.gitpod/jetbrains/plugins - This location installs plugins to all JetBrains products (IntelliJ IDEA, GoLang, etc).
  • /home/gitpod/.gitpod/jetbrains/pycharm/plugins - This location will install plugins only to the given IDE, e.g. PyCharm.
Note: Before starting the PyCharm backend, Gitpod will read the locations specified above and install plugins.

​
Install plugins per a user

To install plugins solely your user only profile, use the same approach as described in install from a workspace image. However, store your IDE Plugins in .dotfiles instead of the workspace image.

​
Configure JVM options

Gitpod automatically sets the Java maximum memory heap size (-Xmx) based on workspace resources. You can override this default using any options provided below.
You can adjust JVM options for PyCharm backend, especially if you want to increase the -Xmx memory size use .gitpod.yaml or set the env PYCHARM_VMOPTIONS via environment variables. For example:
.gitpod.yml
jetbrains:
    pycharm:
        vmoptions: '-Xmx4g'

PYCHARM_VMOPTIONS=-Xmx4g
For more detailed information on JVM options, refer to Common JVM Options from JetBrains documentation.

​
Configure IDE settings

Feedback needed: The below shows how you can configure global settings with JetBrains. To leave feedback on the approach, please see this GitHub issue: #6576. Also note that JetBrains is working on comprehensive settings sync functionality.
When running PyCharm locally, the JetBrains IDE applies global settings to all projects on your machine. However when running in a remote context using JetBrains Gateway, it’s important to note that some IDE settings are configured on the JetBrains Client and others in the PyCharm backend running in your Gitpod Workspace. See below instructions for more.

​
On JetBrains Client

IDE Settings that are configured on the JetBrains Client are stored on your local machine and don’t have On Host label in the IDE settings. These IDE settings are reused if the workspace is running the exact same version of the PyCharm backend where the settings were initially configured.
Configure IDE settings on JetBrains client

Configure IDE settings on JetBrains client

​
On PyCharm backend

Settings configured on PyCharm backend are stored in a Gitpod workspace and have On Host label in the IDE settings.
Configure IDE settings on JetBrains client

Configure IDE settings on PyCharm backend

​
Configure IDE settings per project

Some IDE settings cannot be configured via environment variables or through setting vm options. These settings can only be set via the UI of JetBrains client, and must be manually copied to be synced between workspaces. The below steps detail how to configure your IDE settings for all the users of a given Gitpod project: Step 1: Manually use JetBrains UI to configure settings - Set your IDE settings as you normally would, using the JetBrains UI. Step 2: Find generated IDE settings - You will need to manually find any global settings generated by JetBrains backend within the following path: /workspace/.config/JetBrains<-latest>/RemoteDev-PY/<your-project-name>/options Step 3: Move any relevant settings manually to a persistent location within your Gitpod project. Either via a Workspace Image, or persisted in the version control of your project, for example by committing settings data to GitHub. Include relevant IDE settings in your Workspace Image
  • /home/gitpod/.gitpod/jetbrains/options - This location applies settings to all JetBrains products (IntelliJ IDEA, GoLang, etc).
  • /home/gitpod/.gitpod/jetbrains/pycharm/options - This location will apply settings only to the given IDE, e.g. PyCharm.
Commit relevant IDE settings to source control
  • /workspace/<your-project-name>/.gitpod/jetbrains/options - This location applies settings to all JetBrains products (IntelliJ IDEA, GoLang, etc).
  • /workspace/<your-project-name>/.gitpod/jetbrains/pycharm/options - This location will apply settings only to the given IDE, e.g. PyCharm.
For any further changes to your IDE settings, you will need to follow the above steps again.
When locating and applying IDE settings, Gitpod will read the locations specified above in priority order. The locations specified first are overriden by the locations specified later.

​
Configure IDE settings per user

To configure IDE settings for your user only, and not all those using a project. Follow the instructions for configuring IDE settings per project, but instead use .dotfiles rather than a workspace image or source control to store your IDE settings.

​
Indexing using Prebuilds

When you open the project PyCharm starts indexing to load modules and enable the core functionality like code completion and navigation. Depending on the size of your project indexing speed can vary significantly. You can speed up the indexing of a project by applying these general recommendations. Gitpod prebuilds allow you to improve it further by indexing before you start a new workspace. To leverage it:
  • configure prebuilds for your repository, refer to Prebuilds;
  • enable indexing for PyCharm in prebuilds by editing .gitpod.yml in your repository:
.gitpod.yml
jetbrains:
    pycharm:
        prebuilds:
            version: stable
  • push changes to your Git repository to apply.
The version property allows you to control whether to index for stable, latest, or both versions of PyCharm compatible with Gitpod. Users can switch between stable and latest versions of PyCharm on the user preferences page.

​
Workspace performance

When using a Gitpod workspace you might experience performance issues caused by:
  • An application using more resources than expected
  • Resource consumption in adjacent containers running on the workspace node.
In your JetBrains IDE within the JetBrains Gateway Backend Control Center you can find two metrics relating to your running workspace: Workspace CPU and Workspace Memory. The remaining metrics you can find in the Backend Control Center regarding the node that your workspace is running on, and not the workspace itself.
Performance information shown in the Backend Control Center is the same as the information that is shown when running the command gp top in your workspace, see the Command Line Interface documentation for more.

jetbrains performance

​
FAQs

  • For the questions about supported IDEs and Editors in Gitpod, refer to FAQs.
  • For the general questions about JetBrains Remote Development, refer to refer to the general IDE PyCharm FAQ.

​
Are there any JetBrains optimizations I can make if my workspace is slow?

Debugging performance can be challenging, as performance issues can depend on many factors such as how Gitpod is configured (if you’re operating Gitpod on Self-Hosted). However, there are some ways you can gather performance information and optimise your JetBrains IDE setup with Gitpod:
  1. Firstly, to gather information on performance, you can view workspace performance metrics from within the IDE in the Backend Control Center, or by using gp top.
  2. You may also want to try adjusting the Max Heap Size allocated to the JetBrains Backend in the Settings tab of the Backend Control Center. If updating this setting helps your performance, you can set the vmoptions value for your JetBrains IDE in your .gitpod.yml.
If the performance metrics show that your workspace is hitting its resource limits, and you are using Gitpod Self-Hosted, it might make sense to consider changing the resource configuration for your workspaces. This can be done via a config-patch. Configuring workspace resources is not yet available on SaaS.

​
Troubleshooting