jayb1u3 / obsidian-pieces

Pieces' powerful extension for Obsidian-MD that allows users to access their code snippets directly within the Obsidian workspace

Pieces for Developers | Obsidian Plugin

This plugin is closed source. The Obsidian team has full access to our private codebase.

Streamline your coding workflow in Obsidian with the Pieces plugin, offering powerful features for capturing, managing, translating, and enhancing code snippets.

Getting started

To get started, it is required to download Pieces OS* from pieces.app/install.

This enables Pieces products to run locally on your machine and manages connections to Pieces plugins. This plugin will not work properly without Pieces OS installed and running.

*The Pieces OS install includes the Pieces for Developers Desktop App where you can also view and manage your snippets.

Install Instructions

1. Visit the Pieces for Developers Obsidian Plugin install page
2. Click the Install button and then Enable to activate the plugin

Save useful code to your Pieces micro-repo

Templates, terminal commands, useful snippets, notes...save elements of your notes in one-click to reference or re-use later.

Find and re-use just the right snippet when you need it

Blazing fast, powerful search of your code snippets right inside Obsidian.

Share code from Obsidian without breaking your flow

Share snippets with a simple right-click action from within Obsidian. The link ships with both the snippet and its related context - tags, descriptions, where it’s from and more!

Thoughtfully designed by fellow developers

• Runs locally on your machine with the option to connect to the Cloud for backup, sync and sharing
• Deeply embedded into Obsidian - save, search, and share your snippets entirely from the Pieces for Developers Obsidian Plugin
• Keyboard shortcuts-enabled

Discover new snippets

Automatically discovers new highly relevant and reusable snippets from your vault for you to save

Enrich your code blocks

• Automatically generate tags, titles, descriptions, and links to other similar code snippets with the simple press of a button!
• Just click on the 'P' button embedded in your code blocks, and click on the enrich icon!

Hack your brain with the Copilot

• Interact with a Copilot grounded on the contents of your vault

• Select which files you would like to use as context

• Available in both Cloud and Local LLM runtimes (i.e GPT and Llama2)

• Suggested queries automatically generated

• Quickly reach relevant notes

  

Commands

To use a Pieces command, simply highlight code in your editor or hover a snippet in your Pieces List.

Hotkeys aren't set by default, but here are our recommended layouts.

Command	macOS	Windows
Save a snippet	CMD+Shift+P	Ctrl+Shift+P
Share a snippet	CMD+Shift+L	CMD+Shift+L

Other Products from the Pieces Team

Product	Description	Requires Pieces OS
Pieces for Jetbrains	Save & share snippets from around the web with a single-click	✅
Pieces for Chrome	Save & share snippets from around the web with a single-click	✅
Pieces for VS Code	Save, share, & access snippets from within VS Code	✅
Pieces CLI	A command line tool for Pieces to use in your terminal	✅
Code++ for Jetbrains	Copy & Paste Snippets 10x Better with Context from IDEA	⬜
Code++ for Chrome	Enrich code you find online to enable better search and reuse by offering more context and metadata	⬜
Code++ For VS Code	Copy & Paste Snippets 10x Better with Context in your VSCode	⬜
Code++ for Slack	Automatically format, highlight and tag code snippets in any channel in Slack	⬜
CodeFromScreenshot.com	Extract code from a screenshot	⬜
TextFromScreenshot.com	Extract text from a screenshot	⬜
Runtime.dev	Technical Language Processing (TLP) APIs	⬜

Obsidian Community Disclosure

Please note that this repository is hosting a closed-source Obsidian plugin. While the source code is not publicly available, we assure you that the utmost care has been taken to ensure its quality, performance, and respect for user privacy and data security.

The Pieces For Developers Obsidian Plugin is intended to enhance the functionality and user experience of the Obsidian application, while adhering strictly to the developer policies of Obsidian, notably:

• We do not obfuscate our code to hide its purpose.
• We do not insert dynamic ads or static ads outside the Pieces For Developers Obsidian Plugin interface.
• We do not include client-side telemetry.
• We temporarily leverage ChatGPT API endpoints.
• We respect Obsidian's trademark policy.
• For any issues, feature requests, or policy violations, please feel free to open an issue in this repository. In the case of severe issues or policy violations, please also contact the Obsidian team.

Pieces Privacy Policy

To ensure the continued functionality and reliability of the Pieces For Developers Obsidian Plugin, we commit to providing updates and addressing any issues in a timely manner.

Please refer to the included LICENSE file for details on the terms of use for our plugin.

Thank you for your understanding, and we hope you enjoy using the Pieces For Developers Obsidian Plugin.