Pieces for Obsidian Plugin
The Pieces for Obsidian Plugin is a versatile tool built for seamless integration with the Obsidian Editor.
It enables users to efficiently manage and interact with saved code snippets while leveraging the AI-powered Pieces Copilot's capabilities directly within their coding environment.
- Pieces Copilot: Engage in AI-driven conversations to enhance productivity by generating code, adding comments, troubleshooting, and more—all contextualized to your project by adding files and folders as context, with or without the powerful Long-Term Memory Engine (LTM).
- Snippet Management: Effortlessly save, locate, and share frequently used code snippets, making it easier to organize your work, quickly access important pieces of code, and collaborate effectively with others.
Follow these instructions to download and install the Pieces for Obsidian Plugin.
Explore troubleshooting options, navigate to our support page,or directly book a call with our engineers.
This plugin is designed to deliver two primary pillars of functionality for developers working in the Obsidian environment:
Enhanced AI Assistance
Through Pieces Copilot, developers can engage in context-based AI conversations to generate code solutions, add comments, troubleshoot, and resolve bugs directly within Obsidian.
screenshot of the right-click context menu showcasing pieces options
Integrated Snippet Management
With PiecesOS integrated into Obsidian, developers can save, edit, search, and share their code snippets, enhancing productivity by keeping reusable code easily accessible.
screenshot of a snippet inside of Obsidian
Using Pieces Copilot
The Pieces Copilot offers several powerful actions to enhance your coding workflow using generative AI.
To begin, initiate a conversation with the LLM of your choice, providing as much context as needed by adding files, folders, or even entire repositories to the conversation.
Inside Obsidian, the Pieces Copilot delivers a range of tools to elevate your workflow through the power of generative AI.
To get started, initiate a conversation with the LLM of your choice by adding relevant context, such as files, folders, or even entire repositories, to tailor the interaction.
To discover available actions, highlight a code snippet, right-click, and navigate to the Pieces
options in the context menu.
From there, you’ll find several quick actions, including:
-
Explain Selection with Copilot
: Receive a detailed breakdown of what the code does and how it functions. -
Share Selection with Pieces Link
: Generate a shareable link for the selected snippet, making it easy to collaborate or share code with others. -
Save Selection to Pieces
: Save the selected snippet directly to Pieces, ensuring quick access and easy management for future use.
screenshot of the right-click menu showing the Pieces options
Managing Your Code Snippets
Managing code snippets with Pieces in the Obsidian plugin is straightforward and efficient.
To save a snippet, right-click on the selected section and choose Save to Pieces
. You can also use the Share via Pieces
option to share snippets with others.
Common snippet types include utility functions, API requests, and Markdown templates.
When you save snippets to your repository, Pieces enriches them with AI-generated metadata, such as tags, titles, authorship details, and descriptions, keeping everything organized and accessible.
You can find brief descriptions below of the different material management options available within the Pieces for Obsidian Plugin:
-
Save Current Selection to Pieces
: Right-click a code block and save it to your repository with AI-enriched metadata, ensuring easy access to frequently used snippets. -
Share via Pieces
: Share snippets with your team by creating distributable copies of reusable code. -
Ask Copilot About Your Selection
: Start a conversation with Pieces Copilot to gain insights, explanations, or improvement suggestions for the selected code.
screenshot showing right click options in Obsidian for Pieces
Referencing & Reusing
The Pieces for Obsidian Plugin offers powerful search tools to quickly find and access your saved snippets.
You can perform broad searches or refine results using specific terms like function names, keywords, or tags, making it simple to locate the exact code you need.
To search, open the Pieces for Obsidian Plugin from the left-side menu by clicking the button with the Pieces logo. Then, click on the open-closed curly brackets icon in the new menu.
This opens a search bar where you can input queries to find your snippets. Once located, snippets can be refactored, shared, or copied directly into your project.
Screenshot of the snippets page being open
Download the Plugin
Ready to streamline your development? Download the Pieces for Obsidian Plugin and follow our installation guide to start.