Get Started
Follow the steps below to install and use the Pieces for JetBrains Plugin.
Prerequisites
Before you begin, make sure you have:
-
PiecesOS: The core engine that powers all Pieces extensions. Learn more about PiecesOS.
-
Any JetBrains IDE: The Pieces for JetBrains Plugin works with any of the official JetBrains IDEs, so make sure you’ve got one installed.
You must have PiecesOS to use the Pieces for JetBrains Plugin. We also recommend downloading the Pieces for Developers Desktop App.
Installing the Pieces for JetBrains Plugin
You can install the Pieces for JetBrains plugin through the JetBrains Marketplace or by searching for Pieces in the plugins search of your IDE.
Once you've installed the plugin, you can begin using Pieces without restarting your IDE.
Setting up PiecesOS
PiecesOS is required for the Pieces for JetBrains Plugin to work.
If you haven’t installed it yet, click the buttons to download PiecesOS via the recommended method, or follow the alternative steps below.
Recommended Installation Method
Click here to download the Pieces Suite Installer for Windows.
Alternative Installation Methods
Or, you can install PiecesOS using these alternative methods—just click the link on the package that’s right for your system.
- WinGet
Paste the following command into your terminal to install the Pieces Suite via WinGet: winget install "Pieces OS"
- Standalone .EXEs
- App Installer
For enhanced security and better system integration, we recommend installing the MSIX package over the InnoSetup (.exe) installer. The MSIX package operates in a containerized environment, providing additional security benefits.
Updating
The Pieces for JetBrains Plugin will automatically update when a new version is available.
When the plugin updates, you’ll see a small success message pop-up in the bottom right-hand corner of your JetBrains IDE.
Update notifications cover updates for both the Pieces for JetBrains Plugin and PiecesOS.
You can also manually update the plugin by going to your Plugins window using locating the Pieces for JetBrains Plugin, and clicking the Update button.
Uninstalling
To uninstall the Pieces for JetBrains Plugin, go to Plugins > Installed, find the Pieces plugin, and click the uninstall button in the dropdown menu.
To access the uninstall option, click the dropdown menu and select the chevron to display the uninstall button.
In order for Pieces to be completely uninstalled from the JetBrains IDE, you'll need to restart your IDE.