Obsidian Prerequisites
Before installation, you'll need:
-
PiecesOS: The main engine that powers the Pieces for Obsidian Plugin. Learn more about PiecesOS.
-
Obsidian: Obsidian installed on your development machine.
PiecesOS must be installed to enable the Pieces for Obsidian Plugin. We also recommend the Pieces for Developers Desktop App for enhanced functionality.
Installing the Pieces for Obsidian Plugin
Settings
Open Obsidian and navigate to the Settings view
Community Plugins Tab
Locate and navigate to the Community Plugins option
Alternatively, find the Pieces for Obsidian Plugin on the Obsidian Plugin Marketplace and install it manually.
Community Plugins Option
Click Turn on community plugins
Browsing Plugins
Locate and click the Browse button in the Community Plugins section
Search for the Plugin
Click the search bar, then search for Pieces for Developers, and click the Pieces for Developers option
Install the Plugin
Click the Install button—After the plugin installs, click Enable.
Setting Up PiecesOS
To use the Pieces for Obsidian Plugin, you must install PiecesOS on your operating system.
Follow the specific setup 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 .exe installer. The .appinstaller package operates in a containerized environment, providing additional security benefits.
Updating
To update the Pieces for Obsidian plugin will require a few extra steps to update.
Settings
In the bottom left of the editor, select the settings option.
Community Plugins Tab
Locate the tab called Community Plugins and select it.
Current Plugins Section
In the new window, located the section labeled Current Plugins and click the Check for Updates button.
Onboarding
The Pieces for Obsidian plugin includes a walkthrough that guides you through the steps on a single page. This onboarding page will teach you how to save, view, share, and use saved materials, as well as how to make the most of the Pieces for Obsidian plugin.
Save Your First Material
This section will walk you through how to save your first meaningful material, giving you a helpful gif section and a nice walkthrough.
Find and Use your Materials
In this section, you'll learn how to find materials within Pieces and use them in Obsidian. You can also click the Pieces logo at the top right of the application to open Pieces Drive.
Share your Materials
Sharing materials is a key feature of PiecesOS. It lets you share any new or previously saved materials with anyone, anywhere in the world, without the recipient needing an account.
Discover New Materials
Pieces will automatically offer highly relevant and reusable materials directly in Obsidian. This section explains how you can do it yourself. You can also click on the Pieces icon at the top right of your Obsidian editor and select the {} icon to switch to your suggested snippets section.
Enrich your Code Blocks
Pieces also automatically generate tags, titles, descriptions, and links to other similar code snippets or materials with just a simple button press! You can click the Pieces button embedded in your code blocks and then click on the enrich icon to try it out.
More Resources
Pieces works with you to make sure you have the best possible experience. You can find Pieces’ socials at the bottom of the onboarding to connect with us for support or to share any mind-blowing moments you’ve encountered along your journey!
Uninstalling
Settings
In the bottom left of the editor, select the settings option.
Community Plugins Tab
Locate the tab called Community Plugins and select it.
Installed Plugins Section
On the bottom of the Community Plugins window, locate the section called Installed Plugins.
Pieces for Developers Plugin.
Locate the installed Pieces for Developers plugin and click the trash icon to uninstall the plugin
Restart your Obsidian editor after removing the plugin to complete the uninstallation process.