Get Started

---

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.

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 — Windows

Windows 10 (20H0) or higher required

Click here for alternative PiecesOS installation methods, or install the PiecesOS and the Pieces Desktop App together for Windows, macOS, and Linux.

Installation

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

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

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

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:

Onboarding

The Pieces for VS Code extension includes an interactive walkthrough that shows the different steps in one panel. This onboarding page will teach you how to save, view, and use saved materials, as well as how to fully utilize Pieces for Visual Studio Code.

Save Your First Material

When you click Save Your First Material, Pieces automatically opens the Pieces Drive and stores a sample snippet to show you how everything works.

You’ll see that snippet right away in the Saved Materials list, giving you a quick demonstration of how Pieces captures items and keeps them organized for easy reuse.

View Your Saved Materials

By clicking View Your Saved Materials, Pieces Drive will open up to your Saved Materials—showing you any saved snippets you had before and the newly generated saved snippet.

Check Out the Pieces Copilot

Clicking Open Your Copilot triggers the Pieces Copilot side panel to appear, as shown in the screenshots. In the Pieces Copilot, you’ll find suggested prompts, options to set context from folders or files, and quick links to your saved materials.

Once you open the Copilot, the onboarding step is marked as complete. You're ready to ask questions about your code, document it, or refactor a selected material—all within the VS Code interface.

Ask Copilot with Your Material

When you click Ask Copilot about Your Material, Pieces automatically adds the newly saved snippet to the Copilot chat with a sample prompt (like “What does this code do?”). Press Enter to send your snippet to the Copilot, and you’ll immediately receive an explanation or suggested improvements.

Supercharge Your Workflow

Clicking Pieces Documentation opens our full guide with advanced tips, setup instructions, and best practices. Choosing View All Steps lets you revisit any onboarding step anytime.

Extra resources and helpful videos are on the right side, including community channels and tutorials to help you master Pieces and maintain a smooth development flow.

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.