Install plugins

Plugins extend the core functionality of PyCharm. For example, install plugins to get the following features:

Integration with version control systems, issue trackers, build management servers, and other tools.
Coding assistance support for various languages and frameworks.
Shortcut hints, live previews, File Watchers, and so on.
Coding exercises that can help you to learn a new programming language.

Open plugin settings

Press Ctrl+Alt+S to open settings and then select Plugins.

Use the Marketplace tab to browse and install plugins from JetBrains Marketplace or from a custom plugin repository.

Use the Installed tab to browse bundled and installed plugins, enable, disable, update, or remove them. Disabling unnecessary plugins can increase performance.

Most plugins can be used with any JetBrains product. Some are limited only to commercial products, others require a separate license.

If a plugin depends on some other plugin, you can find a list of the dependencies in the Additional Info tab. If your project depends on certain plugins, add them to the list of required plugins.

By default, PyCharm includes several bundled plugins. You can disable bundled plugins, but they cannot be removed. Also, you can install additional plugins from the plugin repository or from a local archive file (ZIP or JAR) .

Install a plugin from Marketplace

Press Ctrl+Alt+S to open settings and then select Plugins.
Click the Marketplace tab and type the plugin name in the search field.
To install the plugin, click Install and restart PyCharm.

To install a specific version, go to the plugin page in JetBrains Marketplace, download and install it as described in Install plugin from disk. For example, you can do it if the most recent version of the plugin is broken.

Install plugin from disk

Download the plugin archive (ZIP or JAR).
Press Ctrl+Alt+S to open settings and then select Plugins.
On the Plugins page, click and then click Install Plugin from Disk.
Select the plugin archive file and click OK.
Click OK to apply the changes and restart the IDE if prompted.

Install plugin from command line

Quit the IDE on which you want to install the plugin.
In JetBrains Marketplace, find a page of the plugin that you want to install, scroll down to the Additional Information section, and copy the value from the Plugin ID parameter, for example, com.intellij.grazie.pro.
Install the plugin:
Navigate to the bin directory under your PyCharm installation directory and run the following command:
pycharm64.exe installPlugins <PluginID>
For example:
pycharm64.exe installPlugins com.intellij.grazie.pro
Run the following command:
open -na "PyCharm.app" --args installPlugins <PluginID>
For example:
open -na "PyCharm.app" --args installPlugins com.intellij.grazie.pro
Navigate to the bin directory under your PyCharm installation directory and run the following command:
pycharm.sh installPlugins <PluginID>
For example:
pycharm.sh installPlugins com.intellij.grazie.pro
If you are using the Toolbox App, you can run this command using the shell script generated by Toolbox App. You can find the script name and location in Toolbox App, in the IDE settings. For more information, refer to Shell scripts generated by the Toolbox App.

For more information, refer to Install plugins from the command line.

Remove plugin

Press Ctrl+Alt+S to open settings and then select Plugins.
Open the Installed tab and find the plugin that you want to remove.
Expand the Disable list and select Uninstall.

Update plugin

Press Ctrl+Alt+S to open settings and then select Plugins.
If a new version of an installed plugin is available, the Update button appears in the plugin settings. Click it to update the plugin.

To configure whether your IDE should check for updates and update plugins automatically, open Settings Ctrl+Alt+S and go to Appearance & Behavior | System Settings | Updates. On this page, you can also click Check for Updates to manually check your plugin repository for available plugin updates.

For more information about the IDE and plugin updates, refer to Update PyCharm.

Disable plugin

You can disable a plugin without removing it if you do not need the corresponding functionality.

Press Ctrl+Alt+S to open settings and then select Plugins.
Open the Installed tab, find and select the plugin that you want to disable.
On the plugin's description pane, click Disable.
Alternatively, you can use the checkboxes in the list of plugins or the Disable all buttons for plugin categories.

You can disable or enable all manually installed plugins at once (non-bundled) in the menu under .

Required plugins

A project may require plugins that provide support for certain technologies or frameworks. You can add such plugins to the list of required plugins for the current project, so that PyCharm will verify that the plugins are installed and enabled. It will notify you if you forget about some plugin, or someone on your team is not aware about the dependency as they work on the project.

