Skip to content

Commit

Permalink
Merge pull request #497 from pieces-app/feat/raycast
Browse files Browse the repository at this point in the history
Feat/raycast
  • Loading branch information
mason-at-pieces authored Aug 7, 2024
2 parents 2426640 + 7e27feb commit a907ad8
Show file tree
Hide file tree
Showing 16 changed files with 6,248 additions and 4,572 deletions.
50 changes: 50 additions & 0 deletions docs/extensions-plugins/raycast/commands.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
title: Pieces for Developers Raycast Extension Commands
description: Learn how to use the Pieces for Developers Raycast Extension commands to streamline your workflow and boost productivity.
---

import Video from "/src/components/Video";

# Commands

Use the following commands to streamline your workflow and boost productivity with the Pieces for Developers Raycast Extension.

## Search Saved Snippets
Quickly search through your saved pieces to find and reuse exactly what you need.

<Video type={'gif'} src={'/assets/raycast/search_snippets.gif'} alt={'Search Snippets'} />

## Save Clipboard History to Pieces
View a list of your clipboard history, enriched with useful metadata. Select an item to save it to Pieces.

<Video type={'gif'} src={'/assets/raycast/save_clipboard_history.gif'} alt={'Clipboard History'} />

## Save Browser History to Pieces
Description: View a list of the code snippets discovered in your recent browsing history. Select an item to save it to Pieces.

<Video type={'gif'} src={'/assets/raycast/save_browser_history.gif'} alt={'Browser History'} />

## Save Clipboard to Pieces
Description: Save the current clipboard content to Pieces with a single command.

<Video type={'gif'} src={'/assets/raycast/save_clipboard.gif'} alt={'Save Clipboard'} />

## Save Finder Selection to Pieces
Select files in Finder and save them directly to Pieces.

<Video type={'gif'} src={'/assets/raycast/save_finder_selection.gif'} alt={'Save Finder Selection'} />

## Save Selection in Frontmost Application to Pieces
Highlight text in any application and save it to Pieces.

<Video type={'gif'} src={'/assets/raycast/save_frontmost_selection.gif'} alt={'Save Frontmost Selection'} />

## Sign into Pieces
Securely log in to your Pieces account directly from Raycast.

<Video type={'gif'} src={'/assets/raycast/sign_in_to_pieces.gif'} alt={'Login'} />

## Signout of Pieces
Easily log out of your Pieces account.

<Video type={'gif'} src={'/assets/raycast/signout.gif'} alt={'Logout'} />
20 changes: 20 additions & 0 deletions docs/extensions-plugins/raycast/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: Pieces for Developers Raycast Extension
description: Understand the benefits and importance of using the Pieces for Developers Raycast Extension, and get started with Quickstart and Commands.
---

import { CardWithCTA } from "/src/components/Card";
import Grid from "/src/components/Grid";

The Pieces for Developers Raycast Extension brings powerful features to your fingertips, allowing you to streamline your workflow and boost productivity.

## Get Started

<Grid cols={2}>
<CardWithCTA title={'Quickstart'} description={'Learn how to set up and start using the Pieces for Developers Raycast Extension'} href={'/extensions-plugins/raycast/quickstart'} />
<CardWithCTA title={'View Commands'} description={'Explore the available commands for the Raycast Extension'} href={'/extensions-plugins/raycast/commands'} />
</Grid>

## Need Help?

If you encounter any issues or have questions, feel free to [reach out to our support team](/support) or consult the [FAQs](/faq).
56 changes: 56 additions & 0 deletions docs/extensions-plugins/raycast/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
title: Pieces for Developers Raycast Extension Quickstart
description: Learn how to set up and start using the Pieces for Developers Raycast Extension.
---

# Quickstart

:::warning

The Pieces for Developers Raycast Extension is currently under review and not yet available in the Raycast Store.

You can follow the progress of the review in this GitHub pull request: [Add Pieces for Developers Raycast Extension](https://github.com/raycast/extensions/pull/13626)

:::

In this tutorial, you'll learn how to set up and start using the Pieces for Developers Raycast Extension. We'll cover the installation process and basic usage to help you get up and running quickly.

## Prerequisites

- [Pieces OS](/installation-getting-started/what-am-i-installing) installed on your machine.
- [Raycast](https://www.raycast.com) installed on your machine.

## Steps

### Step 1: Install the Raycast Extension

:::info

If this is your first time installing an extension, you can follow the [How to Install a Raycast Extension](https://developers.raycast.com/basics/install-an-extension) guide for detailed instructions.

:::

1. Open Raycast
2. Navigate to the Raycast Store
3. Search for "Pieces for Developers"
4. Install the Pieces for Developers Raycast Extension

### Step 2: Use the Raycast Extension

1. Open Raycast
2. Use the command `Search Saved Snippets` to search through your saved code snippets

:::tip

To open the commands in Raycast, use the configurable keyboard shortcut. Refer to the [Raycast Hotkey Manual](https://manual.raycast.com/hotkey) for more details.

:::

Congratulations! You have successfully set up and started using the Pieces for Developers Raycast Extension.

## Next Steps

Now that you've set up the Raycast Extension, you can explore more features and commands to streamline your workflow and boost productivity.

- [Commands](/extensions-plugins/raycast/commands)
- [Raycast Manual](https://manual.raycast.com)
1 change: 1 addition & 0 deletions docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,5 +42,6 @@ Get started with the Pieces for Developers platform and show you how to best use

<Grid cols={3}>
<CardWithoutCTA icon={'/assets/obsidian_logo.png'} title={'Obsidian'} href={'/extensions-plugins/obsidian'} />
<CardWithoutCTA icon={'/assets/raycast_logo.png'} title={'Raycast'} href={'/extensions-plugins/raycast'} />
<CardWithoutCTA icon={'/assets/teams_logo.png'} title={'Microsoft Teams'} href={'/extensions-plugins/teams'} />
</Grid>
Loading

1 comment on commit a907ad8

@vercel
Copy link

@vercel vercel bot commented on a907ad8 Aug 7, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.