Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pieces-app/obsidian-pieces
Pieces' powerful extension for Obsidian-MD that allows users to access their code snippets directly within the Obsidian workspace
https://github.com/pieces-app/obsidian-pieces
ai obsidian-md obsidian-plugin snippets-manager
Last synced: 1 day ago
JSON representation
Pieces' powerful extension for Obsidian-MD that allows users to access their code snippets directly within the Obsidian workspace
- Host: GitHub
- URL: https://github.com/pieces-app/obsidian-pieces
- Owner: pieces-app
- License: mit
- Created: 2023-06-01T22:14:36.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-04T20:41:29.000Z (18 days ago)
- Last Synced: 2024-12-14T08:03:43.137Z (9 days ago)
- Topics: ai, obsidian-md, obsidian-plugin, snippets-manager
- Language: JavaScript
- Homepage: https://docs.pieces.app/extensions-plugins/obsidian
- Size: 69.8 MB
- Stars: 168
- Watchers: 5
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [Pieces for Developers](https://pieces.app) | Obsidian Plugin
> This plugin is closed source. The Obsidian team has full access to our private codebase.
In 2022, our team embarked on a mission to transform the way you code with your personal micro-repo.
With the debut release of our Flagship Desktop App, we laid the foundation, and now our Obsidian plugin is here to revolutionize your coding workflow further by incorporating key capabilities and our users' favorite features directly into their Obsidian environment.
[](https://youtu.be/x2JdssFEk2I)
Pieces Copilot for Obsidian is here to elevate your coding and problem-solving experience. Interact with the Copilot directly in any Obsidian workspace. Ask questions about code or content within a file, gain insights on patterns or keywords in code snippets, request the Copilot to generate samples using an SDK you're exploring, and even use it to navigate through PRs.
As you progress through your workflow, the Pieces for Developers Obsidian plugin enables you to capture, manage, share, and discover code snippets and other developer materials, like code screenshots, with simple clicks.
Designed to be your ultimate development companion, the Pieces Obsidian plugin transforms your workflow, bringing unparalleled efficiency and organization to your coding experience.
## Table of Contents
- [Recent Updates](#recent-updates)
- [Getting Started](#getting-started)
- [Requirements](#requirements)
- [Install Instructions](#install-instructions)
- [Features](#features)
- [Meet Your New Copilot](#meet-your-new-copilot)
- [Save Valuable Code](#save-useful-code-to-your-pieces-micro-repo)
- [Find and Reuse Code Snippets](#find-and-re-use-just-the-right-snippet-when-you-need-it)
- [Share Code from Obsidian](#share-code-from-obsidian-without-breaking-your-flow)
- [Discover New Snippets](#discover-new-snippets)
- [Enrich your code blocks](#enrich-your-code-blocks)
- [Keyboard Shortcuts](#keyboard-shortcuts)
- [Explore the Pieces Ecosystem](#explore-the-pieces-ecosystem)
- [Need Help?](#need-help)
- [Stay Connected](#stay-connected)
- [Obsidian Community Disclosure](#obsidian-community-disclosure)
## Recent Updates
### [v1.8.0 - Persistent Copilot Chats](https://code.pieces.app/updates/persistent-copilot-chats-pieces-vs-code-obsidian)
_Nov. 1, 2023_
- Adds persistent copilot conversations, you can not come back to a copilot chat at any time after you leave it
- Overhauls the context selector to be much simpler and easier to use
- Context is also persisted per conversation, so each conversation will maintain its context indefinitely
- Snippets can now be used as context
### [v1.5.3 - Improved Pieces Copilot Experience](https://code.pieces.app/updates/improved-pieces-copilot-experiences)
_Oct. 3, 2023_
- New Quick Actions feature for easily selecting LLM runtime and file context in a Copilot conversation.
- Theme Matching to align Copilot's appearance with your environment's theme.
- Styling updates including new icons for an enhanced user experience.
### [v1.3.0 - Filter Your Snippet List](https://code.pieces.app/updates/filter-snippet-list-obsidian-jupyterlab)
_Sept. 8, 2023_
- Snippet list filtering based on tags, titles, language, etc., similar to the feature in [Pieces Desktop App](https://docs.pieces.app/installation-getting-started/what-am-i-installing).
- Easy access to filtering options via a filter button and a user-friendly interface for setting up filters.
- Efficient narrowing down of snippet shortlist to find relevant snippets swiftly.
[View all updates](https://code.pieces.app/updates)
## Getting Started
### Requirements
**You must have [PiecesOS](https://docs.pieces.app/installation-getting-started/what-am-i-installing) installed**.
PiecesOS facilitates the local operation of Pieces products on your machine and coordinates connections to Pieces extensions. **The extension will not function as intended without PiecesOS active on your machine.**
\*_PiecesOS installation comes with the Pieces for Developers Desktop App where your snippets can also be viewed and managed._
## Install Instructions
1. Visit the [Pieces for Developers Obsidian Plugin](https://obsidian.md/plugins?id=pieces-for-developers) install page.
2. Click the `Install` button and then `Enable` to activate the plugin.
## Features
### [Meet Your New Copilot](https://docs.pieces.app/features/pieces-copilot)
Your personal copilot, powered by local or cloud-based LLMs (i.e. Llama 2, GPT-3.5, GPT-4, and PaLM 2) for maximum security and privacy, that’s contextualized by your workflow to help solve coding problems, onboard into new projects faster, and connect you with the right people.
### 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](https://docs.pieces.app/product-highlights-and-benefits/in-project-snippet-discovery)
Automatically discovers new highly relevant and reusable snippets from your vault for you to save.
### [Enrich your code blocks](https://docs.pieces.app/features/auto-enrichment)
- 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!
### [Keyboard Shortcuts](https://docs.pieces.app/features/keyboard-shortcuts)
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 |
## Explore the Pieces Ecosystem
Explore our suite of products designed to streamline your coding workflow across different platforms.
For detailed descriptions and features of our Obsidian plugin, visit our [docs for Obsidian](https://docs.pieces.app/extensions-plugins/obsidian).
## Need Help?
Encountered a hurdle? We've got you covered. Reach out for support:
- **[Support Form](https://getpieces.typeform.com/to/mCjBSIjF)**
- **[Join our Discord Community](https://discord.gg/getpieces)**
## Stay Connected
Stay in the loop! Follow us for the latest updates, tips, and insights:
- **[Twitter / X](https://twitter.com/getpieces)**
- **[YouTube](https://youtube.com/@getpieces)**
- **[Facebook](https://facebook.com/getpieces)**
- **[LinkedIn](https://linkedin.com/company/getpieces)**
## 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](https://docs.pieces.app/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.