Skip to content

Commit

Permalink
Release 1.8.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@nathan-courtney-pieces
nathan-courtney-pieces committed Nov 16, 2023
1 parent 0106b90 commit f93dcfd
Show file tree
Hide file tree
Showing 4 changed files with 68,281 additions and 45,434 deletions.
153 changes: 107 additions & 46 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,77 +1,130 @@
# Pieces for Developers | Obsidian Plugin
# [Pieces for Developers](https://pieces.app) | 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.
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.

[![Pieces For Developers Banner](./assets/readme/pfd-obisidan-plugin-hero.png)](https://youtu.be/x2JdssFEk2I)

## Getting started
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

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

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.**
**You must have [Pieces OS](https://docs.pieces.app/installation-getting-started/what-am-i-installing) installed**.

\*_The Pieces OS install includes the Pieces for Developers Desktop App where you can also view and manage your
snippets._
Pieces OS facilitates the local operation of Pieces products on your machine and coordinates connections to Pieces extensions. **The extension will not function as intended without Pieces OS active on your machine.**

\*_Pieces OS 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
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
![Pieces Copilot](https://storage.googleapis.com/pieces_multimedia/PROMOTIONAL/PIECES_FOR_DEVELOPERS/OBSIDIAN/MACOS/COPILOT/16X9/PIECES_FOR_DEVELOPERS-OBSIDIAN-COPILOT-MACOS-16X9-7_17_2023.gif)

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

![Save with Right Click](./assets/onboarding/saveWithMenu.png)

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

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

![Manage your Snippets](./assets/readme/gifs/OBSIDIAN_SEARCH.gif)

## Share code from Obsidian without breaking your flow
### 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!

![Share your Snippets](./assets/readme/gifs/OBSIDIAN_SHARE.gif)

## Thoughtfully designed by fellow developers
### 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
Obsidian Plugin
- Keyboard **shortcuts-enabled**

![Save with Button](./assets/readme/gifs/OBSIDIAN_SAVE.gif)

## Discover new snippets
### [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.

Automatically discovers new highly relevant and reusable snippets from your vault for you to save
![Snippet Discovery](./assets/readme/pngs/OBSIDIAN_DISCOVER.png)

## Enrich your code blocks
### [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!

## 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

![Pieces Copilot](https://storage.googleapis.com/pieces_multimedia/PROMOTIONAL/PIECES_FOR_DEVELOPERS/OBSIDIAN/MACOS/COPILOT/16X9/PIECES_FOR_DEVELOPERS-OBSIDIAN-COPILOT-MACOS-16X9-7_17_2023.gif)

### Commands
### [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.

Expand All @@ -82,21 +135,29 @@ _Hotkeys aren't set by default, but here are our recommended layouts._
| 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 | ⬜ |
## Explore the Pieces Ecosystem

Explore our suite of products designed to streamline your coding workflow across different platforms.

![Pieces Product Suite](https://storage.googleapis.com/pieces_multimedia/ILLUSTRATIONS/PIECES_FOR_DEVELOPERS/ANY_INTEGRATION/ANY_THEME/PLUGINS/1X1/PIECES_FOR_DEVELOPERS-ANY_INTEGRATION-PLUGINS-ANY_THEME-1X1-10_16_2023.PNG)

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

Expand All @@ -113,7 +174,7 @@ application, while adhering strictly to the developer policies of Obsidian, nota
- 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.
case of severe issues or policy violations, please also contact the Obsidian team.

[Pieces Privacy Policy](https://docs.pieces.app/privacy-policy)

Expand Down
Loading

0 comments on commit f93dcfd

Please sign in to comment.