Add a required plugin for your current project

Press Ctrl+Alt+S to open settings and then select Build, Execution, Deployment | Required Plugins.
On the Required Plugins page, click and select the plugin. Optionally, specify the minimum and maximum version of the plugin.

The list of required plugins is stored in the .idea/externalDependencies.xml file of your project. When you open the project in PyCharm, it will notify you if the required plugin is disabled, not installed, or requires an update.

Click the link in the notification message to quickly enable, install, or update the required plugin.

Suggested plugins

When you open a project, PyCharm can suggest installing and enabling plugins based on libraries used in your project. Do not confuse suggested plugins with required plugins that you can manually add to a project so that your teammates also use it.

If you don't need a particular plugin, you can prevent PyCharm from suggesting it. You can also use your notification settings to disable or enable notifications of all plugin suggestions and the way they are displayed.

Disable suggestions of a plugin

When a notification of a suggested plugin appears, click Don't suggest again.

Next time when you open a project, PyCharm will not suggest this plugin.

Check a project for suggested plugins

You can check your project for suggested plugins except for plugins for which you have disabled suggestions.

Press Ctrl+Shift+A and start typing Check Suggested Plugins.
Select the Check Suggested Plugins action.
If PyCharm has a plugin applicable to your project, you'll see the notification message. Click the link in the notification message to install or enable the suggested plugin.

Alternatively, you can open the IDE settings (Ctrl+Alt+S) and go to Plugins | Marketplace: If there are plugins suggested for your project, they will be displayed on top of the plugin list, in the Suggested section.

Custom plugin repositories

By default, PyCharm is configured to use plugins from JetBrains Marketplace. This is a public repository where everyone can host their plugins. However, if you develop plugins for internal use only, you can set up a custom plugin repository for them.

For more information about setting up a custom plugin repository, see the IntelliJ Platform SDK documentation.

Once you set up your plugin repository, add it to PyCharm:

Add custom repositories

Press Ctrl+Alt+S to open settings and then select Plugins.
On the Plugins page, click and select Manage Plugin Repositories.
In the Custom Plugin Repositories dialog, click and specify your repository URL. It must point to the location of the XML file that describes your plugin, for example, updatePlugins.xml. The file can be on the same server as your custom plugins, or on a dedicated one.
Click OK in the Custom Plugin Repositories dialog to save the list of plugin repositories.
Click OK in the Settings dialog to apply the changes.

When you search for plugins, PyCharm will show you results both from default JetBrains Marketplace and any custom repositories that you specify. To browse only a certain custom plugin repository, type repository: followed by the URL of the repository in the search field on the Marketplace tab of the Plugins page. For example:

repository:http://plugins.example.com:8080/updatePlugins.xml myPlugin

Alternatively, you can add your custom plugin repositories using the idea.plugin.hosts property:

Go to Help | Edit Custom Properties.
Add the idea.plugin.hosts property to the platform properties file and specify the URL of the XML file that describes your plugin. For example:
idea.plugin.hosts="http://plugins.example.com:8080/updatePlugins.xml"
To add multiple URLs, separate them with semicolons ;.
Restart PyCharm.

You may want to replace default JetBrains Marketplace with your custom plugin repository. This can be helpful if you want only your custom repository plugins to be available from PyCharm.

Replace the default plugin repository

Go to Help | Edit Custom Properties.
Add the idea.plugins.host property to the platform properties file and specify the URL of the application that can properly handle requests from PyCharm, that is, act as the default plugin repository application instead of JetBrains Marketplace.
In particular, it should handle the following requests:
- Get the list of plugins
- Download the latest plugin update
Restart PyCharm.

If you replace the default plugin repository, the search field on the Marketplace tab of the Plugins dialog will browse only the plugins in the new default repository and any custom repositories that you add.

Productivity tips

Filter and sort search results

Type a forward slash / in the search string to see options for filtering and sorting search results. For example, you can add the following options to your search string to list only language-related plugins and sort them alphabetically by name:
/tag:Languages /sortBy:name
Or you can search for all outdated plugins among the installed ones by typing:
/outdated

Last modified: 11 October 2024