JetBrains 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.
macOS 13.0 (Ventura) or higher
macOS 13.0 (Ventura) or higher
Windows 10 (20H0) or higher required
Ubuntu 22.04+ required.
Run these commands in order to install and properly set up the Pieces Desktop App and it’s core dependencies:
-
sudo snap install pieces-os -
sudo snap connect pieces-os:process-control :process-control
Then, type pieces-os to launch the application directly from your terminal.
Click here for alternative PiecesOS installation methods, or install the PiecesOS and the Pieces Desktop App together for Windows, macOS, and Linux.
For enhanced security and better system integration, we recommend installing the appinstaller package over the InnoSetup (.exe) installer. The appinstaller 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.
Pieces Cloud
Connecting to the Pieces Cloud is optional. However, it provides additional features like data backups, shareable links, and more. You can enjoy the main functionalities of Pieces without an account.
Disconnecting from the Pieces Cloud logs you out of your Pieces account.
To disconnect from the Pieces Cloud:
Open the Command Palette
Open the command palette in VS Code with ⌘+shift+p (macOS) or ctrl+shift+p (Windows/Linux)
Disconnect from the Cloud
Enter Disconnect from Pieces Cloud and choose the option
If you’re not signed into Pieces Cloud - this option will not be available. You will see Connect to Pieces Cloud.
Uninstalling
To uninstall the Pieces for JetBrains Plugin, go to the Settings icon in the top left, 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.
