Get Started

Follow the steps below to install and use the Pieces for VS 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 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.

Installing the Pieces for VS Code Extension

  1. 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.

  1. Restart VS Code after installing the extension to complete the setup

  2. Enable Pieces Tool Windows by going to View, then Tool Windows and enable whichever Pieces Windows that best suit your workflow

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:

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.

  1. WinGet

Paste the following command into your terminal to install the Pieces Suite via WinGet: winget install "Pieces OS"

  1. Standalone .EXEs
  1. 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 VS Code Extension will automatically update when a new version is available.

The Auto Update setting is enabled by default.

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:

  1. Open the command palette in VS Code

  2. Click Pieces: Disconnect from Pieces Cloud

Uninstalling

To uninstall the Pieces for VS Code Extension, follow these steps:

  1. Press ⌘+shift+x (macOS) or ctrl+shift+x (Windows/Linux)

  2. Open the extensions tab, then search for Pieces for VS Code and click Uninstall

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

Updated on
Visual Studio Code Extension
Pieces Copilot