Getting started with the Pieces for Visual Studio Code Extension

Prerequisites

Before installation, you'll need:

PiecesOS: The main engine that powers Pieces for VS Code functionality. Learn more about PiecesOS.
VS Code: Visual Studio Code should already be installed on your development machine.

PiecesOS must be installed to enable the Pieces for VS Code Extension. We also recommend the Pieces for Developers Desktop App for enhanced functionality.

Setting Up PiecesOS

To use the Pieces for VS Code Extension, you must install PiecesOS on your operating system.

Follow the specific setup 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.

Installation

Open VS Code and navigate to the Extensions view, then search for Pieces for VS Code and click Install

Alternatively, download the .VSIX installer from the VS Code Marketplace and install it manually.

Restart VS Code after installing the extension to complete the setup
Enable Pieces Tool Windows by going to View, then Tool Windows and enable whichever Pieces Windows that best suit your workflow

Updating

The Pieces for VS Code Extension will automatically update when a new version is available.

The Auto Update setting is enabled by default.

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 Pieces: Disconnect from Pieces Cloud and choose the option

Uninstallation

To uninstall the Pieces for VS Code Extension, press ⌘+shift+x (macOS) or ctrl+shift+x (Windows/Linux) to open the extensions tab, then search for the Pieces for VS Code extension and click Uninstall.

Restart your VS Code IDE after removing the extension to complete the uninstallation process.

Get Started