Getting Started with Pieces for Sublime

Prerequisites

Before you begin, make sure you have:

PiecesOS: The core engine that powers all Pieces extensions. Learn more about PiecesOS.
Sublime Text: Make sure you’ve installed Sublime Text on your development machine.

You must have PiecesOS to use the Pieces for Sublime Plugin. We also recommend downloading the Pieces for Developers Desktop App.

Installing the Pieces for Sublime Text Plugin

Download Package Control: Visit the Package Control installation page and follow the instructions to install Package Control in Sublime Text

Open Command Palette: Use the shortcut ⌘+shift+p (macOS) or ctrl+shift+p (Windows/Linux) to open the command palette
Install Pieces Plugin: Using the command palette, search for Package Control: Install Package, then search for Pieces and select it
Restart Sublime: After installing the Pieces Plugin, restart the Sublime editor to ensure all the dependencies are loaded properly

Setting up PiecesOS

PiecesOS is required for the Pieces for Sublime Text 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.

PiecesOS — macOS (ARM)

macOS 13.0 (Ventura) or higher

PiecesOS — macOS (Intel)

macOS 13.0 (Ventura) or higher

PiecesOS — Windows

Windows 10 (20H0) or higher required

Download — Linux

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 Sublime Text Plugin will automatically update when a new version is available via Package Control.

When the plugin updates, you’ll see a small success message pop-up in the center of your Sublime Text Editor.

Update notifications cover updates for both the Pieces for Sublime Text and PiecesOS.

You can also manually update the plugin by opening your Command window in Sublime Text by using ⌘+shift+p (macOS) or ctrl+shift+p (Windows/Linux), locating the Package Control: Upgrade Package, and clicking the option. This will auto-update the Pieces for Sublime Text Plugin.

Disconnect from 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 in VS Code
Select Pieces: Disconnect from Pieces Cloud

Uninstalling

To uninstall the Pieces for Sublime Text Plugin, open your Command window in Sublime Text by using ⌘+shift+p (macOS) or ctrl+shift+p (Windows/Linux), locating the Package Control: Remove Package, looking for the option Pieces and clicking the option.

In order for Pieces to be completely uninstalled from the Sublime Text, you'll need to restart the IDE.

Get Started