diff --git a/public/content/_deprecated/extensions-plugins/sublime.md b/public/content/_deprecated/extensions-plugins/sublime.md new file mode 100644 index 0000000..1576750 --- /dev/null +++ b/public/content/_deprecated/extensions-plugins/sublime.md @@ -0,0 +1,100 @@ +--- +title: Sublime Text Plugin +path: /extensions-plugins/sublime +visibility: PUBLIC +status: PUBLISHED +description: Discover the Pieces for Sublime Text Plugin and bring the power of Pieces to your favorite +metaTitle: Using the Pieces for Sublime Text Plugin | Pieces Docs +metaDescription: Enhance Pieces with the Sublime Text Plugin. Save, manage, and reuse code snippets seamlessly for faster development. +ogImage: "https://storage.googleapis.com/hashnode_product_documentation_assets/og_images/plugins_extensions/sublime.png" +_deprecated: true +_deprecated_note: Not in nav. Use the MCP docs and CLI docs for current integration options. +--- + + + +*** + + + We're phasing out individual plugin docs. Use the [MCP docs](/products/mcp/get-started) and [CLI docs](/products/cli) for current integration options. + + +*** + +## Pieces for Sublime Text Plugin + +The Pieces for Sublime Text Plugin is a powerful tool that integrates directly into the Sublime Text editor. It allows users to manage saved code snippets and access [Pieces Copilot](/products/extensions-plugins/sublime/copilot) features. + +* [Pieces Copilot:](/products/extensions-plugins/sublime/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. + +* [Pieces Drive](/products/extensions-plugins/sublime/drive): Effortlessly save, locate, and share frequently used code snippets to the Pieces Drive—making it easier to organize your work, quickly access important pieces of code, and collaborate effectively with others. + + + + [Follow these instructions](/products/extensions-plugins/sublime/get-started) to download and install the Pieces for Sublime Text Plugin. + + + + Explore [troubleshooting options,](/products/extensions-plugins/sublime/troubleshooting) navigate to our [support page,](/products/support) or directly book a call with our engineers. + + + +The Pieces for Sublime Text plugin offers developers **two main pillars of functionality**: + +1. **Pieces Copilot**: Offers [AI-assisted features](/products/extensions-plugins/sublime/copilot) like contextualized generative AI conversations, adding code comments, and troubleshooting code + + + +2. **Pieces Drive**: Enables you to [save, edit, search, and share useful code](/products/extensions-plugins/sublime/drive) snippets to boost your workflow productivity and streamline collaboration with others + + + +## Using the Pieces Copilot + +Inside your Sublime Text Editor, Pieces Copilot enables you to perform **various actions**, such as initiating a conversation directly within the editor using your preferred LLM about a specific code snippet, fragment, or folder. + +To start, you can [initiate a conversation with the LLM of your choice](/products/extensions-plugins/sublime/copilot/chat), providing as much context as needed by adding files, folders, or even entire repositories to the conversation. + +To explore available options, simply select a portion of your code, right-click, and hover over the `Pieces` item in the context menu. From here, you’ll find several quick actions, including: + +* `Explain`: Get detailed explanations of the code’s functionality. + +* `Quick Actions`: Gives 3 options to fix a bug in your code, modify the selected code, or add comments to the selection. + +- `Ask Copilot`: Gives you 2 options to ask the copilot about the selected code or to explain the selected code to you. + + + +## Using Pieces Drive + +Users can save snippets by right-clicking the selected code and choosing the `Save to Pieces` option, edit saved materials with a simple command, and share snippets via generated shareable links. + +Commonly saved snippets include **utility functions, database queries, and API request templates**—these are frequently reused, so saving them streamlines development and keeps reusable code easily accessible. + +Common materials types include utility functions, API requests, and reusable code blocks. + +When a snippet is saved, the plugin also automatically generates and associates meta data, like **tags, commit messages, code types, smart descriptions,** as well as **code authors and related resources.** + + + +### Referencing & Reusing + +There are 3 ways to [search through your saved snippets](/products/extensions-plugins/sublime/drive/search-reuse) in the Pieces for Sublime Text Plugin: + +* `Fuzzy Search`: Quickly find snippets even if your search term doesn’t match the saved text exactly. This is useful for locating snippets with slight variations in names or typos. + +* `Full-Text Search`: Searches through the entire content of your saved snippets. Ideal for when you remember part of the snippet but not the exact title or tags. + +* `Neural Code Search`: Uses AI to understand the context of your query, making it possible to find snippets even when your search term is related *conceptually* rather than *textually*. This is useful for complex searches where exact matches aren’t obvious. + +These options allow you to search with vague queries or get specific when you know exactly what you’re looking for, so you can find and reuse your snippets. + +Once you’ve located a snippet using one of the search methods, you can then refactor the code to your needs, share the code with other developers, or paste it directly into your code. + + + +*** + +## Download the Plugin + +Ready to streamline your development? Download the Pieces for Sublime Text Plugin and follow our [installation guide to start.](/products/extensions-plugins/sublime/get-started) \ No newline at end of file diff --git a/public/content/_deprecated/extensions-plugins/sublime/commands.md b/public/content/_deprecated/extensions-plugins/sublime/commands.md new file mode 100644 index 0000000..6b830eb --- /dev/null +++ b/public/content/_deprecated/extensions-plugins/sublime/commands.md @@ -0,0 +1,61 @@ +--- +title: Pieces for Sublime Text Plugin Commands +path: /extensions-plugins/sublime/commands +visibility: PUBLIC +status: PUBLISHED +metaTitle: "Using Pieces for Sublime: Essential Commands & Shortcuts" +metaDescription: Explore the full list of available commands in the Pieces for Sublime Text Plugin for improved workflow efficiency. +description: Below is a table containing every command available to use in the Pieces for Sublime Text Plugin. +--- + + + +## Shortcut Table + +There are a number of actions related to the [Pieces Copilot](/products/extensions-plugins/sublime/copilot) and [Pieces Drive management ecosystem](/products/extensions-plugins/sublime/drive) that are accessible with shortcuts. + +*** + +| [Pieces: Ask About The Current Project](/products/extensions-plugins/sublime/copilot/chat#pieces-ask-about-the-current-project) | `⌘+shift+i` | `ctrl+shift+i` | +| ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------- | ------------------ | +| [Pieces: Search](/products/extensions-plugins/sublime/drive/search-reuse) | `⌘+⌥+shift+s` | `ctrl+alt+shift+s` | +| [Pieces: Copilot](/products/extensions-plugins/sublime/copilot) | `⌘+⌥+shift+o` | `ctrl+alt+shift+o` | +| [Fix a bug](/products/extensions-plugins/sublime/copilot/debugging-errors) | `⌘+⌥+shift+f` | `ctrl+alt+shift+f` | +| [Modify](/products/extensions-plugins/sublime/copilot/refactoring) | `⌘+⌥+shift+m` | `ctrl+alt+shift+m` | +| [Add Code Comments](/products/extensions-plugins/sublime/copilot/documenting-code) | `⌘+⌥+shift+c` | `ctrl+alt+shift+c` | + +*** + +## Command Table + +You can easily access these commands through the **Command Palette** using the shortcuts—`⌘+shift+p` (macOS) and `ctrl+shift+p` (Windows/Linux). + +Simply type `Pieces:` followed by the desired command to filter and locate it in the list. + +*** + +| **Pieces: About** | View plugin details and PiecesOS version. | +| ----------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | +| **Pieces: Copilot** | Create conversations, view past ones, or ask questions. | +| **Pieces: Login** | Opens the PiecesOS login page in your browser. | +| **Pieces: Search** | Perform neural, full-text, or fuzzy search. | +| **Pieces: Change LLM** | Allows you to change the LLM to any LLM supported by PiecesOS. | +| **Pieces: Get Support** | Access support options: file issues, join Discord, or visit the support site. | +| **Pieces: Launch Onboarding** | Opens the onboarding file post-installation. | +| **Pieces: Reload Plugin** | Reloads the plugin for troubleshooting. | +| **Pieces: Delete Copilot Chat** | Deletes the current Pieces Copilot chat. | +| **Pieces: Install PiecesOS** | If PiecesOS is not found on your local machine, this command will take you the route of installing it. | +| **Pieces: Open Pieces Drive** | Opens materials found withing Pieces Drive. | +| **Pieces: Enable Long-Term Memory** | Enables the LTM-2.7 allowing you to actively capture what’s happening on your computer to grant the Copilot better answering. | +| **Pieces: Pause Long-Term Memory** | Completely disables Long-Term Memory LTM-2.7. | +| **Pieces: Connect Personal Cloud** | Connect to your Pieces cloud account. | +| **Pieces: Disconnect Personal Cloud** | Disconnect from your Pieces cloud account. | +| **Pieces: Export Pieces Material** | Export a saved snippet via dropdown selection. | +| **Pieces: Import Sublime Snippet** | Import Sublime snippets into Pieces materials. | +| **Pieces: Open PiecesOS** | Launches PiecesOS (required for the plugin). | +| **Pieces: Open Pieces Settings** | Configure settings, LLM models, and snippet autocomplete. | +| **Pieces: Open Saved Material** | Browse and manage saved snippets with metadata and editing tools. | +| **Pieces: Ask About The Current File** | Ask questions about the file you're working on. | +| **Pieces: Ask About The Current Project** | Inquire about your project files for better insights. | + +*** \ No newline at end of file diff --git a/public/content/_deprecated/extensions-plugins/sublime/configuration.md b/public/content/_deprecated/extensions-plugins/sublime/configuration.md new file mode 100644 index 0000000..dc3187c --- /dev/null +++ b/public/content/_deprecated/extensions-plugins/sublime/configuration.md @@ -0,0 +1,85 @@ +--- +title: Configuration +path: /extensions-plugins/sublime/configuration +visibility: PUBLIC +status: PUBLISHED +description: Read the guide below to configure the Pieces for Sublime Text Plugin to work efficiently in your workflow and adapt to your preferences. +metaTitle: How to Configure the Pieces for Sublime Extension +metaDescription: Configure Pieces for Sublime Text to match your coding preferences and workflow requirements. +--- + +## Supported LLMs + +We constantly update and configure our plugins and extensions, like the Pieces for Sublime Text Plugin, to [work with the latest LLMs.](/products/large-language-models) + +## Opening Pieces Settings + +To open Pieces settings inside of the Pieces for Sublime Text Plugin, you can use `⌘+shift+p` (macOS) or `ctrl+shift+p` (Windows/Linux) to open the command palette. + +Then, enter `Pieces: Open Pieces Settings`. + + + +## Login / Logout + +Use the `Pieces: Login` or `Pieces: Logout` command in your command palette to log in and out of your Pieces account. + + + +*** + +## Configurable Settings + +The Pieces for Sublime Text Plugin offers customizable settings to tailor your experience. These options let you configure the connection, language model, startup behavior, and code autocompletion. Here's an overview of the key settings: + +*** + +| `host` | Specifies the address where the plugin should connect to a local service or server. | +| ---------------------- | -------------------------------------------------------------------------------------------------- | +| `model` | Determines which large language model to use for all Pieces Pilot functionality. | +| `syntax` | Let’s you adjust your language extension. | +| `auto_start_pieces_os` | Lets you decide whether or not to open PiecesOS automatically on startup. | +| `Copilot` | Allows you to choose whether to open the Copilot in the browser or IDE. | +| `auto_check_updates` | Gives you the ability to enable or disable PiecesOS from auto updating. | +| `snippet.autocomplete` | Decide whether or not to enable auto-completion of code via suggest snippets from your repository. | + +*** + +To change settings, you need to copy and paste the contents of the default settings file into the empty window on the right side, which you can find below: + +```json +{ + "model":"gpt-4o", // Deprecated use "Pieces: Change LLM" instead + "auto_start_pieces_os":true, // Open PiecesOS automatically on startup + "snippet.autocomplete":false, // auto complete via Pieces saved snippets or not + "syntax" : {}, // Langauge extension : syntax path + "copilot" : "IDE", // IDE, BROWSER + // Opens the copilot either in browser or in the sublime IDE it self + "auto_check_updates": true // Check if Pieces for Sublime plugin has an update on startup + // Turn this off if Package Control is working fine +} +``` + +### Pieces Auto-Launch on Startup + +You can choose whether or not PiecesOS starts immediately on the launch of the Sublime text editor by setting the parameters to `true` or `false.` + +### Snippet Auto-Complete + +Similarly, adjust the parameters to `true` or `false` to enable auto-completion of code via snippets to speed up your coding progress. + +If you have Pieces snippets saved that are relevant to the code you're writing, you'll get automatic completion for that specific language. + +### Reloading the Plugin + +To reload the plugin, enter the command palette with `⌘+shift+p` (macOS) or `ctrl+shift+p` (Windows/Linux) and type `Pieces: Reload Plugin`. + +For additional support resources, [check out our troubleshooting guide.](/products/extensions-plugins/sublime/troubleshooting) + +## Saving Your Settings + +Once you've copied the contents of the .JSON object and edited them to your preferences, simply save the file, reload the plugin, and restart Sublime for your changes to take effect. + + + You can save the .JSON file with `⌘+s` (macOS) or `ctrl+s` (Windows / Linux). You do not need to use **Save As,** as the file is already existing and this is simply updating the settings file, which comes with the Pieces for Sublime Text package. + \ No newline at end of file diff --git a/public/content/_deprecated/extensions-plugins/sublime/copilot.md b/public/content/_deprecated/extensions-plugins/sublime/copilot.md new file mode 100644 index 0000000..8425a08 --- /dev/null +++ b/public/content/_deprecated/extensions-plugins/sublime/copilot.md @@ -0,0 +1,111 @@ +--- +title: Pieces Copilot +path: /extensions-plugins/sublime/copilot +visibility: PUBLIC +status: PUBLISHED +description: Designed to be more than a code assistant, Copilot boosts productivity by helping you debug, ask coding questions, generate code, and insert comments—all within Sublime. +metaTitle: Using Pieces Copilot in Sublime | Pieces Docs +metaDescription: Use Pieces Copilot in Sublime Text for AI-assisted coding, debugging, and code completion. +--- + +## Generative AI Conversations + +If you're unsure how to implement a specific feature or stuck on a bug, you can [ask the Pieces Copilot coding-related questions](/products/extensions-plugins/sublime/copilot/chat) directly in Sublime. It will provide context-aware responses to help you move forward. + +The Pieces for Sublime Text plugin provides various conversation features, all fully integrated with Pieces. You can activate the **Long Term Memory Engine (LTM-2.7)** for detailed, seamless context across your entire workflow, or start a limited context conversation in the text editor's side view. + + + +## Adding Conversation Context + +Contextual awareness enables the Pieces Copilot to provide solutions that are directly relevant to the challenges you're facing and your code. + + + +Start by right-clicking an active file in Sublime Text and click `Pieces: Add to Copilot Context`. + +Within the Pieces Copilot active chat, you can also add multiple types of context by clicking the `message icon`. After doing so a new menu will pop up asking what you’d like to add as context. + + + +## Pieces Copilot Tools + +Explore powerful AI-driven tools and features with the Pieces for Sublime Text Plugin. + +### Documenting Code + +Keeping well-documented code is an often overlooked aspect of programming, but it’s *very* important—that’s why the Pieces Copilot in Sublime Text lets you [use AI to generate intelligent and context-aware code comments.](/products/extensions-plugins/sublime/copilot/documenting-code) + +To add documentation and comments to code, select the code snippet—no matter the length—then right click, hover over `Pieces`, then hover over `Quick Actions`, and finally click on `Add Code Comments`. + + + +This opens a pop-up near the selected code with an option to `Accept` or `Reject` the changes that contain the newly generated comments. + +### Enhanced Debugging Tools + +The [Code Debugging feature in the Pieces for Sublime Text Plugin](/products/extensions-plugins/sublime/copilot/debugging-errors) assists developers in identifying and resolving errors within their code and is accessible with just a few clicks. + +This feature identifies issues and suggests fixes, making debugging easier. It's great for improving code quality and saving troubleshooting time. + +To quickly debug your code with Pieces, select the code snippet you're having trouble with, right-click, hover over `Pieces`, then hover over `Quick Actions`, select `Fix a Bug`, and enter your query. + + + +This opens a pop-up near the selected code with an option to Accept or Reject the changes that contain the fixes for the broken segment of code. + +### Generate & Update Code + +The Pieces Copilot can [generate code snippets based on your specifications](/products/extensions-plugins/sublime/copilot/refactoring). + +With the Pieces for Sublime Text Plugin, you can enhance your workflow with two powerful Pieces Copilot commands: + +* `Modify`: [Edit or transform the selected code snippet to improve readability](/products/extensions-plugins/sublime/copilot/refactoring), optimize performance, or adapt it for specific needs. + +* `Explain`: Get a clear explanation of what the selected code does, making it easier to understand and document. + +It helps update existing code by offering improved or refactored versions, optimizing processes, adding updates, and automating repetitive tasks based on your current code context. + + + +## Selecting Your Pieces Copilot Runtime + +You can change which [LLM is utilized by Pieces Copilot](/products/extensions-plugins/sublime/copilot/llm-settings) in the Pieces for Sublime Text Plugin by running the command `Pieces: Change LLM`. + +Options include lightweight models for simple queries, advanced models for in-depth analysis, and both **local** and **cloud-based LLMs**. + +This flexibility lets you customize the Pieces Copilot experience to suit your specific development needs, whether prioritizing speed or accuracy. + + + +## Pieces Copilot As a Daily Driver + +The Pieces Copilot is a powerful, adaptable tool that grows with you as you use it—*so use it!* + +*** + + + + Generate detailed comments and documentation for better team collaboration and also reduce onboarding times, creating a unified coding style across teams. + + + + Use the Pieces Copilot in Sublime Text to streamline the bug-fixing process. Its contextual understanding and suggested solutions make troubleshooting faster, keeping your project on course. + + + + Generate initial implementations and boilerplate code for prototypes and fast-paced projects. Ideal for hackathons, PoCs, and other time-sensitive tasks. + + + + Pieces Copilot doubles as a learning tool, helping you explore best practices, new paradigms, and advanced techniques in real-time. + + + + Optimize your codebase through intelligent refactoring recommendations. The Pieces Copilot analyzes your code patterns suggests structural improvements and delivers optimizations for both performance and readability. + + + +*** + +Download the Pieces for Sublime Text Plugin today! \ No newline at end of file diff --git a/public/content/_deprecated/extensions-plugins/sublime/copilot/chat.md b/public/content/_deprecated/extensions-plugins/sublime/copilot/chat.md new file mode 100644 index 0000000..39ec708 --- /dev/null +++ b/public/content/_deprecated/extensions-plugins/sublime/copilot/chat.md @@ -0,0 +1,169 @@ +--- +title: Generative AI Conversations +path: /extensions-plugins/sublime/copilot/chat +visibility: PUBLIC +status: PUBLISHED +description: The Pieces for Sublime Text Plugin provides versatile tools for leveraging generative AI to gain insights, debug, and optimize code seamlessly within your editor. +metaTitle: Chatting with AI in Sublime using Pieces Copilot | Pieces Docs +metaDescription: Interact with Pieces Copilot in Sublime Text for AI-driven coding insights and automated development assistance. +--- + +## Accessing Copilot Chats in Sublime Text + +There are two primary ways to access Generative AI Conversations with the Pieces Copilot. + +### via Right-Click Menu + + + + Highlight any code segment and right-click to open the Tool Menu. + + + + Choose `Start Conversation About The Current Selection` to open a new conversation. + + + + + +### via Command Palette + +Open the command palette with `⌘+shift+p` (macOS) or `ctrl+shift+p` (Windows/Linux), and enter commands such as: + +* `Pieces: Copilot`: Opens a clean-slate chat with Pieces Copilot. + +* `Pieces: Ask Copilot About Active File`: Provides insights for the current file open in your Sublime Text editor. + +- `Pieces: Ask About The Current Project`: Offers context-aware assistance across your entire project. + + + +Read more about [what commands are available in the Pieces for Sublime Text Plugin.](/products/extensions-plugins/sublime/commands) + +## Contextualized Chats + +There are 3 levels of contextual awareness you can use when starting a conversation or adding code to an existing Copilot Chat with the Pieces Copilot. + +### Pieces: Start Conversation About The Current Selection + +One of the easiest ways to ask the Pieces Copilot a question about a specific class, method, function, or script is to open the right-click menu, hover over the Ask Copilot section, and select the `About Current Selection` option. + +To use this feature: + + + + Right click on a selected portion of code. + + + + Hover over the `Ask Copilot` section. + + + + Select the `About Current Selection` option. + + + + Once selected, you can enter your prompt in the text input field at the bottom of the Sublime Text's view and press enter. + + + + + +This feature makes it incredibly convenient for users to get quick insights or answers to specific questions about their code. + +### Pieces: Ask About The Current File + +The `Pieces: Ask About The Current File` feature focuses on providing insights and assistance with the specific file you're working on. + +To use this feature: + + + + Open up the command palette using `⌘+shift+p` (macOS) or `ctrl+shift+p` (Windows/Linux). + + + + Enter `Pieces: Ask About The Current File`, then enter your question into the input field. + + + + + +After running the initial command, you can then query the LLM, which will use the file as context to generate accurate and useful responses. + + + This is ideal for users who need a comprehensive understanding of a file, such as its dependencies, functions, and classes + + +### Pieces: Ask About The Current Project + +Similar to the file-level command, the `Pieces: Ask About The Current Project` command lets developers understand every corner of an entire project. + +To ask about the current project: + + + + Open the command palette with `⌘+shift+p` (macOS) or `ctrl+shift+p` (Windows/Linux). + + + + Enter `Pieces: Ask About The Current Project`, then type in your question. + + + + + +This feature highlights errors and suggests improvements on a larger scale. Its main benefit is helping developers navigate their codebase by using the Pieces context-awareness engine to provide accurate information, even for specific prompts. + +## Adding Context to Copilot Chats + +There are a number of individual items you can add as context to a chat, namely **Files, Folders,** and **Snippets**. + +This flexibility is useful when reference materials aren't directly accessible from Sublime Text or when you want to **compartmentalize context** by keeping files or folders from other projects separate from your active workflow. + +To do this: + + + + You can select the **Message Icon** on the left side of any of your chats in the Copilot Chat window. + + + + A new menu will appear. Choose the type of context you want to add, then select the item you wish to include in the Copilot chat. + + + + + +## Improving Code Consistency & Standardization + +The Pieces Copilot helps improve code quality by identifying inconsistencies and providing actionable suggestions for standardization. + +### Naming Inconsistencies + +If functions across your workspace use inconsistent naming patterns (e.g., `authenticateUser` in `authHandler.go` vs. `retrieveUserProfile` in `userHandler.go`), Pieces Copilot can suggest adopting a standardized naming convention for better readability and maintainability, like this: + +```c +// authHandler.go +func authenticateUser(ctx context.Context, credentials Credentials) (User, error) { + if credentials.Username == "" || credentials.Password == "" { + return User{}, errors.New("missing credentials") + } +} +``` + +### Inconsistent Error Handling + +If error-handling strategies differ across files (e.g., structured errors in `authService.go` vs. inconsistent handling in `userService.go`), Pieces Copilot can help unify the approach: + +```c +// authService.go +func LoginUser(credentials Credentials) (string, error) { + token, err := authenticate(credentials) + if err != nil { + return "", fmt.Errorf("login failed: %w", err) + } + return token, nil +} +``` \ No newline at end of file diff --git a/public/content/_deprecated/extensions-plugins/sublime/copilot/debugging-errors.md b/public/content/_deprecated/extensions-plugins/sublime/copilot/debugging-errors.md new file mode 100644 index 0000000..9a8d40f --- /dev/null +++ b/public/content/_deprecated/extensions-plugins/sublime/copilot/debugging-errors.md @@ -0,0 +1,45 @@ +--- +title: Debugging Errors +path: /extensions-plugins/sublime/copilot/debugging-errors +visibility: PUBLIC +status: PUBLISHED +description: The Pieces Copilot in the Pieces for Sublime Text plugin offers AI-powered debugging to quickly identify and fix code issues in Sublime Text, speeding up troubleshooting and providing learning opportunities. +metaTitle: Debugging Code with AI in Sublime using Pieces Copilot +metaDescription: Fix coding errors efficiently with Pieces Copilot’s AI-driven debugging inside Sublime Text. +--- + +## Using the Debugging Tool + +Quickly identify and resolve issues in your code with the `Fix A Bug` option from Pieces Copilot. + +To use the debugging tool: + + + + Select a portion of problematic code and right-click to open the context menu. + + + + Hover over `Pieces`, then hover over `Ask Copilot`. + + + + Lastly, select `Fix A Bug` from the menu. + + + + + +The debugging function within the [Pieces Copilot uses the code's context](/products/extensions-plugins/sublime/copilot/chat#pieces-ask-about-the-current-file) and semantics to find and rectify issues. + + + +If you face a specific error during code compilation, paste the error code into the **text input field** at the bottom of Sublime for detailed help, and Pieces Copilot will analyze it using the active LLM, open a Copilot Chat with suggestions, regenerate the code, and offer to insert it at the cursor with new comments. + +## Why Debug with Pieces Copilot? + +Debugging with Pieces Copilot streamlines error resolution by providing AI-driven insights in a seamless experience that integrates naturally into your Sublime Text workflow. + +It saves time by eliminating the need to scour the web or sift through lengthy documentation, ensuring your workflow remains focused and distraction-free. + +Moreover, every suggested fix comes with a clear explanation, helping you not only resolve issues but also enhance your coding skills along the way. \ No newline at end of file diff --git a/public/content/_deprecated/extensions-plugins/sublime/copilot/documenting-code.md b/public/content/_deprecated/extensions-plugins/sublime/copilot/documenting-code.md new file mode 100644 index 0000000..bb90929 --- /dev/null +++ b/public/content/_deprecated/extensions-plugins/sublime/copilot/documenting-code.md @@ -0,0 +1,49 @@ +--- +title: Documenting Code +path: /extensions-plugins/sublime/copilot/documenting-code +visibility: PUBLIC +status: PUBLISHED +description: With the Pieces Copilot in the Pieces for Sublime Text Plugin, you can easily generate comments that capture your code's functionality and intent. +metaTitle: Documenting Code Comments with Pieces Copilot in Sublime +metaDescription: Generate intelligent code comments in Sublime Text using Pieces Copilot for enhanced documentation. +--- + +## Commenting Code Selections with Pieces Copilot + +Pieces Copilot can review and **comment on selected code**, offering line-by-line explanations for better readability and understanding. + +### via Right-Click Menu + +To add comments to your code: + + + + Select a portion of the code you’d like to comment. + + + + Right click on your selection code portion and hover over `Quick Actions`. + + + + Select `Add Code Comments` from the tertiary menu. + + + + + +Pieces Copilot will then create clear, relevant comments for the selected code, allowing you to choose to `Accept` or `Reject` the suggested comments. + +This feature is especially helpful for keeping your code easy to read and ensuring your codebase is well-documented. + + + +## Why Use Code Comments? + +Code comments are essential for **keeping a clean and well-documented codebase.** + +They **provide context**, allowing reviewers to focus on functionality while **making complex logic clear**, ensuring the code is easier to follow and maintain. + +Good documentation improves code readability and speeds up onboarding for newcomers to the codebase. This dual benefit supports both **current and future development**, creating a strong **foundation for upgrades and changes.** + +That's what makes this feature so valuable. Need a few hundred lines of code documented? No problem—just use `Add Code Comments`. \ No newline at end of file diff --git a/public/content/_deprecated/extensions-plugins/sublime/copilot/llm-settings.md b/public/content/_deprecated/extensions-plugins/sublime/copilot/llm-settings.md new file mode 100644 index 0000000..b4bda52 --- /dev/null +++ b/public/content/_deprecated/extensions-plugins/sublime/copilot/llm-settings.md @@ -0,0 +1,27 @@ +--- +title: Switching LLMs +path: /extensions-plugins/sublime/copilot/llm-settings +visibility: PUBLIC +status: PUBLISHED +description: The Pieces for Sublime Text Plugin currently supports 16 different LLM models (which includes both cloud-based and local models). +metaTitle: How to Switch LLMs in Pieces Copilot for Sublime +metaDescription: Learn how to switch LLMs in Pieces for Sublime Text to customize AI-powered coding assistance. +--- + +## Switching LLMs + +The Pieces for VS Code Extension currently supports [a wide range of different LLMs](/products/large-language-models), including both cloud-hosted and local models. + +## How To Configure Your LLM Runtime + +Switching the LLM model in the Pieces for Sublime Text Plugin is straightforward, allowing you to choose the model that best fits your needs. + +To get started, use the hotkey `⌘+shift+p` (macOS) or `ctrl+shift+p` (Windows / Linux) and enter `Pieces: Change LLM`. + +This will open the LLM selection menu, where you’ll see all of the available LLMs you can choose from. + + + + + Check out our configuration page for [details on other adjustable settings](/products/extensions-plugins/sublime/configuration) + \ No newline at end of file diff --git a/public/content/_deprecated/extensions-plugins/sublime/copilot/refactoring.md b/public/content/_deprecated/extensions-plugins/sublime/copilot/refactoring.md new file mode 100644 index 0000000..4499b4c --- /dev/null +++ b/public/content/_deprecated/extensions-plugins/sublime/copilot/refactoring.md @@ -0,0 +1,61 @@ +--- +title: Refactoring Code +path: /extensions-plugins/sublime/copilot/refactoring +visibility: PUBLIC +status: PUBLISHED +description: Refactoring improves code structure and maintainability without changing its behavior. The Pieces for Sublime Text Plugin simplifies this with Pieces Copilot’s Modify feature. +metaTitle: Refactoring Code in Sublime Using Pieces Copilot +metaDescription: Refactor and optimize your code in Sublime Text with the Pieces Copilot Modify Selection feature. +--- + +## Modifying Your Code with Pieces Copilot + +The **Modify** function in Pieces Copilot allows you to enhance your selected code by making adjustments such as improving error handling, renaming functions, or adding new functionality. + +In Sublime Text, you can modify your code via the following steps: + +### via Right-Click Menu + +Say you want to add a missing positional argument to the `add_user` function. + +Simply follow these step below and Pieces Copilot will efficiently apply the necessary changes. + + + + Select the portion of code you want to modify. + + + + Right-click to open the context menu. + + + + Hover over `Quick Actions` and select the `Modify` option. + + + + Enter the query containing specific modification instructions. In this case, we want to add the aforementioned argument to the `add_user` function, so we’ll specify that. + + + +Then, press `return` (macOS) or `enter` (Windows/Linux), then accept or deny the changes once the Pieces Copilot has generated the modifications accordingly. + + + +### Use Cases + +Pieces Copilot’s **Modify** feature can handle a variety of refactoring scenarios. Here are some everyday tasks where it can help: + +* **Renaming Variables or Functions Across Multiple Files:** Instead of manually searching for occurrences, just instruct Pieces Copilot to rename them. It updates references automatically, reducing the chance of a missed or broken link. + +* **Updating a Deprecated API Call:** Legacy code often uses outdated methods. Instruct Pieces Copilot to replace the old API call with the new one and handle any necessary parameter or return-value changes. + +* **Adding Error Handling to a Function:** If you have a function without proper error handling, ask Pieces Copilot to wrap it in a try/catch block, or add more robust error-logging statements. + +* **Reorganizing Code for Better Readability:** Large functions with multiple responsibilities can be split into smaller helper functions, or code blocks can be reordered for clarity. Pieces Copilot can assist by identifying logical sections and extracting them into new functions. + +* **Converting Code Syntax:** Use “Modify” to transform class components into functional components (in React), convert promise chains into async/await, or update ES5 syntax to ES6+. + + + Try using the `Modify` function to implement error handling, update deprecated methods, add logging to several functions, or refactor variable names for consistency. + \ No newline at end of file diff --git a/public/content/_deprecated/extensions-plugins/sublime/drive.md b/public/content/_deprecated/extensions-plugins/sublime/drive.md new file mode 100644 index 0000000..0d0550e --- /dev/null +++ b/public/content/_deprecated/extensions-plugins/sublime/drive.md @@ -0,0 +1,197 @@ +--- +title: Pieces Drive +path: /extensions-plugins/sublime/drive +visibility: PUBLIC +status: PUBLISHED +description: The Pieces for Sublime Text Plugin enhances your workflow with features like saving and reusing snippets, ensuring easy access to important code. +metaTitle: Using Pieces Drive for Sublime | Pieces Docs +metaDescription: Sync and access code snippets in Sublime with Pieces Drive. Boost productivity with seamless cloud integration +--- + +## Using Pieces Drive in Sublime Text + +The Pieces for Sublime Text Plugin enhances your development workflow with powerful features like [saving](/products/extensions-plugins/sublime/drive/save-snippets) and [reusing](/products/extensions-plugins/sublime/drive/search-reuse) snippets, ensuring your most critical code is always accessible. + +## Use Cases & Examples + +Let’s take a look at some examples: + +*** + +| `Logging Utilities` | A helper function for detailed server-side logging with timestamps and error levels. | Speeds up debugging and monitoring by inserting reliable logging methods. | +| ---------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| `Validation Functions` | A function to validate JSON payloads or form inputs before submission. | Ensures data integrity with reusable, thoroughly tested validation logic. | +| `API Integration Code` | Prewritten `axios` code for making GET or POST requests, complete with error handling and response parsing. | Reduces repetitive work when integrating RESTful APIs or GraphQL endpoints. | +| `Component Templates` | A React functional component template with basic hooks and styling setup. | Provides a consistent starting point for building new components. | +| `Database Queries` | A MongoDB query to retrieve active user data filtered by last login. | Streamlines database tasks by reusing optimized query patterns. | + +*** + +## Boosting Productivity with Snippet Management + +The Pieces for Sublime Text Plugin connects you with your development environment, so you can focus on what matters—building great software—while empowering you with tools for efficient code reuse. + +* **Improved Productivity:** Focus on solving new problems rather than resolving old ones. + +* **Contextual Awareness:** Snippets enriched with metadata, descriptions, and links to relevant searches help you remember the origin, purpose, and ideal usage scenarios for each piece of code. + +* **Code Standardization:** Sharing best practices and reusable components helps developers ensure uniform coding practices and conventions are available across different teams and projects. + +By using the Pieces for Sublime Text Plugin, you can capture and manage these snippets to streamline daily tasks and enhance your workflow in several ways: + +### Save & Organize + +Users can save snippets by highlighting the desired code, right-clicking, and selecting the `Save to Pieces` option. + +This will open a new Sublime Text tab with your new snippet. Additionally, [each snippet is enriched with context](/products/extensions-plugins/sublime/drive/save-snippets#whats-stored-when-you-save-a-snippet), allowing you to insert well-documented, relevant snippets where they fit best in your projects. + + + +This ensures that important pieces of code, like code fragments, functions, configuration files, and command-line instructions, are always available when you need them. + + + +### Search & Reuse + +You can directly [search through your collection of saved materials](/products/extensions-plugins/sublime/drive/search-reuse) from within Sublime Text, allowing you to quickly find snippets by keyword or context. + +To search you can open the command palette with `⌘+shift+p` (macOS) or `ctrl+shift+p` (Windows/Linux), enter `Pieces: Search`, and select the algorithm that suits your search case best. + + + +These intelligent search options ensure that you can find the exact snippet you need, even if you don't remember the exact details. They also prevent you from wasting time rewriting or searching for the same solutions across projects. + +### Edit & Update + +With a few keystrokes, you can [open saved snippets from your local repository and make edits](/products/extensions-plugins/sublime/drive/edit-update) to keep your code evergreen and improve your most important pieces of code. + +You can open your saved materials by opening the command palette with `⌘+shift+p` (macOS) or `ctrl+shift+p` (Windows/Linux), enter `Pieces: Open Saved Material`, and search or select for the snippet you’d like to edit. + +After selecting, the snippet will open up in a new page, where you can select `Edit` and make your necessary edits to the snippet. + + + +Regularly revisiting your snippets ensures that your code evolves with your projects, adapting to new requirements and improvements.  + +### Sharing + +Is your teammate struggling to find important boilerplate code? Are they contacting you on vacation, urgently needing the shell script that keeps server #1 running? + +This is where sharing snippets comes into play—this feature lets you [share your code with team members](/products/extensions-plugins/sublime/drive/sharing), even if they don’t use Pieces. + + + This can be done without the recipient needing a Pieces Account. + + +Sharing useful code snippets can remove productivity barriers, especially when a co-developer is new to the project or a junior team member. + +For example, a teammate managing server monitoring could use your shared script to automate daily tasks easily, saving time and effort without needing extra setup. + +These shared links also include their [original enriched metadata](/products/extensions-plugins/sublime/drive/save-snippets#whats-stored-when-you-save-a-snippet), such as tags, descriptions, and other details. + +To share a snippet in Sublime Text, highlight the code, right-click, hover over `Pieces`, click `Generate Shareable Link`, and then use the pop-up to `copy` or `dismiss` the link for easy sharing with teammates. + + + +## Use Cases + +With Pieces for Sublime Text Plugin, your snippets become a robust library of reusable code that you can organize, search, edit, and share across projects. + +Here are some examples of how you can use them: + +### Reusable Scheduling Functions + +Imagine yourself regularly tackling projects that require scheduling tasks to run at specific intervals. + +Instead of rewriting the same logic for each new project, you can [save an evergreen snippet to your Pieces repository](/products/extensions-plugins/sublime/drive/save-snippets#saving-snippets). + +This allows you to reuse a well-crafted scheduling function across multiple applications that’s useful in a variety of scenarios: + +```go +package main + +import ( + "fmt" + "time" +) + +// A reusable function to schedule tasks at a specified interval +func scheduleTask(interval time.Duration, task func()) { + ticker := time.NewTicker(interval) + defer ticker.Stop() + + for { + select { + case <-ticker.C: + task() + } + } +} +``` + +### File System Monitoring + +If you frequently work on projects that involve monitoring file system changes, you can save a helpful snippet to your Pieces repository that does exactly that, using generic and reusable naming conventions: + +```go +package main + +import ( + "fmt" + "log" + "github.com/fsnotify/fsnotify" +) + +// A reusable function to monitor file system changes +func watchFileChanges(path string) { + watcher, err := fsnotify.NewWatcher() + if err != nil { + log.Fatal(err) + } + defer watcher.Close() + + err = watcher.Add(path) + if err != nil { + log.Fatal(err) + } + + for { + select { + case event := <-watcher.Events: + if event.Op&fsnotify.Write == fsnotify.Write { + fmt.Println("Modified file:", event.Name) + } + case err := <-watcher.Errors: + fmt.Println("Error:", err) + } + } +} +``` + +## Additional Snippet Scenarios + +Read up on some additional scenarios and use cases for Pieces Snippets and see how the Pieces for Sublime Text Plugin could benefit you and your workflow. + +*** + + + + Streamline testing by saving snippets for your frequently used testing functions [or unit test templates.](/products/extensions-plugins/sublime/drive/save-snippets#saving-snippets) + + + + [Save command-line instructions as snippets](/products/extensions-plugins/sublime/drive/save-snippets#saving-snippets) to quickly retrieve deployment commands, Docker setups, and other essential terminal operations. + + + + You can also save common logging functions or error-handling snippets that can be reused across applications, promoting consistent error management. + + + + Import saved setup scripts, configuration files, and commonly used dependencies to speed up project setup and ensure consistency across new projects. + + + +*** + +Download the Pieces for Sublime Text Plugin today! \ No newline at end of file diff --git a/public/content/_deprecated/extensions-plugins/sublime/drive/edit-update.md b/public/content/_deprecated/extensions-plugins/sublime/drive/edit-update.md new file mode 100644 index 0000000..0b93aec --- /dev/null +++ b/public/content/_deprecated/extensions-plugins/sublime/drive/edit-update.md @@ -0,0 +1,53 @@ +--- +title: Edit & Update +path: /extensions-plugins/sublime/drive/edit-update +visibility: PUBLIC +status: PUBLISHED +description: Editing snippets and saving your changes is simple with the Pieces for Sublime Text Plugin. +metaTitle: How to Modify & Manage Code Snippets in Sublime with Pieces Drive +metaDescription: Edit and update saved snippets in Sublime Text using Pieces Drive’s intuitive editing features. +--- + +## Editing + +Maintaining an up-to-date library of code snippets in the Pieces for Sublime Text Plugin is made easy through seamless editing. + +## How to Edit Snippets + +To modify an existing snippet, follow these steps: + + + + Open the command palette using `⌘+shift+p` (macOS) or `ctrl+shift+p` (Windows/Linux) + + + + In the text field, type `Pieces: Open Saved Materials` + + + + Search for your asset, or choose it drop the available assets listed in the dropdown + + + + Left-click or press enter to select and open that snippet + + + + Switch to the **Editor Mode** by clicking the `Edit` button on your saved snippet + + + + Modify the content of the snippet as needed and save your changes with the `⌘+s` (macOS) or `ctrl+s` (Windows/Linux) + + + + + +Once you make your changes, saving your snippet will close the editing view and bring you back to the saved snippet's main tab. + +## Actions from the Editing View + +When editing a snippet, you can use all [Pieces Copilot](/products/extensions-plugins/sublime/copilot) features, like adding comments, starting conversations, and fixing bugs, allowing you to share it with a coworker, get feedback, and then refine the snippet by adding comments and adjusting parameters or error handling. + + \ No newline at end of file diff --git a/public/content/_deprecated/extensions-plugins/sublime/drive/save-snippets.md b/public/content/_deprecated/extensions-plugins/sublime/drive/save-snippets.md new file mode 100644 index 0000000..a9ff582 --- /dev/null +++ b/public/content/_deprecated/extensions-plugins/sublime/drive/save-snippets.md @@ -0,0 +1,79 @@ +--- +title: Saving +path: /extensions-plugins/sublime/drive/save-snippets +visibility: PUBLIC +status: PUBLISHED +description: The Pieces for Sublime Text Plugin lets users save code snippets directly from the editor, so that their snippets are securely stored and ready to be reused at a later date. +metaTitle: How to Save Code Snippets in Sublime with Pieces Drive +metaDescription: Save and organize important code snippets in Sublime Text using Pieces Drive for easy access. +--- + +## Saving Materials to Pieces Drive + +There are two ways to save code with the Pieces for Sublime Text Plugin—through the right-click menu, or by saving with hotkeys. + +You can use this feature to save all kinds of useful code materials, like: + +* API endpoint definitions + +* Utility functions or commonly used helper methods + +* Code templates for starting new modules + +* Reusable logic for error handling or authentication + +## How to Save Materials + +There is one way to save code within the Pieces for Sublime Text Plugin—through the right click menu. + +### via Right-Click Menu + +To capture useful code snippets, simply: + + + + Highlight the code within your editor + + + + Right click the selection of code you chose + + + + Hover on `Pieces` and then select `Save to Pieces` + + + + + +## What’s Stored When You Save a Snippet + +When you save a snippet to your Pieces Cloud, it’s more than just the code that gets stored. + +The Pieces Copilot captures: + +* `Type`: Categorizes the snippet (e.g., API call, function, class) with it’s code language. + +* `Associated Tags`: Keywords associated with the snippet for easier searching. + +* `Custom Description`: Specifies precisely which *lines* (in numerical form) the snippet is from, as well as the file from which it originated—very useful for mind-mapping. + +* `Smart Description`: AI-generated descriptions that summarize the snippet’s purpose and function. + +* `Suggested Searches`: Related searches that help you discover similar snippets. + +* `Related Links`: References to documentation, code repositories, or other relevant resources. + +* `Related People`: Associated collaborators or contributors. + + + +Additionally, the Pieces Copilot **scans saved snippets for sensitive information**, such as API keys, passwords, or authentication tokens, to ensure no confidential data is accidentally stored. + +## Where Saved Snippets Live + +Saved snippets are stored locally on your device, ensuring accessibility even when offline. This also means that any Pieces extension or plugin—or even the Pieces Desktop App—has constant, up-to-date access to your saved materials. + +You can search your saved snippets with the `Pieces: Search` feature. + +[Read more about how to find your saved snippets here.](/products/extensions-plugins/sublime/drive/search-reuse#finding-saved-snippets) \ No newline at end of file diff --git a/public/content/_deprecated/extensions-plugins/sublime/drive/search-reuse.md b/public/content/_deprecated/extensions-plugins/sublime/drive/search-reuse.md new file mode 100644 index 0000000..eab5b8d --- /dev/null +++ b/public/content/_deprecated/extensions-plugins/sublime/drive/search-reuse.md @@ -0,0 +1,77 @@ +--- +title: Searching +path: /extensions-plugins/sublime/drive/search-reuse +visibility: PUBLIC +status: PUBLISHED +description: You can find your saved code easily with the Pieces for Sublime Text Plugin by utilizing a few different search methods. +metaTitle: How to Search & Retrieve Code Snippets in Sublime with Pieces Drive +metaDescription: Quickly find and reuse saved snippets in Sublime Text with Pieces Drive’s powerful search tools. +--- + +## Locate Materials in Pieces Drive + +One of the most powerful tools baked into the Pieces for Sublime Text Plugin is the search functionality which allows you to utilize **three different searching methods.** + +To get started open the command palette using `⌘+shift+p` (macOS) or `ctrl+shift+p` (Windows/Linux) and type `Pieces: Search`. You’ll be presented with the options to use Neural, Fuzzy, and Full Text code searching. + +### via Fuzzy Search + +Fuzzy Search helps find relevant matches even with typos, misspellings, or variations. + +It’s great for locating partially-remembered function names, error messages, log entries, or comments, saving time with flexible, quick searches. + + + +### via Full Text Search + +Full Text Search finds documents or records with an exact word match. + +It indexes all words for fast searching, ideal for specific queries like function declarations, pulling up matching snippets and related classes efficiently. + + + +### via Neural Code Search + +Neural Code Search uses machine learning to find code snippets based on natural language descriptions. + +It captures context and semantics, delivering accurate results, especially helpful for new developers or complex queries. + + + +## Viewing and Reusing Saved Snippets + +[Saved snippets](/products/extensions-plugins/sublime/drive/save-snippets) can be viewed alongside their saved metadata by opening up them up directly from the command palette. + +### via Command Palette + + + + Open the Command Palette using `⌘+shift+p` (macOS) or `ctrl+shift+p` (Windows/Linux) + + + + Type in `Pieces: Open Saved Material` to access your saved materials + + + + Scroll through the list to find the snippet you’d like to view + + + + Highlight the desired snippet and press `return` (macOS) or `enter` (Windows/Linux) + + + +This opens up the snippet in markdown preview mode in a separate window. In the new window, you have the ability to [share, view metadata, edit, copy, or delete the snippet](/products/extensions-plugins/sublime/drive). + + + +## Real Time Snippet Streaming[​](/extensions-plugins/jetbrains#real-time-snippet-streaming) + +Each product in the Pieces Suite uses [PiecesOS](/products/core-dependencies/pieces-os) to get information about your snippets' context. + +When you update a snippet in the [Pieces Desktop App](/products/desktop)—such as a name or description, tags or any of the other metadata—those changes are also reflected in your Pieces for Sublime Text Plugin without refreshing. + + + If your snippets are not updating right away, see the [troubleshooting guide](/products/extensions-plugins/sublime/troubleshooting) for details on how to refresh your snippet list. + \ No newline at end of file diff --git a/public/content/_deprecated/extensions-plugins/sublime/drive/sharing.md b/public/content/_deprecated/extensions-plugins/sublime/drive/sharing.md new file mode 100644 index 0000000..159bd84 --- /dev/null +++ b/public/content/_deprecated/extensions-plugins/sublime/drive/sharing.md @@ -0,0 +1,70 @@ +--- +title: Sharing Snippets +path: /extensions-plugins/sublime/drive/sharing +visibility: PUBLIC +status: PUBLISHED +description: The Share Snippets feature in the Pieces for Sublime Text Plugin lets users create shareable links for code snippets directly from the interface, simplifying sharing with others. +metaTitle: How to Share Code Snippets in Sublime with Pieces Drive +metaDescription: Easily share code snippets from Sublime Text using Pieces Drive’s shareable links. +--- + +## How to Share a Saved Snippet + +To create a link that you can share anywhere, right-click on a section of selected code, hover over the `Pieces` option, and then choose `Generate Shareable Link`. + +A prompt will appear, allowing you to either `Copy` or `Dismiss` the shareable link. + + + +When you click `Generate Shareable Link`, the Pieces Copilot will generate the link, then open a small menu with two options—`Copy` or `Dismiss`, allowing you to either copy the link or disregard the link. + +Selecting `Copy` will copy the shareable URL to your clipboard: + + + +This feature allows the recipient to easily access and view the snippet, even if they don't have Pieces installed or have a Pieces account. + + + This link can easily be shared via email, Discord, Slack, or other platforms. The recipient can view the snippet **without needing to have a Pieces account.** + + +## Generating Links for Existing Snippets + +In addition to sharing code snippets on the fly, you can also open up previously saved materials and generate a shareable link from the embedded `Share` button. + + + +## Enriched Sharing Experience + +When you `Share` a snippet, it’s not just the code that’s included. The snippet comes with additional metadata to provide context—[you can read more about that here.](/products/extensions-plugins/sublime/drive/save-snippets#whats-stored-when-you-save-a-snippet) + +* `Snippet Type`: Identify the language or framework, such as Python or React. + +* `Tags`: Useful keywords for quick categorization. + +* `Description`: A short summary of what the snippet does. + +* `Related Links`: Helpful resources or documentation tied to the snippet. + +* `Author Information`: A record of who created the snippet. + + + +## What Information Gets Shared + +When a snippet is saved to the Pieces Cloud, the code is [enriched with valuable information](/products/extensions-plugins/sublime/drive/save-snippets#whats-stored-when-you-save-a-snippet) such as related people, links, annotations, tags, and an automatically-generated description. + +This information is visible to the right of the code block when the shared snippet is open in your browser: + + + +### Sensitive Information Watchdog + +The `Generate Shareable Link` feature does more than just allow you to effectively share snippets across your entire team and other communities, though. + +You'll see a section titled **Sensitive Information:** + + + +Our in-house ML model scans snippets for potentially sensitive information, like API keys or passwords, and alerts you so that you can make an informed decision before sharing the snippet.   +The scan happens locally using on-device machine learning models **before the snippet is uploaded to the cloud** for sharing—that way, you can make an informed decision about sharing your code. \ No newline at end of file diff --git a/public/content/_deprecated/extensions-plugins/sublime/get-started.md b/public/content/_deprecated/extensions-plugins/sublime/get-started.md new file mode 100644 index 0000000..d3b5f8e --- /dev/null +++ b/public/content/_deprecated/extensions-plugins/sublime/get-started.md @@ -0,0 +1,155 @@ +--- +title: Get Started +path: /extensions-plugins/sublime/get-started +visibility: PUBLIC +status: PUBLISHED +description: Follow the steps below to install and use the Pieces for Sublime Text Plugin. +metaTitle: Getting Started with Pieces for Sublime | Pieces Docs +metaDescription: Install and set up the Pieces for Sublime Text Plugin to integrate AI-powered assistance into your coding workflow. +--- + + + +## Sublime Prerequisites + +Before you begin, make sure you have: + +* **PiecesOS:** The core engine that powers all Pieces extensions. [Learn more about PiecesOS.](/products/core-dependencies/pieces-os) + +* **Sublime Text:** Make sure you’ve installed Sublime Text on your development machine. + +You must have **PiecesOS** to use the Pieces for Sublime Plugin. We also recommend downloading the Pieces Desktop App. + +### Sign in Required + +Pieces requires all users to sign in before using any plugins or extensions. You'll be prompted to authenticate if you haven't already. For help, see our [sign-in guide](/products/meet-pieces/sign-into-pieces). + +## Installing the Pieces for Sublime Text Plugin + +Start by installing Package Control, a required dependency for installing plugins and other tools within the Sublime Text environment. + +Visit the Package Control installation page and follow the instructions to install Package Control in Sublime Text. + + + + + + Use the shortcut `⌘+shift+p` (macOS) or `ctrl+shift+p` (Windows/Linux) to open the command palette + + + + Using the command palette, search for `Package Control: Install Package`, then search for `Pieces` and select it + + + + After installing the Pieces Plugin, restart the Sublime editor to ensure all the dependencies are loaded properly + + + +### Setting up PiecesOS + +PiecesOS is required for the Pieces for Sublime Text Plugin to work. + +If you haven’t installed it yet, click the buttons to download PiecesOS via the recommended method, or follow the alternative steps below. + +## Updating + +The Pieces for Sublime Text Plugin will automatically update when a new version is available via `Package Control`. + +When the plugin updates, you’ll see a small success message pop-up in the center of your Sublime Text Editor. + + + **Update notifications** cover updates for both the Pieces for Sublime Text and PiecesOS. + + +You can also manually update the plugin by opening your Command window in Sublime Text by using `⌘+shift+p` (macOS) or `ctrl+shift+p` (Windows/Linux), locating the `Package Control: Upgrade Package`, and clicking the option. + +This will auto-update the Pieces for Sublime Text Plugin. + +## Disconnect from Pieces Cloud + +Connecting to the Pieces Cloud is optional. However, it **provides additional features** like **data backups, shareable links, and more.** You can enjoy the main functionalities of Pieces without an account. + + + Disconnecting from the Pieces Cloud logs you out of your Pieces account. + + +To disconnect from the Pieces Cloud: + + + + Open the command palette + + + + Select `Pieces: Disconnect from Pieces Cloud` + + + + + +## Onboarding + +The Pieces for Sublime Text plugin has an interactive walkthrough that shows all the steps in one panel. This onboarding page guides you on saving, viewing, and using saved materials, helping you get the most out of the Pieces for Sublime Text plugin. + + + +### PiecesOS Installation + +If PiecesOS is not installed or running on your system, you can launch it here. This section allows you to install or open PiecesOS directly from within Sublime. + +### Create your First Snippet + +When you click `creation`, Pieces will automatically generate you a sample snippet in a new tab and give you a few steps that will walk you through saving a snippet—right click on the snippet, hover over `Pieces`, and select `Save to Pieces`. + + + +### View your Saved Snippets + +Click `View Your Saved Materials`—Pieces Drive will open to your **Saved Materials**, displaying any snippets you saved before and the newly generated snippet. + +### Search for your Saved Snippet + +After clicking `searching`, a prompt window opens up where you can search for your snippet with [three optional ways to search](/products/extensions-plugins/sublime/drive/search-reuse). + + + +### Ask for Help + +After clicking the prompt, `Ask for help and get those bugs fixed`, PiecesOS will open a new snippet with a hidden bug in a new window and guide you through the process of fixing it. You can `right-click` the snippet, hover over `Pieces`, go to `Quick Actions`, and select `Fix a bug`. + + + +### Pieces Copilot + +This is when you're introduced to opening Pieces Copilot. When you select `Copilot`, Pieces will open a new tab with Pieces Copilot ready for a prompt! + +Once you open the Copilot, the onboarding step is done. You can now ask [questions about your code](/products/extensions-plugins/sublime/copilot/chat), [document it](/products/extensions-plugins/sublime/copilot/documenting-code), [debug errors](/products/extensions-plugins/sublime/copilot/debugging-errors), or [refactor selected material](/products/extensions-plugins/sublime/copilot/refactoring)—all within the Sublime Text interface. + +### Explain + +You might encounter some sections of code, whether from GitHub or something you haven't looked at in a while. Pieces provides an explanation feature to help you understand what's going on in the code—this section shows you how to use it. + +When you click `explanation`, a new tab will open. Right-click, hover over `Pieces`, go to `Ask Copilot`, and select `Explain`. + +### Explore the Features + +The final three steps provide useful information to help you use PiecesOS without any problems. Select `documentation` to access this guide and learn more about Pieces for Sublime Text. + +If you encounter more issues than expected, select `Pieces: Get Support` to access our support right away. + +If you have more questions or want to join the Pieces community, select `Pieces: About` in step 10, which will open a tab with all our community and support links. + + + +## Uninstalling + +To uninstall the Pieces for Sublime Text Plugin, open your Command window in Sublime Text by using `⌘+shift+p` (macOS) or `ctrl+shift+p` (Windows/Linux), locating the `Package Control: Remove Package`, looking for the option `Pieces` and clicking the option. + +In order for Pieces to be completely uninstalled from the Sublime Text, you'll need to restart the IDE. + + + + + Restart your Sublime Text editor after uninstalling the plugin to complete to uninstallation process. + \ No newline at end of file diff --git a/public/content/_deprecated/extensions-plugins/sublime/troubleshooting.md b/public/content/_deprecated/extensions-plugins/sublime/troubleshooting.md new file mode 100644 index 0000000..02c4d89 --- /dev/null +++ b/public/content/_deprecated/extensions-plugins/sublime/troubleshooting.md @@ -0,0 +1,43 @@ +--- +title: Troubleshooting +path: /extensions-plugins/sublime/troubleshooting +visibility: PUBLIC +status: PUBLISHED +description: Find links to support resources, documentation and our Discord channel for any troubleshooting related to the Pieces for Sublime Text Plugin. +metaTitle: Troubleshooting Common Issues with the Pieces for Sublime Text Plugin +metaDescription: Resolve common issues with the Pieces for Sublime Text using our troubleshooting guide. +--- + +## Having Trouble with Pieces for Sublime Text? + +If the Pieces for Sublime Text Plugin isn’t working as expected, try the following troubleshooting steps. + + + +### Ensure You Have the Latest Version(s) + +First, confirm you’re using the latest version of the Pieces for Sublime Text Plugin from Package Control and the latest version of [PiecesOS](/products/core-dependencies/pieces-os). + +The minimum functioning version permitted is currently **1.4.3.** + +### Check PiecesOS Status + +Check to make sure PiecesOS is running. PiecesOS must be running for the Pieces for Sublime Text Plugin to work. + +### Restart Sublime Text After Updates + +If you’ve recently installed or updated PiecesOS or the Pieces for Sublime Text Plugin, restart the IDE. + +Contact the Pieces support team if the issue still persists. + +### macOS-Specific Configuration + +Make sure that the `host` object inside the Pieces Settings file is **empty,** not set to `localhost:1000` as this creates issues with Package Control trying to load the Pieces Package, and can disable the plugin. + +### Reload the Plugin​ + +If you're experiencing an issue or something isn't working properly, try reloading the plugin. + +To do so, open the command palette using `⌘+shift+p` (macOS) or `ctrl+shift+p` (Windows / Linux) and typing `Pieces: Reload Plugin`, then press Enter. + + \ No newline at end of file diff --git a/public/content/_deprecated/web-extension/configuration.md b/public/content/_deprecated/web-extension/configuration.md new file mode 100644 index 0000000..694c9aa --- /dev/null +++ b/public/content/_deprecated/web-extension/configuration.md @@ -0,0 +1,171 @@ +--- +title: Configuration +path: /web-extension/configuration +visibility: PUBLIC +status: PUBLISHED +description: Read the guide below to set up the Pieces Web Extension to fit your workflow and preferences. +metaTitle: Supported LLMs & Extension Settings +metaDescription: Discover 54+ local and cloud LLMs in the Pieces Web Extension, learn to configure Copilot runtimes, adjust settings, and switch models seamlessly. +--- + +## Supported LLMs + +We regularly update and configure our plugins and extensions to work with the latest LLMs. + +The Pieces Web Extension currently [supports a range of cloud-hosted and local LLMs](/products/large-language-models) from your favorite providers, such as Anthropic, Google, OpenAI, Microsoft, and more. + +[Read documentation on switching your Pieces Copilot Runtime (LLM)](/products/web-extension/copilot/llm-settings#how-to-configure-your-llm-runtime) utilized by the Pieces Web Extension. + +## Opening Pieces Settings + +To open the settings within the Pieces Web Extension, follow these steps: + + + + From your browser’s extensions list, select the `Pieces icon`. + + + + In the top-right of the extension, select the `sandwich` icon. + + + + After opening the horizontal bar menu, select the `Settings` button. This will open the available settings for the Pieces Web Extension. + + + + + +## Settings Overview + +Below is a breakdown of each adjustable setting (preferences, behaviors, views, etc.) available in the Pieces Web Extension, updated according to the latest features. + +### Account & Cloud Integrations (*Beta*) + +Displays your Pieces account details and cloud‑integration status. + +* **Profile & Early Access**: Your name, email, GitHub link, and Early Access enrollment + +* **Personal Cloud**: Connection status, last sync time, and custom domain (e.g., `nolanworksat.pieces.cloud`) + +### Backup & Restore Data + +Trigger a manual backup of your local data to the cloud or restore from a snapshot. + +### Copilot LLM Runtime + +Choose which language model powers Copilot in the extension (e.g. GPT‑4o Mini, GPT‑4o). + + + You can switch between local and cloud models here using the `cloud` and `desktop` icons. + + +### Accent Color + +Select the UI accent color used throughout the extension (Blue, Green, Purple, etc.). + +### Use Long‑Term Memory (LTM-2.7) Context by Default + +When checked, your saved long‑term memory is automatically included in every Pieces Copilot query without needing to re-enable LTM chat-by-chat. + +### Delete All Copilot Chats… + +Clears all saved Pieces Copilot chat history inside the Pieces Web Extension. + + + This action is *not reversible.* Clearing your chat history is a permanent action. + + +### Saved Material Auto‑Enrichment + +Choose how much automatic enrichment occurs when saving materials. This can be beneficial for speed and performance on older systems, or if you’re utilizing local-only LLMs. + +* **None**: No metadata + +* **Low**: Basic metadata + +* **Medium**: Intermediate metadata (3–6 data points) + +* **High**: Extensive metadata (6+ data points) + +### ML Processing + +Choose how Pieces utilizes cloud and local LLMs to process context and power other Pieces features. + +* **Processing Mode**: Cloud‑based / Local (on‑device) / Blended + +* **Long‑Term Memory Engine**: On/off toggle and engine version (e.g., LTM‑2) + +### Long‑Term Memory Source Control + +When generating context, choose which sources (chats, visited pages, etc.) the LTM-2.7 engine draws context from. + +This can also be done within the PiecesOS Quick Menu in the `Long-Term Memory Engine Access Control` panel. + +### Clear Long‑Term Memory Engine Data… + +Delete persisted memory captured by the LTM engine for a specified time range. + +### Enable Pieces Buttons by Default + +Automatically shows the floating Pieces button on every webpage, so your extension is always running. + +### Enable Pieces Buttons for This Site + +Toggle the Pieces toolbar on or off for just the current domain. + +### Button Placement + +Position the floating action button (Bottom Left, Bottom Right, etc.). + +### Button Color + +Use the action button's light or dark theme to match your browser. + +### Minimum Number of Characters for a Code Block + +Set the minimum character count before the extension recognizes a code block. This is helpful for blacklisting short, one-line code elements, like terminal commands. + +### Code Block Actions + +Configure which actions (copy, save snippet, run tests, etc.) appear on detected code blocks. + +### Number of Recent Websites to Save Snippets For + +Limit how many domains Pieces will track for snippet‑saving history. + +### Append Recent Websites + +If checked, newly visited domains are automatically added to your “recent websites” list. + +### Save Visited Websites for Context + +Include the page’s metadata and content whenever you save a snippet. These websites can then be referenced and added as context to future Pieces Copilot chats. + +### Telemetry & Diagnostics + +Opt in or out of sharing anonymous usage metrics and crash reports. + +### Documentation + +Quick link to the official extension documentation. + +### Submit Feedback/Issues + +Open the feedback form or GitHub issues page for bugs and feature requests. + +### PiecesOS Version + +Shows the version of your local PiecesOS service (e.g. 11.3.1). + +### Check for PiecesOS Updates + +Manually check for updates to your local PiecesOS installation. + +### PiecesOS Port + +Displays the port (default: 39300) on which your local PiecesOS server is actively listening & posting requests to. + +*** + +For additional support resources, check out our [troubleshooting guide.](/products/web-extension/troubleshooting) \ No newline at end of file diff --git a/public/content/_deprecated/web-extension/copilot.md b/public/content/_deprecated/web-extension/copilot.md new file mode 100644 index 0000000..ac6fbbd --- /dev/null +++ b/public/content/_deprecated/web-extension/copilot.md @@ -0,0 +1,69 @@ +--- +title: Pieces Copilot +path: /web-extension/copilot +visibility: PUBLIC +status: PUBLISHED +description: You can use the Pieces Copilot right from your browser to ask questions, generate code, investigate code logic, prompt saved workflow context with the optional LTM-2.7 engine, and more. +metaTitle: Generative AI Conversations +metaDescription: Discover how to use Pieces Copilot for context aware AI chats with LTM‑2 by adding file context and switching LLMs to streamline prototyping and collaboration. +--- + +## Generative AI Conversations + +If you're unsure how to implement something, stuck on a bug, or need an answer within your workspace, use the Pieces Copilot for context-aware responses to help you move forward. + +The Pieces Web Extension offers several levels of conversation functionality, all fully integrated with Pieces. + +You can enable the [**Long Term Memory Engine (LTM-2.7)**](/products/meet-pieces/fundamentals#ltm-27) for complete, streamlined context across your workflow or open a limited context conversation in the browser's view. + + + +## Adding Conversation Context + +The Pieces Copilot lets you add specific folders or files to the conversation's context window, like files from your current workspace. + +You can add individual external items as context to your chat from within the Pieces Copilot view. + + + This differs from starting a chat using one of the embedded buttons under a code snippet, such as on Stack Overflow (see the image below). + + + + +To start a conversation that’s pre-loaded with context, find a code snippet on a website such as Stack Overflow or your favorite code platforms and select the `Ask Copilot` quick action beneath it. + +## Selecting Your Pieces Copilot Runtime + +You can choose between [different LLMs directly within the Pieces Web Extension](/products/web-extension/copilot/llm-settings) by accessing the sidebar and clicking on your preferred model under `Active Model` (e.g., *Claude 3.5 Sonnet*). + +Options range from lightweight models for simple queries to advanced models for detailed analysis, including [local](/products/large-language-models/local-models) and [cloud-based LLMs](/products/large-language-models/cloud-models). + +This flexibility lets you customize Pieces Copilot to fit your specific development needs, whether you prioritize speed or accuracy. + + + +Read more about [what LLMs are available](/products/large-language-models) with the Pieces Web Extension. + +## Pieces Copilot As a Daily Driver + +The Pieces Copilot is a powerful, adaptable tool that grows with you as you use it—*so use it!* + +*** + + + + Generate detailed comments and documentation for better team collaboration and also reduce onboarding times, creating a unified coding style across teams. + + + + Generate initial implementations and boilerplate code for prototypes and fast-paced projects. Ideal for hackathons, PoCs, and other time-sensitive tasks. + + + + Pieces Copilot doubles as a learning tool, helping you explore best practices, new paradigms, and advanced techniques in real-time. + + + +*** + +[Download the Pieces Web Extension Today!](/products/web-extension/get-started#supported-browsers) \ No newline at end of file diff --git a/public/content/_deprecated/web-extension/copilot/chat.md b/public/content/_deprecated/web-extension/copilot/chat.md new file mode 100644 index 0000000..fde0e7a --- /dev/null +++ b/public/content/_deprecated/web-extension/copilot/chat.md @@ -0,0 +1,131 @@ +--- +title: Generative AI Conversations +path: /web-extension/copilot/chat +visibility: PUBLIC +status: PUBLISHED +description: Enhance your development workflow with Copilot Chats in the Pieces Web Extension—an interactive AI assistant directly in your favorite browser. +metaTitle: Accessing Pieces Copilot Chat in Web Extension +metaDescription: Learn how to open the Pieces Copilot chat via right‑click menus, AI quick actions, or the sidebar, and add files, code snippets, or screenshots for context‑aware assistance. +--- + +## Accessing the Pieces Copilot Chat in the Web Extension + +There are several ways to open up the Pieces Copilot chat window in your browser. + +### via Right-Click Context Menu + +The primary method of accessing Pieces Copilot, Pieces Drive, and other views is from the right-click menu. + + + + When you find a code snippet or an important text block, highlight it. + + + + Right-click on your selection, hover over `Pieces`, and select `Ask Copilot About…` + + + + This initiates a Pieces Copilot chat using the active code snippet as pre-loaded context for the conversation. + + + +### via AI Quick Actions + +Under any code block, Pieces adds AI Quick Actions that let you quickly open the Copilot Chat window with the context of the code block. + +Clicking the `Ask Copilot` Quick Action will start a Copilot Chat with the code within the code snippet as context. + + + +### via the Sidebar + +You can open up the dedicated Pieces Copilot view to locate previous chats or start new ones without context right from the sidebar. + + + + Select the `Pieces` icon in the extensions within your browser. + + + + If it's not enabled by default, click the dropdown in the top left and choose Pieces Copilot to access the Copilot Chats. + + + + + +## Starting Copilot Chats with Context + +You can add context to a chat by adding `Files`**,** `Folders`**,** `Snippets`**,** `Websites`**,** and `Messages`**.** + +This greatly boosts the number of generative AI responses you receive that will actually benefit you. It can provide *hyper-specific* responses because it’s contextually aware of your workspace. + +To do this, you can select the `Circled Plus` Icon in the bottom-left corner of your Copilot Chat window, which is openable from the extensions section of your browser. + +Click the `Circled Plus` icon**,** then add whatever context items you need. + + + +### Adding Code Snippets + +You can paste code snippets as a code block in any Copilot Chat by clicking the `{ }` icon in the add context window and then pasting your code. + +This helps add code that isn't currently in the active file as context, or for making comparisons and suggestions. + +You can also locate a code snippet, i.e., on StackOverflow, and select the `Ask Copilot` that appears below it. + + + +### Extracting Code from Screenshots + +You can extract code from screenshots directly in the Copilot chat menu by selecting `Extract Code from Screenshot`. + +Choose the screenshot from your **Finder** (macOS) or **File Explorer** (Windows/Linux) menu, and confirm your selection. + +Pieces Copilot will scan the screenshot and generate the code from the image into the chat. You can then copy it, save it as a snippet, and more. + + + +## AI Quick Actions + +Below code blocks on websites, you can find a clickable `Ask Copilot` option that will allow you to ask Pieces Copilot directly about the code. + +Clicking `Ask Copilot` will open the Pieces Copilot sidebar. The code will be explained within that chat, along with its purpose and function. + + + +## Improving Code Consistency & Standardization + +The Pieces Copilot Chat helps you with coding and learning tasks to increase productivity and improve your workflow. + +It achieves this by removing the need for **context-switching** (leaving your window to use generative AI). + +### Naming Inconsistencies + +Suppose functions across your workspace use inconsistent naming patterns (e.g., `authenticateUser` in `authHandler.go` vs. `retrieveUserProfile` in `userHandler.go`). + +In that case, it is helpful to adopt a standardized naming convention for better readability and maintainability. You can find suggestions for such conventions in snippets available on the web, like this: + +```c +// authHandler.go +func authenticateUser(ctx context.Context, credentials Credentials) (User, error) { + if credentials.Username == "" || credentials.Password == "" { + return User{}, errors.New("missing credentials") + } +} +``` + +### Inconsistent Error Handling + +If error-handling strategies differ across web sources (e.g., structured errors in `authService.go` vs. inconsistent handling in `userService.go`), Pieces Copilot can help unify the approach: + +```c +// authService.go +func LoginUser(credentials Credentials) (string, error) { + token, err := authenticate(credentials) + if err != nil { + return "", fmt.Errorf("login failed: %w", err) + } + return token, nil +} +``` \ No newline at end of file diff --git a/public/content/_deprecated/web-extension/copilot/llm-settings.md b/public/content/_deprecated/web-extension/copilot/llm-settings.md new file mode 100644 index 0000000..a767670 --- /dev/null +++ b/public/content/_deprecated/web-extension/copilot/llm-settings.md @@ -0,0 +1,53 @@ +--- +title: Switching LLMs +path: /web-extension/copilot/llm-settings +visibility: PUBLIC +status: PUBLISHED +description: The Pieces Web Plugin currently supports many different LLMs, including both cloud-hosted and local models. +metaTitle: Pieces Web Extension Available LLMs & Configuration +metaDescription: Explore 54+ local and cloud‑hosted LLMs in Pieces Docs and learn how to switch models instantly in the Web Extension for seamless, context‑aware AI workflows. +--- + +## Available LLMs + +We constantly update and configure our plugins and extensions, like the Pieces for Obsidian Plugin, to work with the latest LLMs. + +Click here to see all [54+ local and cloud-hosted models available](/products/large-language-models) for use with the Pieces for Obsidian Plugin. + +## How To Configure Your LLM Runtime + +Switching your LLM model in the Pieces Web Extension is + +You can choose the model that best suits your needs, such as whether you need a model with a large context window for a specific task or series of prompts, or prefer speed over accuracy. + +How to change your LLM: + + + + Open the Copilot Chat view by clicking the `Pieces Icon` in the extensions section of your browser. + + + + Find the **Active Model** in the bottom-left corner of the view, where the current model (e.g., *GPT-4o Mini*) is shown. + + + + + + Click on `Change Model` to open the **Manage Copilot Runtime** modal. + + + + Browse the list of local and cloud models, and select your preferred model. + + + +Switching between the cloud and desktop icons allows you to browse and select from various available cloud and local models. + + + Cloud-hosted models offer access to the latest AI capabilities, while on-device models ensure offline functionality, making Pieces Copilot adaptable to your specific workflow and environment. + + +Once you choose a new model, the switch is instant, allowing you to continue working smoothly with the latest model's features without restarting or refreshing anything. + + \ No newline at end of file diff --git a/public/content/_deprecated/web-extension/drive.md b/public/content/_deprecated/web-extension/drive.md new file mode 100644 index 0000000..8a4fdcc --- /dev/null +++ b/public/content/_deprecated/web-extension/drive.md @@ -0,0 +1,160 @@ +--- +title: Pieces Drive +path: /web-extension/drive +visibility: PUBLIC +status: PUBLISHED +description: Snippets are handy code pieces you can save, share, reuse, modify, and integrate into future projects to boost productivity and save time searching through old resources. +metaTitle: "Pieces Drive Materials: Save & Manage Snippets" +metaDescription: Save, organize, and share code and text snippets in Pieces Drive with enriched metadata to streamline reuse and collaboration across projects. +--- + +## Materials in Pieces Drive + +With Pieces Drive and the Pieces Web Extension, you can save all types of code and text snippets. + +You can easily find, edit, and reuse them anytime, anywhere, and in any way you need. + +Here are some examples of developer materials you can reuse: + +*** + +| `Logging Utilities` | A helper function for detailed server-side logging with timestamps and error levels. | Speeds up debugging and monitoring by inserting reliable logging methods. | +| ---------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| `Validation Functions` | A function to validate JSON payloads or form inputs before submission. | Ensures data integrity with reusable, thoroughly tested validation logic. | +| `API Integration Code` | Prewritten `axios` code for making GET or POST requests, complete with error handling and response parsing. | Reduces repetitive work when integrating RESTful APIs or GraphQL endpoints. | +| `Component Templates` | A React functional component template with basic hooks and styling setup. | Provides a consistent starting point for building new components. | +| `Database Queries` | A MongoDB query to retrieve active user data filtered by last login. | Streamlines database tasks by reusing optimized query patterns | + +*** + +## Boosting Productivity with Snippet Management + +The Pieces Drive connects you with your notes and project files, allowing you to focus on what matters—building great software—while offering tools for efficient code reuse. + +* **Improved Productivity**: Concentrate on solving new problems instead of revisiting old ones by quickly accessing and reusing code snippets. + +* **Contextual Awareness**: Saved materials contain metadata, descriptions, and links to relevant searches, helping you remember their origin, purpose, and best usage scenarios. + +* **Code Standardization**: Sharing best practices and reusable components ensures consistent coding practices and conventions across teams and projects. + +By using the Pieces Drive, you can capture and manage your snippets to streamline daily tasks and enhance your workflow in several ways: + +### Save & Organize + +Easily [save a function, script, or piece of boilerplate](/products/web-extension/drive/save-snippets) directly from the tool menu. + +These snippets are saved to your personal Pieces Drive and enriched with context, metadata, and tags, making them easy to find whenever needed. + + + +To save a snippet in your browser, highlight a section of text or code, right-click, and select `Pieces: Save Selection`. + +On websites with code blocks, Pieces will add a `Copy and Save` option below the block, saving the snippet to your Pieces Drive. + + + +### Search & Reuse + +You can directly [search your collection of saved materials in Pieces Drive](/products/web-extension/drive/search-reuse) from your browser to quickly find snippets by keyword or context. + +To search, open the **Search Bar** from the Pieces Web extension sidebar in the Pieces Drive tab. + +Type your query into the search bar and press `return` (macOS) or `enter` (Windows/Linux) to view the search results. + + + +Any related snippets will appear in the results list. + +From there, you can press `return` (macOS) or `enter` (Windows/Linux) to view your snippet, complete with all its saved context, neatly displayed inside the editor. + +### Sharing + +Share your snippets from within the Pieces Web Extension, even if the person you’re sending it to doesn’t use Pieces or have a Pieces account. + + Sharing useful code snippets can help overcome productivity hurdles, especially if a co-developer is new to the project or is a junior developer. + + For instance, a teammate working on server monitoring can use your shared script to automate daily tasks without extra setup. + + These shared links also keep their [original enriched metadata](/products/web-extension/drive/save-snippets#whats-stored-when-you-save-a-snippet), including tags, descriptions, and other details, making it easier for teammates to understand and use the code. + + +To share a snippet from your browser, simply find a code block you want to share and click the `Share` quick action below it. + +You can also locate a snippet in your Pieces Drive, right click it, and select `Generate Shareable Link`. + +This generates a link you can share with teammates, ensuring easy access to your reusable code. + + + +## Use Cases + +With the Pieces Web Extension, [your snippets become a powerful library](/products/web-extension/drive/edit-update#how-to-edit-snippets) of reusable code. You can organize, search, edit, and share them across your projects, all within the Pieces Drive. + +Here are some examples of how you can use them: + +### Reusable Code Snippets for Data Science + +If you often work on complex data science projects, algorithm design, or data processing pipelines, you can save reusable code snippets in your Pieces Drive. + +These snippets can be easily imported into your browser for documenting workflows, analyzing results, and iterating on solutions in future projects. + +```python + +data = pd.read_csv('data.csv') + +data.fillna(method='ffill', inplace=True) + +from sklearn.preprocessing import MinMaxScaler +scaler = MinMaxScaler() +data[['feature1', 'feature2']] = scaler.fit_transform(data[['feature1', 'feature2']]) + +print(data.describe()) +``` + +### Code Snippet Documentation + +If you frequently research projects that involve monitoring file system changes, you can [save a helpful snippet to your Pieces Drive](/products/web-extension/drive/save-snippets) that does exactly that, allowing you to import it over to your IDE for usage: + +```go +func watchFileChanges(path string) { + watcher, err := fsnotify.NewWatcher() + if err != nil { + log.Fatal(err) + } + defer watcher.Close() + + err = watcher.Add(path) + if err != nil { + log.Fatal(err) + } + + for { + select { + case event := <-watcher.Events: + if event.Op&fsnotify.Write == fsnotify.Write { + fmt.Println("Modified file:", event.Name) + } + case err := <-watcher.Errors: + fmt.Println("Error:", err) + } + } +} +``` + + + + Streamline testing by saving snippets for your frequently used testing functions or unit test templates. + + + + Save command-line instructions as snippets to quickly retrieve deployment commands, Docker setups, and other essential terminal operations. + + + + You can also save common logging functions or error-handling snippets that can be reused across applications, promoting consistent error management. + + + + Import saved setup scripts, configuration files, and commonly used dependencies to speed up project setup and ensure consistency across new projects. + + \ No newline at end of file diff --git a/public/content/_deprecated/web-extension/drive/edit-update.md b/public/content/_deprecated/web-extension/drive/edit-update.md new file mode 100644 index 0000000..c46282c --- /dev/null +++ b/public/content/_deprecated/web-extension/drive/edit-update.md @@ -0,0 +1,102 @@ +--- +title: Editing +path: /web-extension/drive/edit-update +visibility: PUBLIC +status: PUBLISHED +description: Keep your code snippets up-to-date in the Pieces Web Extension with easy editing. +metaTitle: Edit Saved Materials in Pieces Drive +metaDescription: Learn to open the Pieces sidebar, locate a snippet, edit its content or metadata, and apply templating, optimization, or language conversion instantly. +--- + +## How to Edit Saved Materials + +Editing saved materials is a great way to make sure that your most-used code or reference text stays as evergreen as possible. + +The more you curate your library of saved code snippets to your specific workflow and use cases, the more useful and “dialed in” your personal repository will be over time + +To modify an existing snippet, follow these steps: + + + + Click the `Pieces icon` in the extensions section of your browser. + + + + Go to the Pieces Drive section of the browser by clicking the dropdown in the top left of the extension and selecting `Pieces Drive`. + + + + At the bottom of the quick view section, click the `Edit Selected Material` button (pencil icon) to enter editing mode. + + + + Modify the snippet's content, name, or language as needed. + + + + Click the `Save Changes` button on the bottom left of the extension. + + + + + +Within the editing view, you will also have options to 4 new options: + +* `Templatize Selected Material`: This will convert the material into a template for future usage inside your IDEs. + +* `Optimize Selected Material for Performance`: This option refactors the code for performance and future usage. + +* `Optimize Select Material for Readability`: Selecting this option will improve variable names and add helpful comments to make the code easier to understand in the future. + +* `Convert Selected Material to New Language`: This option converts the selected material to a new programming language and allows you to add custom descriptors to help improve the translation. + + + Your changes are automatically saved in real-time and reflected across the Pieces Sidebar. + + +### Material Management Actions + +There are several material management options available when editing code snippets in the Pieces Web Extension: + +*** + +| `Copy Code to Clipboard` | Instantly copy the snippet's content to your clipboard to use it in your notes or projects. | +| ------------------------ | ------------------------------------------------------------------------------------------- | +| `Edit Snippet` | Modifies the snippet's content or metadata. | +| `Edit Annotations` | Adds, updates, or removes annotations to give extra context or notes for the snippet. | +| `Share via Pieces` | Creates a shareable link to the snippet for collaboration or external use. | + +*** + +## Actions from the Quick Preview Mode + +When viewing a snippet in **Quick Preview Mode** in the Pieces Web Extension, you can use quick actions to manage snippets and enhance your workflow. + +Access these actions from the toolbar or the **Captured Context** section below the snippet. + +### Quick Menu Actions + +The Pieces Web Extension lets you easily manage your snippets by clicking the **three dots** inside the Pieces Drive section. + +From there, you can choose from a variety of options listed in the table below. + + + +*** + +| `Reclassify` | Change the snippet’s classification. | +| --------------- | ------------------------------------------------------ | +| `Rename` | Update the snippet’s title. | +| `Duplicate` | Create a copy of the snippet. | +| `Related Links` | Add or manage related links in the snippet’s metadata. | +| `Tags` | Add, update, or remove tags. | + +*** + +## Quickly Access Snippets + +*Layers upon layers of functionality*—that’s the goal of all Pieces plugins and extensions. + +Right from within the Pieces Drive tab, select a saved material to open it in markdown as a preview—then click the `Edit` icon to edit & save your code. + + \ No newline at end of file diff --git a/public/content/_deprecated/web-extension/drive/save-snippets.md b/public/content/_deprecated/web-extension/drive/save-snippets.md new file mode 100644 index 0000000..d80ca95 --- /dev/null +++ b/public/content/_deprecated/web-extension/drive/save-snippets.md @@ -0,0 +1,107 @@ +--- +title: Saving +path: /web-extension/drive/save-snippets +visibility: PUBLIC +status: PUBLISHED +description: The Pieces Web Extension provides several ways to save snippets, ensuring your most useful content is always at hand within your notes. +metaTitle: Save Materials to Pieces Drive +metaDescription: Save code snippets, markdown, and templates to Pieces Drive using right‑click menus, embedded buttons, keyboard shortcuts, or Copilot Chat for fast organization. +--- + +## Saving Materials + +You can save code snippets as materials to the Pieces Drive using the right-click menu or embedded buttons in code sections. + +You can use this feature to save all kinds of useful markdown and code materials, such as: + +* API endpoint definitions + +* Utility functions or commonly used helper methods + +* Predefined templates for organizing notes + +* Task Lists + +* Code Blocks + +* Reusable patterns for internal or external links + +### via Right-Click Menu + +To capture useful code snippets via the right-click menu: + + + + Select the section you want to save. + + + + Open the context menu by right-clicking on the selected section. + + + + From the menu, select `Save Selection to Pieces`. + + + + + +### via Embedded Buttons + +To save code snippets directly from a code block in your browser: + + + + Find the code block you want to save within your browser. + + + + Use the `Copy and Save` button embedded below the code block to save it to Pieces Drive and copy the snippet to your keyboard. + + + + + +### via Keyboard shortcut + +You can quickly save a selection to Pieces Drive. + +Just highlight the section you want to save and press `⌥+shift+s` (macOS) or `alt+shift+s` (Windows/Linux). Pieces will then save the selection to your Pieces Drive. + +### via Copilot Chat + +You can take any code block existing in your Copilot Chat and click `Save to Pieces`—like code generated by Pieces Copilot, code blocks you added as context that weren’t saved as individual snippets, and any other kind of code. + +To do so, click the `Save to Pieces` button on any code block within the Copilot Chat view. + + + +## What’s Stored When You Save a Material + +When you save a snippet to your Pieces Drive, more than just the code is stored. + +The Pieces Copilot captures: + +* `Type`: Categorizes the snippet (e.g., API call, function, class) and its programming language. + +* `Associated Tags`: Keywords linked to the snippet for easier searching. + +* `Custom Description`: Specifies exactly which *lines* (in numerical form) the snippet is from and the file it came from—very useful for mind-mapping. + +* `Smart Description`: AI-generated descriptions summarize the snippet’s purpose and function. + +* `Suggested Searches`: Related searches that help you find similar snippets. + +* `Related Links`: References to documentation, code repositories, or other relevant resources. + +* `Related People`: Associated collaborators or contributors. + + + +Additionally, the Pieces Copilot **scans saved snippets for sensitive information**, such as API keys, passwords, or authentication tokens, to ensure no confidential data is accidentally stored. + +## Where Saved Materials Live + +Saved snippets are stored locally on your device, ensuring offline accessibility. This also means that any Pieces extension, plugin, or even the Pieces Desktop App, has constant, up-to-date access to your saved materials. + +[Read more about how to find your saved snippets here.](/products/web-extension/drive/search-reuse#finding-saved-snippets) \ No newline at end of file diff --git a/public/content/_deprecated/web-extension/drive/search-reuse.md b/public/content/_deprecated/web-extension/drive/search-reuse.md new file mode 100644 index 0000000..bce8498 --- /dev/null +++ b/public/content/_deprecated/web-extension/drive/search-reuse.md @@ -0,0 +1,155 @@ +--- +title: Searching +path: /web-extension/drive/search-reuse +visibility: PUBLIC +status: PUBLISHED +description: The Pieces Web Extension lets you quickly find saved snippets, keeping you productive without disrupting your workflow. +metaTitle: Finding Saved Materials in Pieces Drive +metaDescription: Find and manage your saved snippets in the Pieces Web Extension via the sidebar or search bar. Filter, sort, preview, and reuse code materials instantly. +--- + +## Finding Saved Materials + +The Pieces Web Extension view provides search options for locating saved materials within the Pieces Drive. + + + Once a material is located, you can edit the saved code or text, share it, use it as context for pieces Copilot chats, and more. + + +Here are a few different ways to locate Pieces Drive materials with the Pieces Web Extension: + +### via Pieces Sidebar + +To locate your snippets, use the Pieces Web Extension sidebar: + + + + Open the Pieces Web Extension from your browser’s extension section. + + + + On top of the extension, select the dropdown menu, choose Pieces Drive, and then select the `Saved Materials` tab. + + + + + + Click on a snippet to view its content, related details, and quick actions. + + + + + +### via Search Feature + +If you know exactly what you’re looking for, you can search for specific snippets: + + + + Open the search bar at the top of the Pieces Web Extension sidebar. + + + + Type your search query. + + + + Scroll through the results or use the arrow keys to find your desired snippet. + + + + Click on the snippet to open it and view its content, associated metadata, and quick actions. + + + + + + + To narrow down your search, you can use tags, descriptions, names, types, or even languages themselves. + + +## Adding Filters to Your Search + +Saved snippets being viewed in the Pieces Web Extension sidebar can be sorted and filtered to narrow down your search results. + +### Filtering Snippets + +Filter for saved materials that meet specific criteria if you have too many results to sift through manually. + + + + Open the Pieces Web Extension, change to `Pieces Drive`, select the `Saved Materials` tab, and click on the search bar at the top of the extension. + + + + Apply quick filters such as `Titles`, `Annotations`, or `Content` that appear below the search bar. + + + + Enter specific tags or keywords in the search bar to narrow down the snippets displayed. + + + + + +### Sorting Saved Materials + +Once you have a list of saved materials in view, you can sort through them according to various criteria to locate the material you need. + + + + Click the icon at the top of the extension(e.g., the `clock` icon for *Recent*). The icon changes based on the selected sorting method. + + + + Select your preferred sorting order, such as `Recent`, `Suggested`, `Alphabetical`, or `Language`. + + + + + +## Viewing and Reusing Saved Snippets + +[Saved snippets](/products/web-extension/drive/save-snippets) can be viewed with their metadata by opening them directly from the Pieces Web Extension. Just click on them in the Pieces Drive once you've found them. + +From this view, you can use Quick Actions or copy the snippet in your browser. You can also click on the snippet for a quick overview. + + + +From this view, use the `Pieces Actions` button at the bottom of the snippet to copy, edit, update annotations, generate a shareable link, toggle the visibility of the Pieces Actions buttons, or highlight and right-click to copy. + + + You can press `⌘+c` (macOS) or `ctrl+c` (Windows/Linux) to copy to your clipboard. + + +### via Pieces Sidebar + +You can view saved materials by opening Pieces Drive in your browser. + +Click the Pieces icon in the extension list, click the dropdown menu at the top left of the extension, and select `Pieces Drive`. + +Once in the snippet, you can copy a snippet from Pieces Drive and use that material anywhere you’d like. + + + +### Previewing Saved Snippets + +When using the Pieces Drive within the Pieces Web Extension, you can click on the **three vertical dots** on a saved code snippet to **delete it**, or select from 6 additional options: + +*** + +| `View Preview` | `Start Copilot Chat` | `Copy to Clipboard` | +| ------------------ | ------------------------- | ----------------------- | +| `Insert at cursor` | `Generate Shareable Link` | `Open Markdown Preview` | + +*** + +## Real-Time Snippet Streaming + +Every product within the Pieces Suite utilizes [PiecesOS](/products/core-dependencies/pieces-os) to gather information regarding the context of your snippets. + +When you modify a snippet in the Pieces Desktop App—like changing its name or description, tags, or any other metadata—those updates are automatically shown in your [Pieces Web Extension](/products/web-extension/get-started#supported-browsers) without the need for refreshing. + + + If your snippets aren’t updating immediately, refer to the [troubleshooting guide](/products/web-extension/troubleshooting) for instructions on refreshing your snippet list. + \ No newline at end of file diff --git a/public/content/_deprecated/web-extension/drive/sharing.md b/public/content/_deprecated/web-extension/drive/sharing.md new file mode 100644 index 0000000..437b30f --- /dev/null +++ b/public/content/_deprecated/web-extension/drive/sharing.md @@ -0,0 +1,89 @@ +--- +title: Sharing Saved Materials +path: /web-extension/drive/sharing +visibility: PUBLIC +status: PUBLISHED +description: The Share feature in the Pieces Web Extension lets you create a shareable link for your snippets from the Pieces Drive to share them directly from the browser interface. +metaTitle: Shareable Snippet Links via Pieces Cloud +metaDescription: Use quick actions or Pieces Drive to generate shareable snippet links with enriched metadata, author info, and sensitive‑info alerts. +--- + +## What Information Gets Shared + +When a snippet is saved to the Pieces Cloud, the code is [enriched with valuable information](/products/web-extension/drive/save-snippets#whats-stored-when-you-save-a-snippet) such as related people, links, annotations, tags, and an automatically-generated description. + + + +## How to Generate Shareable Links + +There are two ways to share saved snippets: by using the `Pieces Quick Actions` on code blocks on websites or directly from Pieces Drive within the Pieces Web Extension. + +This link can easily be shared via email, Discord, Slack, or other platforms. The recipient can view the snippet **without the recipient needing to have a Pieces account.** + +### via Codeblock Quick Actions + +Shareable Pieces links for code snippets found on the web can be generated by clicking `Share` under a code block on the web. + + + +## Sharing a Previously Saved Snippet + +If you save a material, but didn’t generate a shareable link at the time, no problem. + +You can still generate a shareable link (or copy, regenerate, and delete the existing link) from the Pieces Drive. + + + + Click the `Pieces icon` within the extensions section of your browser. + + + + After the Pieces Web Extension is opened, select the dropdown in the top left and choose `Pieces Drive`. You can then switch to the `Saved Materials` section to see all of your previously saved snippets. + + + + Locate a snippet you’d like to share and select it to open the Quick Preview. + + + + Click the `Generate Shareable Link` option at the bottom of the snippet Quick Preview. + + + Alternatively, access sharing options using the Quick Menu (three-dot icon) button. + + + + + A new pop-up will appear giving you options to copy the personal link or generate a GitHub Gist. + + + + + +## Enriched Sharing Experience + +When you `Share` a snippet, it’s not just the code that’s included. The snippet comes with additional metadata to provide context—[you can read more about that here.](/products/web-extension/drive/save-snippets#whats-stored-when-you-save-a-snippet) + +* `Snippet Type`: Identify the language or framework, such as Python or React. + +* `Tags`: Useful keywords for quick categorization. + +* `Description`: A short summary of what the snippet does. + +* `Related Links`: Helpful resources or documentation tied to the snippet. + +* `Author Information`: A record of who created the snippet. + + + +## Sensitive Information Watchdog + +The `Share` feature does more than just allow you to effectively share snippets across your entire team and other communities, though. + +You'll see a section titled **Sensitive Information:** + + + +Our in-house ML model scans snippets for potentially sensitive information, like API keys or passwords, and alerts you so that you can make an informed decision before sharing the snippet.   + +The scan happens locally using on-device machine learning models **before the snippet is uploaded to the drive** for sharing. This allows you to make an informed decision about sharing your code on a case-by-case basis. \ No newline at end of file diff --git a/public/content/_deprecated/web-extension/get-started.md b/public/content/_deprecated/web-extension/get-started.md new file mode 100644 index 0000000..76c4968 --- /dev/null +++ b/public/content/_deprecated/web-extension/get-started.md @@ -0,0 +1,181 @@ +--- +title: Get Started +path: /web-extension/get-started +visibility: PUBLIC +status: PUBLISHED +description: Follow the steps below to install and use the Pieces Web Extension. +metaTitle: Getting Started with Pieces Web Extension +metaDescription: "Learn how to set up the Pieces Web Extension: prerequisites, browser installation, PiecesOS integration, updates, cloud connection, onboarding, and uninstall." +--- + + + +## Web Extension Prerequisites + +Before you begin, make sure you have: + +* **PiecesOS:** The core engine that powers all Pieces extensions. Learn more about PiecesOS. + +* **A Supported Browser:** Your browser must meet the minimum version requirement and must also be on the list of supported browsers, as not all browsers are supported at this time. + + + You must have [PiecesOS](/products/core-dependencies/pieces-os) to use the Pieces Web Extension. We also recommend downloading the [Pieces Desktop App](/products/desktop). + + +### Sign in Required + +Pieces requires all users to sign in before using any plugins or extensions. You'll be prompted to authenticate if you haven't already. For help, see our [sign-in guide](/products/meet-pieces/sign-into-pieces). + +## Supported Browsers + +Pieces Web Extension supports most Chromium and Gecko-based browsers. + +Find their respective install pages below: + + + + + + + + + + + + + +## Installing the Pieces Web Extension + +After going to your browser's install page, you typically see an `Add to Browser` button. Clicking the button automatically opens to add the Pieces Web Extension to your browser. + + + + + To ensure you have fully installed the Pieces Web Extension, restart your browser. + + +### Setting up PiecesOS + +PiecesOS is required for the Pieces Web Extension to work. + +If you haven’t installed it yet, click the buttons to download PiecesOS via the recommended method or follow the alternative steps below. + + + +## Updating + +The Pieces Web Extension will **automatically** update when a new version is available. + + + This depends on how your browser handles extensions—most browsers automatically update extensions. + + +You can also manually update by visiting the extension's install page, uninstalling it, and then reinstalling the extension. + +## Pieces Cloud + +Disconnecting from the Pieces Cloud logs you out of your Pieces account. + + + Connecting to the Pieces Cloud is *optional*. + + However, it **provides additional features** like **data backups, shareable links, and more.** You can still enjoy the main functionalities of Pieces without an account. + + +To disconnect from the Pieces Cloud: + + + + Click the `Pieces Icon` in the extensions bar of your browser to open the Pieces Web Extension. + + + + Select the `sandwich menu` icon in the top right of the Pieces extension. This will open up the **Quick Settings** menu. + + + + + + In the new popup menu, select the `settings gear` icon. + + + + Select the `Sign Out` button at the bottom of the section. This will only say `Sign Out` if you are logged in. + + + + + +## Onboarding + +The Pieces Web Extension features an interactive walkthrough that shows you the *magic* behind the Long Term Memory (LTM-2.7) and how to get the most out of the web extension. + +### Activating LTM-2.7 + +Click `Activate LTM`, and the welcome page appears with an overview of LTM-2.7. + +You'll have the option to close the page or click `I'm In` to continue. Click `I'm In`, and the *magic* window pops up with interactive features that guide you through the process. + + + +Inside the *magic* window, click `Generate Secret Message`, and a browser window opens to display an example snippet for LTM. Y + +ou'll be prompted to paste your copied prompt—*“What was my secret message from Pieces?”*—and then click `Submit`. + + + +Once submitted, Pieces celebrates your activation, showing you that LTM-2.7 is enabled and ready to go! + +## Localhost Network Access + +With the latest Chrome v142 release, users of the Pieces Web Extension may see a pop-up on pages where the extension is active. This pop-up requests permission to access the localhost network on the user's machine. + +Local Host Popup - Chrome + +### Why are you getting this pop-up? + +The appearance of this pop-up is a result of recent Chrome security policy updates affecting how browser extensions and services request access to localhost. Because the Pieces Web Extension interacts with the locally running Pieces OS server via the localhost network, Chrome requires explicit user permission on active pages, as detailed in [this blog](https://developer.chrome.com/blog/privacy-sandbox/localhost-permission/). + +### How to resolve this? + +When this pop-up appears, simply click **Allow** to grant the Pieces Web Extension access to the localhost network for that specific site. + +To permanently allow localhost access across all sites, follow these steps: + + + + Navigate to: + + ``` + chrome://settings/content/siteDetails?site=chrome-extension://igbgibhbfonhmjlechmeefimncpekepm + ``` + + + + Scroll down until you see the **Local Network Access** permission. + + + + + + Set the permission to **Allow** to enable the Pieces Web Extension to connect to the Pieces OS via the localhost network. + + + + + +Following the steps above should remove the pop-up. By granting localhost network access, you're allowing the Pieces Web Extension to communicate with PiecesOS running on your local machine. + +This issue is currently being tracked on [our GitHub support page](https://github.com/pieces-app/support/issues/952). If you continue to encounter the pop-up after updating your permissions, please let us know through the same link. + +## Uninstalling + +To uninstall the Pieces extension in Chrome based browsers, click the three dots in the top right to open your browser menu. + +Select `More Tools > Extensions`, locate the Pieces extension, then click `Remove`. When the verification popup appears, click `Remove` again to confirm. + + + +To uninstall in Gecko/Firefox based browsers, click the settings icon (or the hamburger menu), then go to `Add-ons and Themes` and find the Pieces extension. + +Click `Remove`, and confirm when prompted. The extension will be fully removed from your browser. diff --git a/public/content/_deprecated/web-extension/shortcuts.md b/public/content/_deprecated/web-extension/shortcuts.md new file mode 100644 index 0000000..f0caec5 --- /dev/null +++ b/public/content/_deprecated/web-extension/shortcuts.md @@ -0,0 +1,32 @@ +--- +title: Pieces Web Extension Shortcuts +path: /web-extension/shortcuts +visibility: PUBLIC +status: PUBLISHED +description: Below is a table containing every shortcut for the Pieces Web Extension. +metaTitle: Pieces Web Extension Keyboard Shortcuts +metaDescription: Discover Pieces Web Extension shortcuts—copy, paste, save selections, and open the quick menu on macOS or Windows/Linux. Customize your own shortcuts in settings. +--- + + + +*** + +## Shortcut Table + +Several actions related to the Material Management ecosystem are accessible with shortcuts. + +*** + +| **Command** | **macOS** | **Windows/Linux** | +| ------------------------------ | ----------- | ----------------- | +| *Copy* | `⌘+c` | `ctrl+c` | +| *Paste* | `⌘+v` | `ctrl+v` | +| Save Selection to Pieces Drive | `⌥+shift+s` | `alt+shift+s` | +| Open Quick Menu | `⌘+o` | `ctl+o` | + +*** + + + You can set shortcuts in the [settings](/products/web-extension/configuration) for the Pieces Web Extension. + \ No newline at end of file diff --git a/public/content/_deprecated/web-extension/troubleshooting.md b/public/content/_deprecated/web-extension/troubleshooting.md new file mode 100644 index 0000000..05516ef --- /dev/null +++ b/public/content/_deprecated/web-extension/troubleshooting.md @@ -0,0 +1,59 @@ +--- +title: Troubleshooting +path: /web-extension/troubleshooting +visibility: PUBLIC +status: PUBLISHED +description: This page shows you how to fix common issues with the Pieces Web Extension and how to connect with the Pieces support team or community. +metaTitle: Troubleshoot Pieces Web Extension Issues +metaDescription: "Troubleshoot common issues with the Pieces Web Extension: verify that PiecesOS is running, refresh Copilot chats, and resolve cloud‑based LLM errors quickly." +--- + +## Having Trouble with the Pieces Web Extension? + +If you're having issues with the Pieces Web Extension, try the following quick fixes and dependency checks. + + +Starting with Chrome version 142 and later, you may need to grant the localhost network access permission to the extension to ensure it functions properly and has access to all of its features. Learn how to grant these permissions [here](/products/web-extension/get-started#localhost-network-access). + + + + +## Check PiecesOS Status + +PiecesOS, a required dependency, can cause issues with the Pieces Web Extension or other extensions and plugins if it is not installed or running. + +### Run or Restart PiecesOS + +Make sure PiecesOS is running on your device. + +To double-check that Pieces OS is running, ensure the Pieces logo is present in your toolbar (on macOS) or your taskbar (Windows/Linux). + +If it isn't there, please launch PiecesOS by double-clicking PiecesOS in your Applications folder. + +### Install PiecesOS + +For the Pieces Web Extension to run, PiecesOS is required. This dependency communicates with the Web Extension and provides context and other necessary data for on-device machine learning, cloud and local-hosted model usage, cloud connectivity, and more. + +If you need to download and install PiecesOS, [click here.](/products/core-dependencies/pieces-os/manual-installation) + +## Refreshing Copilot Chats + +If you're using the Pieces Copilot chat and disconnect from WiFi or encounter issues with a cloud-based LLM, you may need to refresh the chat. + +This can resolve issues such as the LLM appearing to "hang" (e.g., generating a response that turns out to be an infinite loop). + +To refresh the chat, click the three vertical dots at the top-right corner of your Copilot Chat window and select `Refresh`. + + + +## Missing Quick Actions Buttons + +You may be missing the Pieces Quick Actions buttons under eligible code blocks for two main reasons: + +### Disabled Buttons + +Navigate to the **Settings** view to double-check that you haven't disabled the Pieces buttons from the site in your active tab. If you enable them, the page will automatically refresh, and the buttons should appear. + +### No Detectable Code + +On specific pages, even on sites where code block elements are frequently embedded in the Document Object Model (DOM), such as Stack Overflow, there may not be eligible code blocks under which to render the Pieces Quick Action buttons. \ No newline at end of file diff --git a/public/content/cli.md b/public/content/cli.md index 8c7247d..1cb3348 100644 --- a/public/content/cli.md +++ b/public/content/cli.md @@ -10,7 +10,6 @@ metaDescription: Learn how to use Pieces CLI for seamless command-line integrati -*** ## Pieces CLI diff --git a/public/content/cli/copilot/chat.md b/public/content/cli/copilot/chat.md index a3ea4a8..6225126 100644 --- a/public/content/cli/copilot/chat.md +++ b/public/content/cli/copilot/chat.md @@ -101,47 +101,46 @@ Use a folder of specific file as context for Pieces Copilot by initiating the co ## Pieces MCP -The Pieces MCP offers several useful commands within the Pieces CLI, from setting up the MCP to learning more about it. Discover the different commands: +The Pieces CLI bridges MCP to your development tools—no manual config editing required. Run `pieces mcp setup` from your terminal to get started. ### Setup -Automatically sets up MCP for VS Code, Goose, or Cursor. +Run `pieces mcp setup` from your terminal to open an interactive menu and automatically configure Pieces MCP for your platform. - - Within the Pieces CLI, enter `mcp setup` this will open up a new MCP setup menu. + + In your terminal, run `pieces mcp setup`. - - In the new window, select one of the three options that appear: + + Use the arrow keys to select your MCP client and press Enter. Supported platforms: * VS Code - - * Goose - * Cursor + * Claude Desktop + * Windsurf + * Claude Code + * Raycast + * Warp - After selecting the environment you plan to set up Pieces MCP with, you’ll be prompted with the next set of questions. - - The new menu will have you select a workspace: - - * `User Settings` — Make the MCP available in any project you work on within VS Code. - - * `Workspace Settings` — Save the MCP locally to the current project you’re working on. - - When you select the workspace you want to set up, Pieces CLI will automatically add the configuration for you and guide you through using Pieces MCP within the platform you chose. + + The CLI writes the correct configuration for your platform. For VS Code, you'll be asked to choose *User Settings* (MCP available in all projects) or *Workspace Settings* (MCP for the current project only). Other platforms use global config files. + + Ensure PiecesOS is running and LTM is enabled. Run `pieces mcp status` to verify your setup. + + ### List The `mcp list` command displays the current implementations of Pieces MCP on your development platforms. -Currently, the Pieces CLI supports integration with [GitHub Copilot](/products/mcp/github-copilot), [Goose](/products/mcp/goose), and [Cursor](/products/mcp/cursor). +The Pieces CLI supports integration with [VS Code](/products/mcp/vs-code), [Cursor](/products/mcp/cursor), [Claude Desktop](/products/mcp/claude-desktop), [Windsurf](/products/mcp/windsurf), [Claude Code](/products/mcp/claude-code), [Raycast](/products/mcp/raycast), Warp, [GitHub Copilot](/products/mcp/github-copilot), and [Goose](/products/mcp/goose). @@ -165,34 +164,3 @@ Type `y` for yes or `n` for no, and press `return` (macOS) or `enter` (Windows/L -## Improving Code Consistency & Standardization - -The Pieces Copilot enhances code quality by identifying inconsistencies and providing practical suggestions for standardization. - -### Naming Inconsistencies - -Suppose functions across your workspace use inconsistent naming patterns (e.g., `authenticateUser` in `authHandler.go` vs. `retrieveUserProfile` in `userHandler.go`). - -In that case, Pieces Copilot can suggest adopting a standardized naming convention for better readability and maintainability, like this: - -```c -func authenticateUser(ctx context.Context, credentials Credentials) (User, error) { - if credentials.Username == "" || credentials.Password == "" { - return User{}, errors.New("missing credentials") - } -} -``` - -### Inconsistent Error Handling - -If error-handling strategies differ across files (e.g., structured errors in `authService.go` vs. inconsistent handling in `userService.go`), Pieces Copilot can help unify the approach: - -```c -func LoginUser(credentials Credentials) (string, error) { - token, err := authenticate(credentials) - if err != nil { - return "", fmt.Errorf("login failed: %w", err) - } - return token, nil -} -``` diff --git a/public/content/core-dependencies.md b/public/content/core-dependencies.md index e045aa0..3ff1c44 100644 --- a/public/content/core-dependencies.md +++ b/public/content/core-dependencies.md @@ -10,7 +10,6 @@ metaDescription: Learn about PiecesOS, the core dependency that powers the Piece -*** ## What Are Core Dependencies? diff --git a/public/content/desktop.md b/public/content/desktop.md index 604f2ce..d430e46 100644 --- a/public/content/desktop.md +++ b/public/content/desktop.md @@ -36,6 +36,10 @@ The Pieces Desktop app is designed to act as a hub for the Pieces Suite, powered With the Pieces Desktop App, you have access to dedicated views for the context captured by Long-Term Memory through [Pieces Timeline](/products/desktop/timeline). +## Activity Timeline + +A horizontal activity timeline at the bottom of the main view shows your workflow activity across the day (from 12am to 12am). Hover over any point to see a tooltip with more details—including the timestamp, memory count, and LTM status (e.g., *ON LTM-2.7*, *ON LTM Audio*) for that moment. + ## Pieces Timeline Keep track of your workflow so you can access stored context from yesterday, last week, or even last month—whenever you need it. The [Long-Term Memory (LTM-2.7)](/products/core-dependencies/pieces-os#ltm-27) Engine ensures that nothing slips through the cracks. @@ -96,7 +100,7 @@ With the Pieces MCP, you can thread rich workflow context through to [Cursor](/p *** -*Pieces MCP → Cursor* +*Pieces MCP with Cursor* diff --git a/public/content/desktop/actions/power-menu.md b/public/content/desktop/actions/power-menu.md index 972f3df..6b612fc 100644 --- a/public/content/desktop/actions/power-menu.md +++ b/public/content/desktop/actions/power-menu.md @@ -12,6 +12,15 @@ metaDescription: See a comprehensive list of actions within the Power Menu and t The **Power Menu** in Pieces is a dynamic command palette. It shows certain views as 'suggested' based on the task you're working on or sorts them by how often you use them. +### Quick Navigation + +Jump between key views by typing a few letters in the Power Menu search: + +* **Conversational Search** — Type `copilot` or `conversational` and select `Go to Conversational Search` to start chatting with your memories. +* **Timeline** — Type `workstream` or `timeline` and select `Go to Timeline` to browse your workflow summaries and activities. + +The Power Menu learns from your usage—frequently used commands appear higher, so common jumps get faster over time. + ## Dynamic View-Based Actions The **Power Menu** in Pieces is a dynamic command palette. diff --git a/public/content/desktop/configuration/long-term-memory.md b/public/content/desktop/configuration/long-term-memory.md index 5cd5a8c..34e399b 100644 --- a/public/content/desktop/configuration/long-term-memory.md +++ b/public/content/desktop/configuration/long-term-memory.md @@ -183,6 +183,16 @@ LTM Audio, also known as Audio Ingestion, enables the Long-Term Memory Engine to +### Querying Your LTM Audio Context + +Once LTM Audio is enabled and you've had meetings or conversations, you can query that audio context in [Conversational Search](/products/desktop/conversational-search) just like any other LTM data. Example queries: + +* *"What was discussed in yesterday's standup about the blockers on the API migration?"* +* *"What action items came out of yesterday's sprint planning meeting?"* +* *"Summarize the key takeaways from today's board meeting."* + +See the [LTM prompting guide](/products/quick-guides/ltm-prompting) for more query strategies. + ## Performance Optimize system resources and manage memory usage for the Long-Term Memory Engine. diff --git a/public/content/desktop/conversational-search/using-conversational-search.md b/public/content/desktop/conversational-search/using-conversational-search.md index 55fb682..811f983 100644 --- a/public/content/desktop/conversational-search/using-conversational-search.md +++ b/public/content/desktop/conversational-search/using-conversational-search.md @@ -113,6 +113,12 @@ Use Sources and Time Ranges together for precise queries—for example, "Chrome ## Working with Responses +### Ask Follow-Up About Selected Text + +Highlight any text in an AI response and click `Ask follow-up` to add it as context for your next message. The selected text appears in a context box above the chat input—type your follow-up question and send. The box can be dismissed with the `X` icon if you change your mind. + +### Response Toolbar Actions + All response actions are available in the *toolbar* below each response: * **Copy:** Click the `clipboard icon` to copy the entire response to your clipboard diff --git a/public/content/desktop/download.md b/public/content/desktop/download.md index f075658..9161c4b 100644 --- a/public/content/desktop/download.md +++ b/public/content/desktop/download.md @@ -48,7 +48,7 @@ Click the download button to install the Pieces Desktop App using the *Recommend For detailed instructions, refer to our comprehensive [Windows installation and quick-start guide.](/products/meet-pieces/windows-installation-guide) - + *Windows 10 (1809) or higher* diff --git a/public/content/desktop/single-click-summaries.md b/public/content/desktop/single-click-summaries.md index 4be08f8..70a1d3a 100644 --- a/public/content/desktop/single-click-summaries.md +++ b/public/content/desktop/single-click-summaries.md @@ -92,6 +92,37 @@ Access your completed summaries and view the full results. When a summary finish > Completed summary view showing full results with insights, related activities, and links to relevant documents +## Scheduling Summaries + +Schedule single-click summaries to run automatically at a time you choose. As long as Pieces is open and running on your computer, the summary will generate at the scheduled time and appear in your [Pieces Timeline](/products/desktop/timeline). + + + Scheduling is available for all built-in summary types except *Custom Summary*. + + + + + Hover over a summary card on the homepage and click `Schedule this summary`, or use the schedule option on the summary card. The schedule modal opens for that summary type. + + + Select **Daily** to run every day, or **Weekly** to run on specific days of the week. For weekly schedules, select one or more days (e.g., Mo, Tu, We, Th, Fr for weekdays). + + + Pick a time from the preset options (6 AM, 8 AM, 9 AM, 12 PM, 5 PM, 9 PM) or choose **Custom** to set a different time. + + + Review the summary message (e.g., "Runs weekdays at 08:00 AM") and click `Schedule` to save. The summary will run automatically at the set time whenever Pieces is open and running. + + + + + Scheduled summaries only run when Pieces is open and running on your computer. If Pieces is closed at the scheduled time, the summary will not generate. + + + + +> Schedule modal showing repeat frequency (Daily/Weekly), day selection, time options, and schedule confirmation message + ## Using Summary Types Learn how to use specific summary types and customize them for your workflow. @@ -102,6 +133,7 @@ Single-Click Summaries include preset summary types designed for common workflow | **Summary Type** | **Description** | |------------------|-----------------| +| **Today's Headlines** | Breaking news and headlines personalized to your professional world, based on your recent work context. | | **What's Top of Mind** | Identifies recurring topics and priorities from your recent workflow, ranked by importance. | | **Morning Brief** | Provides everything you need to kickstart your day, compiled from your recent activities. | | **Standup Update** | Generates a three-part update: what you did, what's next, and blockers—perfect for team standups. | @@ -114,6 +146,10 @@ Single-Click Summaries include preset summary types designed for common workflow | **Collaboration Patterns** | Identifies who you work with and how, revealing collaboration dynamics in your workflow. | | **Discover** | Access additional summary options and request new summary types through a popup interface. | +### Today's Headlines + +Takes the context of what you've been working on recently and uses *Perplexity* to find news articles and headlines related to your work. It summarizes them and delivers a bite-sized overview of what's going on in your industry—so you stay informed without leaving your workflow. + ### What's Top of Mind Identifies recurring topics and priorities from your recent workflow, ranked by importance. This summary helps you understand what's been occupying your attention and what matters most in your current work. @@ -143,13 +179,27 @@ Compiles an end-of-day summary of your accomplishments, completed tasks, and ove ### Time Breakdown -Organizes your daily work into projects with in-depth time breakdowns, showing what you worked on per project throughout the day. This summary takes all the work you've done through the day, categorizes it by project, and provides detailed time tracking for each project and activity. +Organizes your work into projects with in-depth time breakdowns, showing what you worked on per project. Time Breakdown reconstructs your billable hours from captured workstream context—categorizing activity by project and providing structured time blocks you can review, refine, and submit. +Tap `Discover More` from your Home Dashboard to find Time Breakdown. Choose a preset time range that matches your reporting needs: + +* **Last 24 Hours** — Daily timesheet submissions +* **Last 2 Days** — Catch up on a missed day +* **Last Week** — Weekly billing cycles or sprint reviews +* **Last 2 Weeks** — Bi-weekly invoicing +* **Last 30 Days** — Monthly reviews or end-of-month billing + + + Time ranges longer than 24 hours can take longer to generate—sometimes 15 minutes or more—depending on the amount of data to process. + + +Once generated, you can view, edit, copy, export, or use the Time Breakdown as context for a Pieces Copilot chat to ask follow-up questions. + ### Week Recap Provides a comprehensive overview of your week at a glance, including key activities and patterns. Get a high-level view of your weekly productivity and accomplishments. @@ -206,19 +256,24 @@ Generate summaries tailored to specific time periods and topics that matter to y - Click the **Custom Summary** card on the homepage. + Click the `Custom Summary` card on the homepage. If it's not visible, tap `Discover More` to view all single-click summary options, then select `Custom Summary`. + + + Set your scoping: choose a **Time Range** (e.g., last 24 hours, this week, last week), optionally scope to **Signals** (detected projects), **Applications** (VS Code, Chrome, Slack, etc.), or **Websites** to narrow the focus. Combine multiple dimensions for precise results. - - In the popup, choose a time range from the dropdown. Options include "Just now," "Within the last hour," "Today," or select custom dates. + + Give your summary a name, pick a color, and choose an icon. This helps you recognize it at a glance when it appears in your summary library. - - Click `Add Focus` and type in a topic, client, project, or specific area you want the summary to emphasize. This helps generate more targeted insights for particular aspects of your work. + + Tap `Save` to store your configuration as a reusable template. Once saved, your template lives alongside built-in options like Morning Brief and Day Recap—trigger it with a single click whenever you need it, with no reconfiguration. Click `Generate` to start creating your custom summary. +**Pro tip:** If you generate the same kind of summary more than twice (e.g., weekly client updates, sprint retros), save it as a template. Build it once, use it forever. + ### Using Discover Access additional summary options and request new summary types through Discover. Click the `Discover` summary card to open a popup displaying available summary options—you'll see the standard summary types plus additional options you haven't encountered yet, expanding your choices for generating insights. diff --git a/public/content/desktop/timeline/filtering-events.md b/public/content/desktop/timeline/filtering-events.md index c768a69..7442bd8 100644 --- a/public/content/desktop/timeline/filtering-events.md +++ b/public/content/desktop/timeline/filtering-events.md @@ -157,7 +157,7 @@ When viewing summaries in Timeline, you can filter by specific applications that > Hovering over a summary showing interactive application icons (Chrome, Cursor, etc.) that can be clicked to filter - Filtering by applications from summaries helps you understand which tools contributed to specific summaries and find related activities from those same applications. +The fastest way to narrow down a long Timeline is to tap a **tag** or **source** directly on a summary. Tapping a tag (e.g., project name) or source (e.g., VS Code icon) filters to only show summaries with that tag or source—helping you distill thousands of entries down to a handful of relevant ones. ## Filtering by Favorites @@ -177,7 +177,7 @@ Show only events you've marked as favorites in your Timeline. - To favorite an event, open the event's `three-dots menu` and select "Favorite." Learn more about favoriting events in [Event Actions and Menus](/products/desktop/timeline/event-actions). + To favorite an event, open the event's `three-dots menu` and select `Favorite`. Learn more about favoriting events in [Event Actions and Menus](/products/desktop/timeline/event-actions). ## Clearing Filters diff --git a/public/content/desktop/troubleshooting/linux.md b/public/content/desktop/troubleshooting/linux.md index cd1e98c..56f7d93 100644 --- a/public/content/desktop/troubleshooting/linux.md +++ b/public/content/desktop/troubleshooting/linux.md @@ -30,12 +30,16 @@ On Linux, the Pieces Desktop App is distributed via snaps (for Ubuntu-based syst To update the Pieces Desktop App on Linux: + + For best results, quit the Pieces Desktop App and PiecesOS before updating. This ensures a clean shutdown and avoids conflicts. After updating, launch PiecesOS first, then the Desktop App. + + - Running `snap info pieces-for-developers` to check the current version + Run `snap info pieces-for-developers` to check the current version. - - Running `sudo snap refresh` to apply any available updates + + Run `sudo snap refresh pieces-for-developers pieces-os` to update both. Use `sudo snap refresh` to update all snap packages. diff --git a/public/content/desktop/troubleshooting/macos.md b/public/content/desktop/troubleshooting/macos.md index 400c7a2..cc42cdf 100644 --- a/public/content/desktop/troubleshooting/macos.md +++ b/public/content/desktop/troubleshooting/macos.md @@ -21,20 +21,24 @@ You can also find information below on how to determine the CPU architecture and -## Manual Installation Methods +## Alternative Installation Methods -If you're having trouble installing PiecesOS or the Pieces Desktop App, you can manually install both software by downloading the standalone `.dmg` files or using terminal commands, instead of the recommended `.pkg` method. +If you're having trouble installing the Pieces Desktop App using the recommended `.dmg` method, you can try installing using our unified `.pkg` installers or via Homebrew. + +### via PKG + +Our `.pkg` files install both PiecesOS and the Pieces Desktop App in a single guided sequence. - If you’re not sure which `.dmg` you need based on your device’s CPU, [click here.](/products/desktop/troubleshooting/macos#checking-cpu-type) + If you’re not sure which installer you need based on your device’s CPU, [click here.](/products/desktop/troubleshooting/macos#checking-cpu-type) - + *macOS 13.0 (Ventura) or higher* - + *macOS 13.0 (Ventura) or higher* diff --git a/public/content/enterprise.md b/public/content/enterprise.md new file mode 100644 index 0000000..66b10a0 --- /dev/null +++ b/public/content/enterprise.md @@ -0,0 +1,23 @@ +--- +title: Enterprise +path: /enterprise +visibility: PUBLIC +status: PUBLISHED +description: Enterprise documentation for organizations, onboarding, and features. +metaTitle: Enterprise | Pieces Docs +metaDescription: Enterprise documentation—organizations, onboarding users, features, and admin controls. +--- + +## Enterprise + +Pieces offers enterprise-grade solutions for teams and organizations. This documentation covers organization management, user onboarding, and enterprise features. + +### In this section + +[Organizations](/products/enterprise#creating-and-joining) — Create organizations and manage members. + +[Onboarding Users](/products/enterprise/onboarding) — Step-by-step walkthrough for new team members to get set up with Pieces. Share this link directly with your team. + +[Features](/products/enterprise#enterprise-features) — Enterprise features, security, compliance, and admin controls. + +For the full Organizations & Teams documentation, see [Organizations & Teams](/products/organizations-and-teams). For enterprise pricing and custom solutions, visit [pieces.app/enterprise](https://pieces.app/enterprise). diff --git a/public/content/enterprise/features.md b/public/content/enterprise/features.md new file mode 100644 index 0000000..09d0916 --- /dev/null +++ b/public/content/enterprise/features.md @@ -0,0 +1,47 @@ +--- +title: Features +path: /enterprise/features +visibility: PUBLIC +status: PUBLISHED +description: Enterprise features and capabilities in Pieces. +metaTitle: Features | Enterprise | Pieces Docs +metaDescription: Enterprise features—admin controls, security, compliance, and team management. +--- + +## Features + +Pieces Enterprise includes features designed for teams and organizations at scale. Admin controls, security, and compliance options help you deploy Pieces across your engineering organization. + + + +> Organization Home page showing admin dashboard, management tools, and resource links + +### Enterprise Features + +* **Organizations & Teams** — Create organizations and invite members +* **Centralized Settings** — Manage models, API keys, and configuration at the org level +* **Shared Context** — Organization members can share materials, snippets, and workflow context +* **Admin Dashboard** — Overview of members, usage, and organization health + +### Security & Compliance + +* **Role-based Access** — Owners, admins, and members with appropriate permissions +* **Audit Logs** — Track changes and access for compliance +* **Data Residency** — Options for data location and retention +* **SSO** — Single Sign-On for enterprise authentication + + + For specific security and compliance requirements, contact your Pieces account team or [enterprise@pieces.app](mailto:enterprise@pieces.app). + + +### Admin Controls + +Organization owners and admins can: + +* Invite and remove members +* Manage member roles and access +* Configure billing and subscription +* Manage API keys and model settings +* Control feature access per member + +See [Organization Settings](/products/organizations-and-teams/organization-settings) for feature toggles, API keys, models, and LTM sources. For onboarding, see [Onboarding Users](/products/enterprise/onboarding). For organization structure, see [Organizations](/products/enterprise/organizations). diff --git a/public/content/enterprise/onboarding.md b/public/content/enterprise/onboarding.md new file mode 100644 index 0000000..a56ef21 --- /dev/null +++ b/public/content/enterprise/onboarding.md @@ -0,0 +1,137 @@ +--- +title: Onboarding Users +path: /enterprise/onboarding +visibility: PUBLIC +status: PUBLISHED +description: Step-by-step guide for admins to onboard their team and for members to get set up with Pieces. +metaTitle: Onboarding Users | Enterprise | Pieces Docs +metaDescription: Standalone enterprise onboarding guide—invite team members, get Pieces installed, and start collaborating. +--- + +## Onboarding Users + +This guide walks admins through getting their team set up with Pieces and walks team members through accepting their invitation and installing Pieces. Share this page directly with your team to get everyone onboarded. + +## Setting Up Your Team + +As an organization owner or admin, you'll invite team members, ensure you have enough seats, and share resources to help your team get started. + +### Creating Your Organization + +If you haven't created your organization yet, you'll need to do that first. The process involves choosing a name, selecting seats, picking a subscription plan, and completing checkout. + + + + Click your `User Profile` in the top left of Pieces Desktop, then click `Settings` and select `Account`. Scroll down to the *Organizations & Teams* section and click `+ Create an organization`. You can also start directly at [portal.pieces.app](https://portal.pieces.app). + + + Enter your organization name, choose the number of seats, and select a subscription plan (Enterprise Seat Yearly, Quarterly, or Monthly). Complete checkout to create your organization. + + + +For the full creation walkthrough, see [Creating and Joining Organizations](/products/organizations-and-teams/creating-and-joining-organizations). + +### Inviting Team Members + +Once your organization is set up, invite your team by email. Each invited member needs an available seat in your subscription. + + + + Click `Members` in the *sidebar*, then click the `Invite people` button in the top right corner. + + + Enter email addresses and select a role for each member: + * **Owner** — Full control including organization deletion + * **Admin** — Full access except organization deletion + * **Write** — Can create and edit resources + * **Read** — View-only access + + + Click `Send Invites & Finish` to send the invitations. Each member will receive an email with instructions to join. + + + + + For large teams, you can bulk invite members by uploading a CSV file with the format `email,role` (one member per line). Click the `Upload CSV` option in the invite modal. + + +### Sharing Download Links + +You can also share direct download links with your team so they can install Pieces before or after accepting their invitation: + +* **macOS** — [Download for Mac](/products/meet-pieces/macos-installation-guide) +* **Windows** — [Download for Windows](/products/meet-pieces/windows-installation-guide) +* **Linux** — [Download for Linux](/products/meet-pieces/linux-installation-guide) + +Alternatively, team members can download Pieces directly from the organization's Home page in the Pieces portal after they accept their invitation. + +### Managing Seats + +Make sure you have enough seats for your team before sending invitations. You can view current seat usage on the `Members` page and add seats from the `Billing` page. See [Billing](/products/organizations-and-teams/billing) for details on adjusting seat counts. + +## For Team Members: Getting Started + +If you've received an invitation to join a Pieces organization, follow these steps to get set up. + +### Accepting Your Invitation + + + + You'll receive an email invitation from your organization's admin. The email includes details about the organization and your assigned role. + + + Click the link in the email to accept. You'll be taken to the Pieces portal to sign in or create an account. + + + If you don't already have a Pieces account, create one using the email address the invitation was sent to. If you already have an account, sign in with your existing credentials. + + + +### Installing Pieces + +After accepting your invitation, you'll land on your organization's Home page in the Pieces portal. The *Setup* section at the top provides everything you need to get Pieces installed. + + + +> Organization Home page showing Setup section with download links and sign-in instructions + + + + If Pieces is already installed, click `Open Pieces Desktop` to launch it. If not, click `Download for Mac` (or your platform) to download the installer. Links for Windows and Linux are also available under *Other platforms*. + + + Run the downloaded installer, which sets up both Pieces Desktop and PiecesOS (the background service that powers Pieces). Follow the on-screen prompts to complete installation. + + + After installation, sign in to Pieces Desktop and PiecesOS with the same email address associated with your organization. The Home page will remind you which email to use — look for the message that says "Sign in with [your-email] in Desktop & PiecesOS to stay in sync." + + + + + Signing in with your organization email ensures your settings, models, API keys, and features configured by your admin automatically sync to your installation. + + +### Exploring Resources + +The *Resources* section on the Home page provides quick links to help you get the most out of Pieces: + +* **Documentation** — Guides and API reference at [docs.pieces.app](https://docs.pieces.app) +* **Pro tip guides** — Tips and best practices for using Pieces effectively +* **Support** — Get help and contact the Pieces team +* **GitHub** — Explore repos and open source projects + +## SSO & Provisioning + +Enterprise plans support Single Sign-On (SSO) and SCIM user provisioning for streamlined onboarding. SSO lets users sign in with your identity provider, and SCIM provisioning automates user lifecycle management. + +Admins can configure SSO by adding a *Descope* Tenant ID in [General Settings](/products/organizations-and-teams/settings-general). For Associated Domains, add your company's email domain to enable automatic user assignment. + + + For help setting up SSO or SCIM provisioning, contact [sales@pieces.app](mailto:sales@pieces.app). + + +*** + +## Next Steps + +Once your team is set up, explore [Organization Settings](/products/organizations-and-teams/organization-settings) to configure features, API keys, models, and LTM sources for your entire team, or see [Features](/products/enterprise/features) for a full overview of enterprise capabilities. diff --git a/public/content/enterprise/organizations.md b/public/content/enterprise/organizations.md new file mode 100644 index 0000000..52da22f --- /dev/null +++ b/public/content/enterprise/organizations.md @@ -0,0 +1,55 @@ +--- +title: Organizations +path: /enterprise/organizations +visibility: PUBLIC +status: PUBLISHED +description: Create and manage organizations for your enterprise team in Pieces. +metaTitle: Organizations | Enterprise | Pieces Docs +metaDescription: Enterprise organization management—creating organizations and managing members. +--- + +## Organizations + +Organizations in Pieces let you collaborate at scale. Create organizations, invite team members, and maintain consistent settings across your enterprise. + +### Creating Organizations + +Create a new organization to start collaborating with your team. Organization owners have full control over team settings, member access, and shared resources. + + + + Click your `User Profile` in the top left, then click `Settings` and select `Account`. Scroll down to the *Organizations & Teams* section and click the `+ Create an organization` button. + + + Enter your organization name in the provided field. Choose a name that clearly identifies your team or company. + + + Select the number of seats using the `+` and `-` buttons. Choose your subscription plan (Enterprise Seat Yearly, Quarterly, or Monthly). + + + Click `Checkout` to proceed. Complete payment through *Paddle*. After payment, you can invite team members or skip for later. + + + +### Managing Members + +As an organization owner or admin, you can invite members, assign roles, and manage access. Each role has different permissions: + +* **Owner** — Full control including organization deletion +* **Admin** — Full access except organization deletion +* **Write** — Can create and edit resources +* **Read** — View-only access + + + + Click `Members` in the *sidebar*, then click the `Invite people` button in the top right. + + + Enter the email address and select a role from the `Select a role...` dropdown. You can add multiple members or bulk upload via CSV. + + + Click `Send Invites & Finish` to send the invitation. Members receive an email with instructions to join. + + + +For billing and settings, see [Managing Organizations](/products/organizations-and-teams/managing-organizations) or [Onboarding Users](/products/enterprise/onboarding). diff --git a/public/content/extensions-plugins/visual-studio-code/configuration.md b/public/content/extensions-plugins/visual-studio-code/configuration.md index 3c64517..db11824 100644 --- a/public/content/extensions-plugins/visual-studio-code/configuration.md +++ b/public/content/extensions-plugins/visual-studio-code/configuration.md @@ -61,13 +61,13 @@ If both machines are on the same LAN: If machines are **not** on the same LAN: -1. Install ngrok or Tailscale on the machine with Pieces OS. +1. Install ngrok or Tailscale on the machine with Pieces OS. See [ngrok Setup](/products/mcp/ngrok-setup) for MCP-specific setup. 2. Run: `ngrok http 39300` 3. Copy the public forwarding URL. -4. In VS Code, set it as the `Pieces: Custom URL` (see steps above). +4. In VS Code, set the public forwarding URL you copied as the `Pieces: Custom URL`. 5. Reload the VS Code window. diff --git a/public/content/large-language-models.md b/public/content/large-language-models.md index e08f571..1f0b884 100644 --- a/public/content/large-language-models.md +++ b/public/content/large-language-models.md @@ -11,8 +11,6 @@ ogImage: "https://storage.googleapis.com/hashnode_product_documentation_assets/o -*** - ## Compatible AI Models with Pieces diff --git a/public/content/mcp/amazon-q-developer.md b/public/content/mcp/amazon-q-developer.md new file mode 100644 index 0000000..4d4152b --- /dev/null +++ b/public/content/mcp/amazon-q-developer.md @@ -0,0 +1,117 @@ +--- +title: Pieces MCP + Amazon Q Developer Integration +path: /mcp/amazon-q-developer +visibility: PUBLIC +status: PUBLISHED +description: The Pieces MCP integration with Amazon Q Developer lets you use Pieces Long-Term Memory in the Amazon Q CLI and IDE plugin for enhanced, context-aware productivity. +metaTitle: Integrate Pieces Model Context Protocol (MCP) with Amazon Q Developer +metaDescription: Learn how to integrate Pieces MCP with Amazon Q Developer. Access Long-Term Memory in CLI and IDE for enhanced productivity. +--- + + + +*** + +## Get Started + +Integrating the [Pieces MCP](/products/mcp/get-started) with Amazon Q Developer brings your workflow context directly into AWS's AI assistant, available both as a CLI and an IDE plugin. You can ask Q about past implementations, similar code, and historical debugging context. + +## Prerequisites + +There are **two** prerequisites for integrating Pieces with Amazon Q as an MCP—an active instance of **PiecesOS** and the fully-enabled **Long-Term Memory** engine. + + + + Make sure that PiecesOS is installed and running. This is *required* for the MCP server to communicate with your workflow data. + + + + Enable the Long-Term Memory Engine (LTM-2.7) through the Pieces Desktop App or the [PiecesOS Quick Menu](/products/core-dependencies/pieces-os/quick-menu) in your toolbar. + + + +### Installing PiecesOS & Configuring Permissions + +Follow the instructions below for a detailed guide on setting up and configuring PiecesOS to correctly pass captured workflow context to the Pieces MCP server. + + + +## Setting Up Amazon Q Developer + +Amazon Q supports both IDE plugin and CLI configurations. The IDE uses `~/.aws/amazonq/default.json` (or the legacy `mcp.json`). Workspace settings take precedence over global settings. + +### IDE Plugin Setup (Local) + +Edit `~/.aws/amazonq/default.json`: + +```json +{ + "servers": { + "pieces": { + "type": "http", + "url": "http://localhost:39300/model_context_protocol/2025-03-26/mcp", + "timeout": 60 + } + } +} +``` + +### CLI Setup + +Configure the MCP server in the CLI: + +```bash +q mcp add --name pieces --type http --url http://localhost:39300/model_context_protocol/2025-03-26/mcp +``` + +### Tool Permissions + +Amazon Q allows per-tool permission levels. You can configure these in the IDE settings UI after adding the server: + +* **Ask** — prompts before each use +* **Always allow** — runs without prompting +* **Deny** — blocked entirely + +## Using Pieces MCP Server in Amazon Q + +Once integrated, you can utilize [Pieces LTM](/products/core-dependencies/pieces-os#ltm-27) directly in Amazon Q. + + + + Start Amazon Q (CLI or IDE). + + + + MCP servers load in the background; tools become available progressively. + + + + Ask Q: *"What Pieces tools are available?"* or *"What was I working on yesterday?"* + + + + + Check out this [MCP-specific prompting guide](/products/mcp/prompting) if you want to effectively utilize the Long-Term Memory Engine (LTM-2.7) with your new Pieces MCP server. + + +## Updating + +Edit `~/.aws/amazonq/default.json`, update the `url`, and restart Amazon Q or start a new session. + +## Troubleshooting + +If you're experiencing issues integrating Pieces MCP with Amazon Q Developer: + +1. **Verify PiecesOS Status**: Ensure [PiecesOS is actively running](/products/core-dependencies/pieces-os/troubleshooting) on your system. + +2. **Config Directory Doesn't Exist**: Create `~/.aws/amazonq/` manually. + +3. **Legacy vs Current Config**: Both `default.json` and `mcp.json` are supported; `default.json` takes precedence. + +4. **MCP Not Loading**: Ensure you have a recent version of Amazon Q Developer. + +5. **OAuth Prompt**: Pieces does not require OAuth. Use no-auth configuration. + +*** + +You're now set to enhance your Amazon Q Developer workflow with powerful context retrieval through Pieces MCP. Happy coding! diff --git a/public/content/mcp/chatgpt-developer-mode.md b/public/content/mcp/chatgpt-developer-mode.md new file mode 100644 index 0000000..b388972 --- /dev/null +++ b/public/content/mcp/chatgpt-developer-mode.md @@ -0,0 +1,146 @@ +--- +title: Pieces MCP + ChatGPT Developer Mode Integration +path: /mcp/chatgpt-developer-mode +visibility: PUBLIC +status: PUBLISHED +description: The Pieces MCP integration with ChatGPT Developer Mode lets you use Pieces Long-Term Memory in ChatGPT via the Connectors UI. Requires a remote HTTPS URL—localhost will not work. +metaTitle: Integrate Pieces Model Context Protocol (MCP) with ChatGPT Developer Mode +metaDescription: Learn how to integrate Pieces MCP with ChatGPT Developer Mode. Requires ngrok or HTTPS proxy—ChatGPT needs a remote URL. Pro/Plus/Business/Enterprise/Education plans. +--- + + + +*** + +## Get Started + +Integrating the [Pieces MCP](/products/mcp/get-started) with ChatGPT Developer Mode brings your workflow context directly into ChatGPT in your browser. ChatGPT Developer Mode requires a **remote HTTPS URL**—localhost will not work. You must expose PiecesOS via [ngrok](/products/mcp/ngrok-setup) or another HTTPS proxy first. + + + **Remote HTTPS required:** ChatGPT Developer Mode cannot use localhost. You must expose PiecesOS via ngrok or another HTTPS tunnel before adding the connector. + + + + **Plans required:** ChatGPT Developer Mode is available on Pro, Plus, Business, Enterprise, and Education plans. Status: Beta. + + +## Prerequisites + +There are **three** prerequisites for integrating Pieces with ChatGPT Developer Mode: + + + + Ensure you have a Pro, Plus, Business, Enterprise, or Education ChatGPT plan. + + + + PiecesOS must be running locally. This is *required* for the MCP server to provide your workflow data. + + + + Expose PiecesOS via an ngrok tunnel to get a public HTTPS URL. The tunnel must be active when you add the connector and when you use ChatGPT. See [ngrok Setup](/products/mcp/ngrok-setup) for detailed instructions. + + + +### Installing PiecesOS & Configuring Permissions + +Follow the instructions below for a detailed guide on setting up and configuring PiecesOS to correctly pass captured workflow context to the Pieces MCP server. + + + +## Setting Up ChatGPT Developer Mode + +ChatGPT uses a Connectors UI to add MCP servers. You cannot add localhost URLs—only remote HTTPS endpoints. + +### Setup Steps + + + + Open [chatgpt.com](https://chatgpt.com) in your browser. + + + + Click your **profile icon** → **Settings**. + + + + Go to **Connectors** in the sidebar. + + + + Scroll to the bottom and click `Advanced Settings`. Toggle `Developer Mode (beta)` ON. + + + + Return to **Connectors** and click `Create` (appears after enabling Developer Mode). + + + + * **Connector name:** `Pieces LTM` + * **MCP Server URL:** `https://YOUR_NGROK_URL.ngrok-free.app/model_context_protocol/2025-03-26/mcp` + * **Description:** (optional) `Search and retrieve from Pieces Long-Term Memory` + + + + Click `Create` to save the connector. + + + + + The URL must point to the `/mcp` endpoint path. Subdirectory paths like `/functions/v1/mcp` do not work. + + +## Using Pieces MCP Server in ChatGPT + +Once integrated, you can utilize [Pieces LTM](/products/core-dependencies/pieces-os#ltm-27) directly in ChatGPT. + + + + Start a new conversation in ChatGPT. + + + + Look for the **tools indicator** in the chat. + + + + Ask: *"What tools do you have from Pieces?"* + + + + Try: *"What did I work on yesterday?"* ChatGPT will use the `ask_pieces_ltm` tool to query your Long-Term Memory. + + + + + Check out this [MCP-specific prompting guide](/products/mcp/prompting) if you want to effectively utilize the Long-Term Memory Engine (LTM-2.7) with your new Pieces MCP server. + + +## Updating + +To update the ngrok URL after a tunnel restart: + +1. Go to **Settings > Connectors** +2. Find "Pieces LTM" and click `Edit` +3. Update the MCP Server URL +4. Save + +## Troubleshooting + +If you're experiencing issues integrating Pieces MCP with ChatGPT Developer Mode: + +1. **Cannot Use localhost**: ChatGPT requires public HTTPS. Use ngrok or another HTTPS proxy. + +2. **Connector Not Connecting**: Ensure the ngrok tunnel is running and the URL is accessible in a browser. + +3. **Authentication Required**: Use no-auth mode; Pieces does not need OAuth. + +4. **Tools Not Appearing**: Refresh the page after adding the connector. + +5. **Developer Mode Not Visible**: Ensure you are on a supported plan (Pro/Plus/Business/Enterprise/Education). + +6. **Write Actions Need Confirmation**: By default, writes require manual approval in ChatGPT. + +*** + +You're now set to enhance your ChatGPT workflow with powerful context retrieval through Pieces MCP. Happy coding! diff --git a/public/content/mcp/claude-code.md b/public/content/mcp/claude-code.md new file mode 100644 index 0000000..bba2857 --- /dev/null +++ b/public/content/mcp/claude-code.md @@ -0,0 +1,147 @@ +--- +title: Pieces MCP + Claude Code Integration +path: /mcp/claude-code +visibility: PUBLIC +status: PUBLISHED +description: The Pieces MCP integration with Claude Code lets you use Pieces Long-Term Memory in the Claude Code CLI and VS Code extension via simple CLI commands. +metaTitle: Integrate Pieces Model Context Protocol (MCP) with Claude Code +metaDescription: Learn how to integrate Pieces MCP with Claude Code. Use the CLI to add Pieces LTM—automatically available in the VS Code extension. +--- + + + +*** + +## Get Started + +Integrating the [Pieces MCP](/products/mcp/get-started) with Claude Code brings your workflow context directly into the Claude Code CLI and VS Code extension. Claude Code is Anthropic's developer-focused AI tool for coding tasks. Setup is simple: add Pieces via the CLI, and it's automatically available in the extension. + +## Prerequisites + +There are **two** prerequisites for integrating Pieces with Claude Code as an MCP—an active instance of **PiecesOS** and the fully-enabled **Long-Term Memory** engine. + + + + Make sure that PiecesOS is installed and running. This is *required* for the MCP server to communicate with your workflow data. + + + + Enable the Long-Term Memory Engine (LTM-2.7) through the Pieces Desktop App or the [PiecesOS Quick Menu](/products/core-dependencies/pieces-os/quick-menu) in your toolbar. + + + +### Installing PiecesOS & Configuring Permissions + +Follow the instructions below for a detailed guide on setting up and configuring PiecesOS to correctly pass captured workflow context to the Pieces MCP server. + + + +## Setting Up Claude Code + +There are two ways to set up Pieces MCP for Claude Code: use the Pieces CLI for automatic configuration, or add the server manually via the Claude CLI. + +### Method 1: CLI Install (Recommended) + +The Pieces CLI can automatically configure Pieces MCP for Claude Code—no manual config editing required. + + + + Install the [Pieces CLI](/products/cli/get-started) if you haven't already. + + + In your terminal, run: + + ```bash + pieces mcp setup + ``` + + + A platform selection menu appears with options: *VS Code*, *Cursor*, *Claude Desktop*, *Windsurf*, *Claude Code*, *Raycast*, and *Warp*. Use the arrow keys to navigate to *Claude Code*, then press `return` (macOS) or `enter` (Windows/Linux) to auto-install. + + + +### Method 2: Manual Setup via Claude CLI + +Claude Code supports adding MCP servers via the CLI. Servers added via `claude mcp add` are automatically available in the Claude Code VS Code extension—no additional setup needed. + +### Local Setup (Streamable HTTP — recommended) + +Run in your terminal: + +```bash +claude mcp add --transport http pieces http://localhost:39300/model_context_protocol/2025-03-26/mcp +``` + +### Local Setup (SSE) + +```bash +claude mcp add --transport sse pieces http://localhost:39300/model_context_protocol/2024-11-05/sse +``` + +### Project-Scoped Setup + +To make Pieces MCP available only for the current project (stored in `.mcp.json` at project root): + +```bash +claude mcp add --transport http --scope project pieces http://localhost:39300/model_context_protocol/2025-03-26/mcp +``` + +### Managing Servers + +```bash +# List all configured servers +claude mcp list + +# Remove a server +claude mcp remove pieces + +# Show server details +claude mcp get pieces +``` + +## Using Pieces MCP Server in Claude Code + +Once integrated, you can utilize [Pieces LTM](/products/core-dependencies/pieces-os#ltm-27) directly in Claude Code. + + + + Run `claude` in your terminal, or open a project in the Claude Code VS Code extension. + + + + Ask: *"What MCP tools do you have from Pieces?"* Pieces LTM tools should be listed. + + + + Ask context-rich questions about your workflow. For example: *"What patterns did I use in my last React component?"* or *"Show me the authentication flow I implemented yesterday."* + + + + + Check out this [MCP-specific prompting guide](/products/mcp/prompting) if you want to effectively utilize the Long-Term Memory Engine (LTM-2.7) with your new Pieces MCP server. + + +## Updating + +To update the URL, remove and re-add the server: + +```bash +claude mcp remove pieces +claude mcp add --transport http pieces https://NEW_URL/model_context_protocol/2025-03-26/mcp +``` + +## Troubleshooting + +If you're experiencing issues integrating Pieces MCP with Claude Code: + +1. **Verify PiecesOS Status**: Ensure [PiecesOS is actively running](/products/core-dependencies/pieces-os/troubleshooting) on your system. Test with: `curl http://localhost:39300/.well-known/version` + +2. **Transport Error**: Try switching between `--transport http` and `--transport sse`. + +3. **VS Code Extension Not Seeing Tools**: Restart VS Code after adding via CLI. + +4. **Config Location**: User scope uses `~/.claude.json`; project scope uses `.mcp.json` at project root. + +*** + +You're now set to enhance your Claude Code workflow with powerful context retrieval through Pieces MCP. Happy coding! diff --git a/public/content/mcp/claude-cowork.md b/public/content/mcp/claude-cowork.md new file mode 100644 index 0000000..9264d15 --- /dev/null +++ b/public/content/mcp/claude-cowork.md @@ -0,0 +1,145 @@ +--- +title: Pieces MCP + Claude Cowork Integration +path: /mcp/claude-cowork +visibility: PUBLIC +status: PUBLISHED +description: The Pieces MCP integration with Claude Cowork lets you use Pieces Long-Term Memory in Anthropic's autonomous task automation agent. Cowork shares Claude Desktop's MCP configuration. +metaTitle: Integrate Pieces Model Context Protocol (MCP) with Claude Cowork +metaDescription: Learn how to integrate Pieces MCP with Claude Cowork. Use the same config as Claude Desktop. Pro/Max/Team/Enterprise plans. Research preview. +--- + + + +*** + +## Get Started + +Integrating the [Pieces MCP](/products/mcp/get-started) with Claude Cowork brings your workflow context directly into Anthropic's autonomous task automation agent. Claude Cowork is a general-purpose task automation agent that runs within Claude Desktop—it reads, writes, and organizes files, executes multi-step tasks, and works across your filesystem. + +With Pieces MCP connected, Cowork can use your Long-Term Memory as context while executing tasks—like generating standups from yesterday's work or creating summary documents from your captured workflow data. + + + **Plans required:** Claude Cowork requires Pro, Max, Team, or Enterprise subscription. **Status:** Research preview (launched January 2026, Windows added February 2026). + + +## Prerequisites + + + + Claude Cowork runs inside Claude Desktop. Install Claude Desktop first. + + + + Ensure you have Pro, Max, Team, or Enterprise subscription. + + + + PiecesOS must be installed and running. Enable the Long-Term Memory Engine (LTM-2.7) through the Pieces Desktop App or the [PiecesOS Quick Menu](/products/core-dependencies/pieces-os/quick-menu). + + + +### Installing PiecesOS & Configuring Permissions + +Follow the instructions below for a detailed guide on setting up and configuring PiecesOS to correctly pass captured workflow context to the Pieces MCP server. + + + +## Connecting Pieces MCP to Claude Cowork + +Cowork uses the **same MCP configuration as Claude Desktop**. You have two options: + +### Option 1: Via Connectors UI (Pro/Max/Team/Enterprise, for remote URLs) + +For remote access, you need a public HTTPS URL. Set up [ngrok](/products/mcp/ngrok-setup) or another tunnel first. + + + + Open Claude Desktop. + + + + Go to **Settings > Connectors**. + + + + Click `Add custom connector` and enter your ngrok URL: + ```plaintext + https://YOUR_NGROK_URL.ngrok-free.app/model_context_protocol/2025-03-26/mcp + ``` + + + + Save and restart Claude Desktop. + + + +### Option 2: Via JSON Config with stdio Bridge (recommended for local use) + + + **Recommended when PiecesOS and Claude Desktop are on the same machine.** Uses the localhost URL via an mcp-remote bridge. + + +Install `mcp-remote` globally with a pinned version for security: + +```bash +npm install -g mcp-remote@0.1.38 +``` + +Edit `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS) or `%APPDATA%\Claude\claude_desktop_config.json` (Windows): + +```json +{ + "mcpServers": { + "pieces": { + "command": "mcp-remote", + "args": [ + "http://localhost:39300/model_context_protocol/2024-11-05/sse" + ] + } + } +} +``` + +See the [Claude Desktop guide](/products/mcp/claude-desktop) and [MCP Bridge](/products/mcp/mcp-remote) for full details. + +## Using Pieces Tools in Claude Cowork + +Once connected, start a Cowork session and Pieces LTM tools are available alongside file system access. + +**Example tasks:** + +* *"Use my Pieces Long-Term Memory to find what I worked on yesterday and write a standup to `~/Desktop/standup.md`"* +* *"Search my Pieces memory for everything I've captured about the authentication redesign and create a summary document in my project folder"* +* *"Use my Pieces audio transcriptions from today's meetings and create a meeting notes file with key decisions and action items"* + +## Key Differences from Claude Chat + +| Feature | Claude Chat | Claude Cowork | +|---------|-------------|---------------| +| File access | No | Yes (designated folder) | +| Task parallelism | No | Yes (sub-agents) | +| Autonomous execution | No | Yes | +| MCP tools | Yes | Yes | +| Session continuity | Per-conversation | Per-task (no cross-session memory) | + +## Verification + +1. Open Claude Desktop and start a Cowork session (look for the folder/file access UI). +2. Ask: *"What Pieces tools are available?"* +3. Give a multi-step task: *"Search my Pieces memory for my recent work on [project name] and write a status update to my Desktop"* + +## Troubleshooting + +If you're experiencing issues integrating Pieces MCP with Claude Cowork: + +1. **Cowork Option Not Visible**: Ensure you have Pro/Max/Team/Enterprise plan. + +2. **Pieces Tools Not Appearing**: Restart Claude Desktop after config changes. + +3. **MCP Tools Unavailable**: Confirm the Pieces server is configured in Claude Desktop—Cowork shares Desktop's config. + +4. **Windows Not Available**: Windows support was added February 10, 2026—update Claude Desktop. + +*** + +You're now set to enhance your Claude Cowork workflow with powerful context retrieval through Pieces MCP. Happy coding! diff --git a/public/content/mcp/claude-desktop.md b/public/content/mcp/claude-desktop.md index 9188a21..96be707 100644 --- a/public/content/mcp/claude-desktop.md +++ b/public/content/mcp/claude-desktop.md @@ -109,13 +109,13 @@ This method involves editing Claude Desktop’s MCP configuration file to point - Paste the following JSON, adjusting the path to your `pieces.exe` if different: + Paste the following JSON into your Claude config file, adjusting the path to your `pieces` executable for your OS: - ```powershell - jsonCopyEdit{ + ```json + { "mcpServers": { - "Pieces": { - "command": "C:\\Users\\\\AppData\\Local\\Programs\\Python\\Python313\\Scripts\\pieces.exe", + "pieces": { + "command": "/Users//venv/bin/pieces", "args": [ "--ignore-onboarding", "mcp", @@ -125,6 +125,10 @@ This method involves editing Claude Desktop’s MCP configuration file to point } } ``` + + **Path examples by OS:** + * **macOS/Linux** — `/Users//venv/bin/pieces` or `~/.local/bin/pieces` + * **Windows** — `C:\Users\\AppData\Local\Programs\Python\Python3XX\Scripts\pieces.exe` @@ -158,16 +162,10 @@ This method uses the Pieces CLI to automatically set up and configure Pieces MCP Run: ```powershell - pieces mcp setup --claude + pieces mcp setup ``` - This will: - - * Detect your Claude Desktop MCP config location. - - * Insert the correct `mcpServers` entry for Pieces. - - * Point Claude directly to the MCP server without requiring manual JSON edits. + A platform selection menu appears with these options: *VS Code*, *Cursor*, *Claude Desktop*, *Windsurf*, *Claude Code*, *Raycast*, and *Warp*. Use the arrow keys to navigate, hover over *Claude Desktop* or *Claude Code*, then press `return` (macOS) or `enter` (Windows/Linux) to auto-install the MCP. @@ -190,7 +188,7 @@ Configure Pieces MCP for Claude Code to make it available across all your projec In your terminal, run the following command: ```bash - claude mcp add --scope user PiecesMCP --transport sse http://localhost:39300/model_context_protocol/2025-03-26/mcp + claude mcp add --scope user pieces --transport http http://localhost:39300/model_context_protocol/2025-03-26/mcp ``` The `--scope user` flag makes Pieces MCP available globally across all your Claude Code projects, rather than just the current directory. @@ -233,7 +231,7 @@ If you're experiencing issues integrating [Pieces MCP](/products/mcp/get-started Ensure PiecesOS is actively running on your system. 2. **Confirm LTM Engine Activation**\ - [Long-Term Memory (LTM-2.7)](/products/core-dependencies/pieces-os/quick-menu#ltm-27-engine) must be enabled in PiecesOS. + [Long-Term Memory (LTM-2.7)](/products/core-dependencies/pieces-os/quick-menu#ltm-2-engine) must be enabled in PiecesOS. 3. **Single MCP Instance**\ Avoid running multiple Pieces MCP instances in different apps simultaneously. @@ -246,7 +244,7 @@ If you're experiencing issues integrating [Pieces MCP](/products/mcp/get-started If using *Method 2*, rerun: ```powershell - pieces mcp setup --claude + pieces mcp setup ``` *** diff --git a/public/content/mcp/cline.md b/public/content/mcp/cline.md new file mode 100644 index 0000000..991f14f --- /dev/null +++ b/public/content/mcp/cline.md @@ -0,0 +1,149 @@ +--- +title: Pieces MCP + Cline Integration +path: /mcp/cline +visibility: PUBLIC +status: PUBLISHED +description: The Pieces MCP integration with Cline lets you use Pieces Long-Term Memory in VS Code via the Cline extension, an AI coding agent that supports MCP. +metaTitle: Integrate Pieces Model Context Protocol (MCP) with Cline +metaDescription: Learn how to integrate Pieces MCP with Cline. Use SSE transport for reliable connection—Streamable HTTP has known compatibility issues. +--- + + + +*** + +## Get Started + +Integrating the [Pieces MCP](/products/mcp/get-started) with Cline brings your workflow context directly into VS Code. Cline is an AI coding agent extension that maintains its own MCP configuration—it does **not** read from `.vscode/mcp.json`. + + + **Use SSE, not Streamable HTTP:** Cline has known compatibility issues with Streamable HTTP transport. Use the **SSE endpoint** for the most reliable connection. + + +## Prerequisites + +There are **two** prerequisites for integrating Pieces with Cline as an MCP—an active instance of **PiecesOS** and the fully-enabled **Long-Term Memory** engine. + + + + Make sure that PiecesOS is installed and running. This is *required* for the MCP server to communicate with your workflow data. + + + + Enable the Long-Term Memory Engine (LTM-2.7) through the Pieces Desktop App or the [PiecesOS Quick Menu](/products/core-dependencies/pieces-os/quick-menu) in your toolbar. + + + +### Installing PiecesOS & Configuring Permissions + +Follow the instructions below for a detailed guide on setting up and configuring PiecesOS to correctly pass captured workflow context to the Pieces MCP server. + + + +## Setting Up Cline + +Cline stores its MCP configuration in a separate file: `~/.cline/data/settings/cline_mcp_settings.json`. + +### Setup via Extension UI + + + + Open VS Code with the Cline extension installed. + + + + Click the `Cline` icon in the activity bar, then click the `gear icon` or navigate to **MCP Servers** in the Cline panel. + + + + Click `Add Server`, select **SSE** as the transport type, and enter: + ```plaintext + http://localhost:39300/model_context_protocol/2024-11-05/sse + ``` + + + + Name it `pieces` and save. + + + +### Manual JSON Config + +Edit `~/.cline/data/settings/cline_mcp_settings.json`: + +```json +{ + "mcpServers": { + "pieces": { + "url": "http://localhost:39300/model_context_protocol/2024-11-05/sse", + "type": "sse", + "disabled": false, + "autoApprove": [] + } + } +} +``` + +### Auto-Approve Specific Tools + +To skip confirmation prompts for specific Pieces tools: + +```json +{ + "mcpServers": { + "pieces": { + "url": "http://localhost:39300/model_context_protocol/2024-11-05/sse", + "type": "sse", + "autoApprove": ["ask_pieces_ltm", "workstream_summaries_full_text_search"] + } + } +} +``` + +## Using Pieces MCP Server in Cline + +Once integrated, you can utilize [Pieces LTM](/products/core-dependencies/pieces-os#ltm-27) directly in Cline. + + + + Open the Cline panel in VS Code. + + + + Check the **MCP** section for `pieces` with a connected status. + + + + Ensure Cline is in agent mode (not regular chat mode) so it can use MCP tools. + + + + Ask Cline to search your LTM. For example: *"What was I working on yesterday?"* + + + + + Check out this [MCP-specific prompting guide](/products/mcp/prompting) if you want to effectively utilize the Long-Term Memory Engine (LTM-2.7) with your new Pieces MCP server. + + +## Updating + +Edit the config JSON and save. Cline reloads the server list from disk without requiring a VS Code restart. + +## Troubleshooting + +If you're experiencing issues integrating Pieces MCP with Cline: + +1. **Verify PiecesOS Status**: Ensure [PiecesOS is actively running](/products/core-dependencies/pieces-os/troubleshooting) on your system. + +2. **Cline Uses Its Own Config**: Cline reads from `~/.cline/data/settings/cline_mcp_settings.json`, not `.vscode/mcp.json`. + +3. **Use SSE, Not Streamable HTTP**: Cline has compatibility issues with Streamable HTTP—use the SSE endpoint (`/model_context_protocol/2024-11-05/sse`). + +4. **Use Agent Mode**: Ensure Cline is in agent mode, not regular chat mode. + +5. **Server Disconnected**: Restart VS Code if the server shows as disconnected. + +*** + +You're now set to enhance your Cline workflow with powerful context retrieval through Pieces MCP. Happy coding! diff --git a/public/content/mcp/continue-dev.md b/public/content/mcp/continue-dev.md new file mode 100644 index 0000000..fa28901 --- /dev/null +++ b/public/content/mcp/continue-dev.md @@ -0,0 +1,120 @@ +--- +title: Pieces MCP + Continue.dev Integration +path: /mcp/continue-dev +visibility: PUBLIC +status: PUBLISHED +description: The Pieces MCP integration with Continue.dev lets you use Pieces Long-Term Memory directly in VS Code or JetBrains IDEs via the open-source Continue.dev extension, in agent mode. +metaTitle: Integrate Pieces Model Context Protocol (MCP) with Continue.dev +metaDescription: Learn how to integrate Pieces MCP with Continue.dev. Access Long-Term Memory in agent mode for enhanced, context-aware productivity. +--- + + + +*** + +## Get Started + +Integrating the [Pieces MCP](/products/mcp/get-started) with Continue.dev brings your workflow context directly into your editor. Continue.dev is an open-source coding assistant available as a VS Code or JetBrains extension. + + + **Agent mode required:** MCP servers in Continue.dev only work in **agent mode**. They are not available in regular chat or plan modes. + + +## Prerequisites + +There are **two** prerequisites for integrating Pieces with Continue.dev as an MCP—an active instance of **PiecesOS** and the fully-enabled **Long-Term Memory** engine. + + + + Make sure that PiecesOS is installed and running. This is *required* for the MCP server to communicate with your workflow data. + + + + Enable the Long-Term Memory Engine (LTM-2.7) through the Pieces Desktop App or the [PiecesOS Quick Menu](/products/core-dependencies/pieces-os/quick-menu) in your toolbar. + + + +### Installing PiecesOS & Configuring Permissions + +Follow the instructions below for a detailed guide on setting up and configuring PiecesOS to correctly pass captured workflow context to the Pieces MCP server. + + + +## Setting Up Continue.dev + +Continue.dev uses **YAML** configuration with an `mcpServers` array. The recommended location is `.continue/config.yaml` at your project root (you can commit it to version control for team sharing). + +### Config File Location + +| Scope | Path | +|-------|------| +| **Workspace (recommended)** | `.continue/config.yaml` at project root | +| **Alternative JSON** | `.continue/mcpServers/mcp.json` | + +### Local Setup (Streamable HTTP — recommended) + +Create or edit `.continue/config.yaml`: + +```yaml +mcpServers: + - name: Pieces LTM + type: streamable-http + url: http://localhost:39300/model_context_protocol/2025-03-26/mcp +``` + +### Local Setup (SSE) + +```yaml +mcpServers: + - name: Pieces LTM + type: sse + url: http://localhost:39300/model_context_protocol/2024-11-05/sse +``` + + + Use `streamable-http` (with hyphen), not `streamableHttp` or `http`. The type value is case-sensitive. + + +## Using Pieces MCP Server in Continue.dev + +Once integrated, you can utilize [Pieces LTM](/products/core-dependencies/pieces-os#ltm-27) directly in Continue.dev. + + + + Switch Continue.dev to **agent mode** in the UI. MCP servers are only available in agent mode. + + + + Check the available tools—Pieces LTM tools should appear. + + + + Ask the agent to search your Long-Term Memory. For example: *"What was I working on yesterday?"* + + + + + Check out this [MCP-specific prompting guide](/products/mcp/prompting) if you want to effectively utilize the Long-Term Memory Engine (LTM-2.7) with your new Pieces MCP server. + + +## Updating + +Edit your `config.yaml` (or JSON file), update the `url`, and switch to agent mode. Continue picks up the change on the next agent session. + +## Troubleshooting + +If you're experiencing issues integrating Pieces MCP with Continue.dev: + +1. **Verify PiecesOS Status**: Ensure [PiecesOS is actively running](/products/core-dependencies/pieces-os/troubleshooting) on your system. + +2. **Use Agent Mode**: MCP tools do not appear in regular chat—you must be in **agent mode**. + +3. **YAML Parse Error**: Check indentation; YAML is whitespace-sensitive. + +4. **Type Value**: Use `streamable-http` (with hyphen), not `streamableHttp` or `http`. + +5. **Server Not Connecting**: Check the PiecesOS port (39300-39333) and URL format. + +*** + +You're now set to enhance your Continue.dev workflow with powerful context retrieval through Pieces MCP. Happy coding! diff --git a/public/content/mcp/cursor.md b/public/content/mcp/cursor.md index a77ac6c..7e52ff2 100644 --- a/public/content/mcp/cursor.md +++ b/public/content/mcp/cursor.md @@ -73,11 +73,37 @@ You can also do this in the Pieces Desktop App by opening the **Settings** view ## Setting Up Cursor -Read below for steps on setting up the Pieces MCP in your Cursor IDE using the global MCP configuration method—or watch the video below for a tutorial and live demo. +There are two ways to set up Pieces MCP for Cursor: use the Pieces CLI for automatic configuration, or configure manually. + +### One-Click Install + +Install Pieces MCP in Cursor with a single click. Ensure [PiecesOS is running](/products/core-dependencies/pieces-os) and [Long-Term Memory is enabled](/products/core-dependencies/pieces-os/quick-menu#ltm-2-engine) before clicking. + + -### via Global MCP Configuration +### Method 1: CLI Install (Recommended) + +The Pieces CLI can automatically configure Pieces MCP for Cursor—no manual config editing required. + + + + Install the [Pieces CLI](/products/cli/get-started) if you haven't already. + + + In your terminal, run: + + ```bash + pieces mcp setup + ``` + + + A platform selection menu appears with options: *VS Code*, *Cursor*, *Claude Desktop*, *Windsurf*, *Claude Code*, *Raycast*, and *Warp*. Use the arrow keys to navigate to *Cursor*, then press `return` (macOS) or `enter` (Windows/Linux) to auto-install. + + + +### Method 2: Manual Configuration (Global MCP) To set up the Pieces MCP, you can edit the `.json` settings configuration file from within **Cursor Settings.** @@ -169,7 +195,7 @@ If you’re experiencing issues integrating Pieces MCP with Cursor, follow these 8. **Review Configuration Details**: Double-check the MCP endpoint URL and the port number in Cursor settings to ensure accuracy. You can find the current MCP endpoint URL in the Pieces Desktop App under **Settings** → **Model Context Protocol (MCP)**, or in the PiecesOS Quick Menu. It is usually formatted as: -```scss +```text http://localhost:{port_number}/model_context_protocol/2025-03-26/mcp ``` diff --git a/public/content/mcp/get-started.md b/public/content/mcp/get-started.md index 6481dbc..5a3dc83 100644 --- a/public/content/mcp/get-started.md +++ b/public/content/mcp/get-started.md @@ -145,15 +145,58 @@ Let’s take a look at the Pieces + MCP flow as you’d experience it in a famil Explore how quickly MCP enhances your productivity by delivering deep, personalized context directly to your AI-driven coding flow. -To begin using Pieces MCP, [install and launch PiecesOS](/products/core-dependencies/pieces-os/manual-installation) on your system, then follow our integration documentation for setting up the MCP server within your favorite IDE: +To begin using Pieces MCP, [install and launch PiecesOS](/products/core-dependencies/pieces-os/manual-installation) on your system, then follow our integration documentation for setting up the MCP server within your favorite IDE or tool: -* [Pieces MCP + Claude Desktop & Claude Code Integration Guide](/products/mcp/claude-desktop) +### One-Click Install (Cursor & VS Code) -* [Pieces MCP + Cursor Integration Guide](/products/mcp/cursor) +If you use Cursor or VS Code, install Pieces MCP with a single click. Ensure [PiecesOS is running](/products/core-dependencies/pieces-os) and [Long-Term Memory is enabled](/products/core-dependencies/pieces-os/quick-menu#ltm-2-engine) first. -* [Pieces MCP + GitHub Copilot Integration Guide](/products/mcp/github-copilot) + -* [Pieces MCP + Goose Integration Guide](/products/mcp/goose) +### Setup Tools + +* [mcp-remote Stdio Bridge](/products/mcp/mcp-remote) — Connect stdio-only clients to PiecesOS +* [ngrok Setup](/products/mcp/ngrok-setup) — Expose PiecesOS for remote MCP access + +### Platform Integrations + +* [Pieces MCP + Cursor](/products/mcp/cursor) + +* [Pieces MCP + Claude Desktop](/products/mcp/claude-desktop) + +* [Pieces MCP + Claude Code](/products/mcp/claude-code) + +* [Pieces MCP + Claude Cowork](/products/mcp/claude-cowork) + +* [Pieces MCP + GitHub Copilot](/products/mcp/github-copilot) + +* [Pieces MCP + VS Code](/products/mcp/vs-code) + +* [Pieces MCP + Goose](/products/mcp/goose) + +* [Pieces MCP + Windsurf](/products/mcp/windsurf) + +* [Pieces MCP + Zed](/products/mcp/zed) + +* [Pieces MCP + JetBrains IDEs](/products/mcp/jetbrains-ides) + +* [Pieces MCP + Continue.dev](/products/mcp/continue-dev) + +* [Pieces MCP + Cline](/products/mcp/cline) + +* [Pieces MCP + Raycast](/products/mcp/raycast) + +* [Pieces MCP + Rovo Dev CLI](/products/mcp/rovo-dev-cli) + +* [Pieces MCP + OpenAI Codex CLI](/products/mcp/openai-codex-cli) + +* [Pieces MCP + Google Gemini CLI](/products/mcp/google-gemini-cli) + +* [Pieces MCP + Amazon Q Developer](/products/mcp/amazon-q-developer) + +* [Pieces MCP + ChatGPT Developer Mode](/products/mcp/chatgpt-developer-mode) + +* [Pieces MCP + OpenClaw](/products/mcp/openclaw) *** diff --git a/public/content/mcp/google-gemini-cli.md b/public/content/mcp/google-gemini-cli.md new file mode 100644 index 0000000..257df30 --- /dev/null +++ b/public/content/mcp/google-gemini-cli.md @@ -0,0 +1,126 @@ +--- +title: Pieces MCP + Google Gemini CLI Integration +path: /mcp/google-gemini-cli +visibility: PUBLIC +status: PUBLISHED +description: The Pieces MCP integration with Google Gemini CLI lets you use Pieces Long-Term Memory directly from the Gemini command-line agent. +metaTitle: Integrate Pieces Model Context Protocol (MCP) with Google Gemini CLI +metaDescription: Learn how to integrate Pieces MCP with Google Gemini CLI. Use httpUrl for Streamable HTTP or url for SSE. +--- + + + +*** + +## Get Started + +Integrating the [Pieces MCP](/products/mcp/get-started) with Google Gemini CLI brings your workflow context directly into the Gemini command-line agent. Gemini CLI supports stdio, SSE, and Streamable HTTP. + + + **Key distinction:** For HTTP servers, use `httpUrl`; for SSE servers, use `url`—they are different fields in the Gemini config. + + +## Prerequisites + +There are **two** prerequisites for integrating Pieces with Gemini CLI as an MCP—an active instance of **PiecesOS** and the fully-enabled **Long-Term Memory** engine. + + + + Make sure that PiecesOS is installed and running. This is *required* for the MCP server to communicate with your workflow data. + + + + Enable the Long-Term Memory Engine (LTM-2.7) through the Pieces Desktop App or the [PiecesOS Quick Menu](/products/core-dependencies/pieces-os/quick-menu) in your toolbar. + + + +### Installing PiecesOS & Configuring Permissions + +Follow the instructions below for a detailed guide on setting up and configuring PiecesOS to correctly pass captured workflow context to the Pieces MCP server. + + + +## Setting Up Google Gemini CLI + +Gemini CLI stores its MCP configuration in `~/.gemini/settings.json`. Workspace settings override user settings. + +### Config File Location + +| Scope | Path | +|-------|------| +| **User (global)** | `~/.gemini/settings.json` | +| **Workspace** | `YOUR_PROJECT/.gemini/settings.json` | + +### Local Setup (Streamable HTTP — recommended) + +Edit `~/.gemini/settings.json`: + +```json +{ + "mcpServers": { + "pieces": { + "httpUrl": "http://localhost:39300/model_context_protocol/2025-03-26/mcp", + "timeout": 30000 + } + } +} +``` + +### Local Setup (SSE) + +For SSE, use `url` instead of `httpUrl`: + +```json +{ + "mcpServers": { + "pieces": { + "url": "http://localhost:39300/model_context_protocol/2024-11-05/sse", + "timeout": 30000 + } + } +} +``` + +## Using Pieces MCP Server in Gemini CLI + +Once integrated, you can utilize [Pieces LTM](/products/core-dependencies/pieces-os#ltm-27) directly in Gemini CLI. + + + + Run `gemini` in your terminal. + + + + Gemini discovers and registers tools from MCP servers on startup. Ask: *"What Pieces tools are available?"* + + + + Ask context-rich questions about your workflow. + + + + + Check out this [MCP-specific prompting guide](/products/mcp/prompting) if you want to effectively utilize the Long-Term Memory Engine (LTM-2.7) with your new Pieces MCP server. + + +## Updating + +Edit `~/.gemini/settings.json`, update the URL, and start a new Gemini CLI session. + +## Troubleshooting + +If you're experiencing issues integrating Pieces MCP with Gemini CLI: + +1. **Verify PiecesOS Status**: Ensure [PiecesOS is actively running](/products/core-dependencies/pieces-os/troubleshooting) on your system. + +2. **HTTP vs SSE Key**: Use `httpUrl` for Streamable HTTP, `url` for SSE—they are different fields. + +3. **Settings File Not Found**: Create `~/.gemini/settings.json` manually. + +4. **Tools Not Discovered**: Restart Gemini CLI after editing settings. + +5. **OAuth Prompt**: Pieces does not require OAuth. Dismiss if prompted. + +*** + +You're now set to enhance your Gemini CLI workflow with powerful context retrieval through Pieces MCP. Happy coding! diff --git a/public/content/mcp/jetbrains-ides.md b/public/content/mcp/jetbrains-ides.md new file mode 100644 index 0000000..e1d0eea --- /dev/null +++ b/public/content/mcp/jetbrains-ides.md @@ -0,0 +1,124 @@ +--- +title: Pieces MCP + JetBrains IDEs Integration +path: /mcp/jetbrains-ides +visibility: PUBLIC +status: PUBLISHED +description: The Pieces MCP integration with JetBrains IDEs (IntelliJ IDEA, PyCharm, WebStorm, GoLand, etc.) lets you use Pieces Long-Term Memory directly in your IDE via the AI Assistant. +metaTitle: Integrate Pieces Model Context Protocol (MCP) with JetBrains IDEs +metaDescription: Learn how to integrate Pieces MCP with JetBrains IDEs. Requires JetBrains 2025.2+ with AI Assistant. Access Long-Term Memory for enhanced productivity. +--- + + + +*** + +## Get Started + +Integrating the [Pieces MCP](/products/mcp/get-started) with JetBrains IDEs brings your workflow context directly into IntelliJ IDEA, PyCharm, WebStorm, GoLand, and other JetBrains editors. The AI Assistant can access your past work, similar code, and historical context. + + + **Minimum version:** JetBrains 2025.2 or later is required for MCP support. SSE has limited/deprecated support—use Streamable HTTP for best results. + + +## Prerequisites + +There are **two** prerequisites for integrating Pieces with JetBrains as an MCP—an active instance of **PiecesOS** and the fully-enabled **Long-Term Memory** engine. + + + + Make sure that PiecesOS is installed and running. This is *required* for the MCP server to communicate with your workflow data. + + + + Enable the Long-Term Memory Engine (LTM-2.7) through the Pieces Desktop App or the [PiecesOS Quick Menu](/products/core-dependencies/pieces-os/quick-menu) in your toolbar. + + + +### Installing PiecesOS & Configuring Permissions + +Follow the instructions below for a detailed guide on setting up and configuring PiecesOS to correctly pass captured workflow context to the Pieces MCP server. + + + +## Setting Up JetBrains IDEs + +JetBrains provides an MCP setup UI in Settings. You do not need to edit config files manually. + +### Setup via Settings UI + + + + Go to **Settings** (`Cmd+,` on macOS, `Ctrl+Alt+S` on Windows/Linux). + + + + Go to **Tools > AI Assistant > Model Context Protocol (MCP)**. + + + + Click `+` (Add) to create a new server. In the **New MCP Server** dialog, enter the Pieces MCP URL: + ```plaintext + http://localhost:39300/model_context_protocol/2025-03-26/mcp + ``` + + + + Select **Streamable HTTP** as the transport type. Optionally set a working directory. + + + + Click `OK` to apply your changes. + + + +### Brave Mode (Auto-Execute Tools) + +By default, JetBrains prompts for confirmation before executing tools. To enable auto-execution: + +Go to **Settings > Tools > AI Assistant > MCP > Brave Mode = enabled** + + + Use Brave Mode with caution in production environments. + + +## Using Pieces MCP Server in JetBrains + +Once integrated, you can utilize [Pieces LTM](/products/core-dependencies/pieces-os#ltm-27) directly in the AI Assistant panel. + + + + Open the **AI Assistant** panel in your JetBrains IDE. + + + + Check that Pieces tools appear in the available tools list. + + + + Ask the AI Assistant to query your Pieces Long-Term Memory. For example: *"What was I working on yesterday?"* + + + + + Check out this [MCP-specific prompting guide](/products/mcp/prompting) if you want to effectively utilize the Long-Term Memory Engine (LTM-2.7) with your new Pieces MCP server. + + +## Updating + +Go to **Settings > Tools > AI Assistant > MCP**, select the `pieces` server, click `Edit`, update the URL, and apply. + +## Troubleshooting + +If you're experiencing issues integrating Pieces MCP with JetBrains: + +1. **Verify PiecesOS Status**: Ensure [PiecesOS is actively running](/products/core-dependencies/pieces-os/troubleshooting) on your system. + +2. **Update JetBrains**: MCP support requires JetBrains 2025.2 or later. If the MCP option is not visible, update your IDE. + +3. **Use Streamable HTTP**: JetBrains has limited/deprecated SSE support. Use the Streamable HTTP endpoint (`/model_context_protocol/2025-03-26/mcp`). + +4. **AI Not Using Tools Automatically**: Enable **Brave Mode** in MCP settings if the AI is not executing tools automatically. + +*** + +You're now set to enhance your JetBrains workflow with powerful context retrieval through Pieces MCP. Happy coding! diff --git a/public/content/mcp/mcp-remote.md b/public/content/mcp/mcp-remote.md new file mode 100644 index 0000000..b392d19 --- /dev/null +++ b/public/content/mcp/mcp-remote.md @@ -0,0 +1,200 @@ +--- +title: MCP Bridge +path: /mcp/mcp-remote +visibility: PUBLIC +status: PUBLISHED +description: Learn how to use the mcp-remote stdio bridge to connect stdio-only MCP clients to PiecesOS, enabling Pieces Long-Term Memory in Raycast, Zed, Claude Cowork, and more. +metaTitle: MCP Bridge | Pieces Docs +metaDescription: Use mcp-remote to connect stdio-only MCP clients to PiecesOS. Step-by-step guide for Raycast, Zed, Claude Cowork, OpenClaw, and remote setups. +--- + +## MCP Bridge + +Many MCP clients—including Raycast, Zed, and Claude Cowork—only support **stdio** (standard input/output) connections. PiecesOS exposes its MCP server over **HTTP** and **SSE**. The [mcp-remote](https://www.npmjs.com/package/mcp-remote) bridge translates between these protocols so stdio-only clients can connect to PiecesOS and use [Pieces Long-Term Memory](/products/core-dependencies/pieces-os#ltm-27). + + + The easiest way to bridge MCP is with the Pieces CLI—run `pieces mcp setup` and select your platform. Use manual setup below only for clients not supported by the CLI or when you need custom config (e.g., remote URLs). + + +## Easiest Option: Pieces CLI + +The [Pieces CLI](/products/cli/get-started) automatically configures MCP for supported platforms—no manual config editing required. + + + + In your terminal, run `pieces mcp setup`. + + + Use the arrow keys to select your MCP client (VS Code, Cursor, Claude Desktop, Windsurf, Claude Code, Raycast, or Warp) and press Enter. + + + The CLI updates the platform's config file and confirms when Pieces MCP is enabled. + + + + + Ensure PiecesOS is running and LTM is enabled. Run `pieces mcp status` to verify your setup. + + +## Manual Setup + +Use manual setup when your client isn't supported by the CLI (e.g Zed and OpenClaw) or when you need to point at a remote PiecesOS URL (see [Tunneling](/products/mcp/ngrok-setup)). + +### Prerequisites + + + + PiecesOS must be installed and running. Enable the Long-Term Memory Engine (LTM-2.7) through the Pieces Desktop App or the [PiecesOS Quick Menu](/products/core-dependencies/pieces-os/quick-menu). + + + + + + `mcp-remote` requires Node.js 18+. Ensure Node.js and `npm` are in your PATH. + + + + Install `mcp-remote` globally with a pinned version so your MCP client runs a known, verified binary instead of fetching from the registry at runtime: + + ```bash + npm install -g mcp-remote@0.1.38 + ``` + + + Using `npx` to run `mcp-remote` downloads the package from npm each time. For better security, use a locally installed, version-pinned binary as shown above. + + + + +### Pieces MCP Endpoints + +PiecesOS exposes two endpoints. For `mcp-remote`, use the **SSE** endpoint—it works reliably across all stdio clients: + +| **Endpoint** | **URL** | **Use for** | +|--------------|---------|--------------| +| **SSE** | `http://localhost:39300/model_context_protocol/2024-11-05/sse` | mcp-remote, stdio clients | +| **Streamable HTTP** | `http://localhost:39300/model_context_protocol/2025-03-26/mcp` | Clients that support HTTP natively | + + + The port may vary. Find yours in the PiecesOS Quick Menu under **Model Context Protocol (MCP) Servers**, or in Pieces Desktop under **Settings** → **Model Context Protocol (MCP)**. + + +### Configuring Your Client + + + + Edit `mcp-config.json` (open via **Manage MCP Servers** → **Show Config File in Finder**): + + ```json + { + "mcpServers": { + "pieces": { + "command": "mcp-remote", + "args": [ + "http://localhost:39300/model_context_protocol/2024-11-05/sse" + ] + } + } + } + ``` + + See [Raycast integration](/products/mcp/raycast) for full setup. + + + + Zed uses `context_servers` (not `mcpServers`). Edit your Zed `settings.json`: + + ```json + { + "context_servers": { + "pieces": { + "command": { + "path": "mcp-remote", + "args": [ + "http://localhost:39300/model_context_protocol/2024-11-05/sse" + ], + "env": {} + }, + "settings": {} + } + } + } + ``` + + See [Zed integration](/products/mcp/zed) for full setup. + + + + Edit `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS) or `%APPDATA%\Claude\claude_desktop_config.json` (Windows): + + ```json + { + "mcpServers": { + "pieces": { + "command": "mcp-remote", + "args": [ + "http://localhost:39300/model_context_protocol/2024-11-05/sse" + ] + } + } + } + ``` + + See [Claude Cowork integration](/products/mcp/claude-cowork) for full setup. + + + + Edit `~/.openclaw/workspace/config/mcporter.json`: + + ```json + { + "mcpServers": { + "pieces": { + "command": "mcp-remote", + "args": [ + "http://localhost:39300/model_context_protocol/2024-11-05/sse" + ] + } + } + } + ``` + + See [OpenClaw integration](/products/mcp/openclaw) for full setup. + + + +For remote setups, use the ngrok URL instead of localhost. See [Tunneling](/products/mcp/ngrok-setup). + +### Useful Flags + +| **Flag** | **Purpose** | +|----------|-------------| +| `--allow-http` | Allow HTTP URLs; use only in trusted private networks | +| `--debug` | Write verbose logs to `~/.mcp-auth/{hash}_debug.log` | +| `--silent` | Suppress default logs | + +## Tips & Troubleshooting + +Ensure PiecesOS is running. Test the endpoint: `curl http://localhost:39300/.well-known/version`. Restart your MCP client after changing config, then ask: *"What tools do you have from Pieces?"* or *"What did I work on yesterday?"* + +### Troubleshooting + +1. **mcp-remote: command not found** — Run `npm install -g mcp-remote@0.1.38` and ensure the global npm bin directory is in your PATH. + +2. **Bridge not connecting** — Verify PiecesOS is running and the port is correct. Test with `curl http://localhost:39300/.well-known/version`. + +3. **Wrong config key** — Zed uses `context_servers`; Raycast, Claude Cowork, and OpenClaw use `mcpServers`. + +4. **Port mismatch** — Check the PiecesOS Quick Menu or Settings → Model Context Protocol (MCP) for the current endpoint. + +5. **Stale credentials** — If you have persistent issues, try `rm -rf ~/.mcp-auth` and restart the client. + +*** + +## Next Steps + +* [Raycast](/products/mcp/raycast) — macOS launcher with Pieces LTM +* [Zed](/products/mcp/zed) — Zed editor with Pieces LTM +* [Claude Cowork](/products/mcp/claude-cowork) — Claude Cowork with Pieces LTM +* [OpenClaw](/products/mcp/openclaw) — OpenClaw with Pieces LTM +* [Tunneling](/products/mcp/ngrok-setup) — Expose PiecesOS for remote MCP access diff --git a/public/content/mcp/ngrok-setup.md b/public/content/mcp/ngrok-setup.md new file mode 100644 index 0000000..ede2688 --- /dev/null +++ b/public/content/mcp/ngrok-setup.md @@ -0,0 +1,175 @@ +--- +title: Tunneling +path: /mcp/ngrok-setup +visibility: PUBLIC +status: PUBLISHED +description: Learn how to expose PiecesOS via ngrok to get a public HTTPS URL for MCP integrations that require remote access, such as ChatGPT Developer Mode and remote OpenClaw. +metaTitle: Tunneling | Pieces Docs +metaDescription: Step-by-step guide to set up ngrok with PiecesOS for remote MCP access. Required for ChatGPT Developer Mode and other integrations that need HTTPS. +--- + + +## Tunneling with ngrok + +Some MCP integrations cannot use localhost. [ChatGPT Developer Mode](/products/mcp/chatgpt-developer-mode) runs in the browser and requires a **remote HTTPS URL**. [OpenClaw](/products/mcp/openclaw) and [Claude Cowork](/products/mcp/claude-cowork) may need to reach PiecesOS from another machine. [ngrok](https://ngrok.com) creates a public HTTPS URL that forwards traffic to your local PiecesOS instance. The tunnel is active only while ngrok is running, and ngrok handles TLS certificates automatically. + + + Exposing PiecesOS publicly via ngrok should only be used when required. For local-only integrations (Cursor, VS Code, Claude Desktop on the same machine), use localhost directly. + + +## Prerequisites + + + + PiecesOS must be installed and running on the machine where you will run ngrok. Enable the Long-Term Memory Engine (LTM-2.7) through the Pieces Desktop App or the [PiecesOS Quick Menu](/products/core-dependencies/pieces-os/quick-menu). + + + + + + Sign up at [ngrok.com](https://ngrok.com) and get your [auth token](https://dashboard.ngrok.com/get-started/your-authtoken) from the dashboard. + + + +## Installing ngrok + + + + Install with Homebrew: + + ```bash + brew install ngrok + ``` + + + + Install via the [Windows App Store](https://apps.microsoft.com/detail/9mvs1j51gmk6) or [download directly](https://ngrok.com/download). + + + + On Debian/Ubuntu: + + ```bash + curl -sSL https://ngrok-agent.s3.amazonaws.com/ngrok.asc \ + | sudo tee /etc/apt/trusted.gpg.d/ngrok.asc >/dev/null \ + && echo "deb https://ngrok-agent.s3.amazonaws.com buster main" \ + | sudo tee /etc/apt/sources.list.d/ngrok.list \ + && sudo apt update \ + && sudo apt install ngrok + ``` + + + +Verify the installation: + +```bash +ngrok help +``` + +## Setting Up the Tunnel + + + + Add your auth token so ngrok can create tunnels: + + ```bash + ngrok config add-authtoken YOUR_AUTH_TOKEN + ``` + + Replace `YOUR_AUTH_TOKEN` with the token from your [ngrok dashboard](https://dashboard.ngrok.com/get-started/your-authtoken). + + + + PiecesOS typically runs on port **39300**. To find yours: open the **PiecesOS Quick Menu** (system tray or menu bar) → expand **Model Context Protocol (MCP) Servers** → copy the endpoint (it includes the port). You can also find it in Pieces Desktop under **Settings** → **Model Context Protocol (MCP)**. + + + + Ensure PiecesOS is running, then: + + ```bash + ngrok http 39300 + ``` + + Replace `39300` with your actual port if different. ngrok will display a forwarding URL like `https://abc123.ngrok-free.app`. Copy the **HTTPS** URL. + + + +## MCP Endpoint URLs + +Append the correct path to your ngrok URL: + +| **Endpoint** | **Path** | **Use for** | +|--------------|----------|--------------| +| **Streamable HTTP** | `/model_context_protocol/2025-03-26/mcp` | ChatGPT, Claude Cowork Connectors UI | +| **SSE** | `/model_context_protocol/2024-11-05/sse` | MCP Bridge, OpenClaw remote | + +Example: if ngrok shows `https://abc123.ngrok-free.app`, use `https://abc123.ngrok-free.app/model_context_protocol/2025-03-26/mcp` for ChatGPT or `https://abc123.ngrok-free.app/model_context_protocol/2024-11-05/sse` for MCP Bridge. + +## Configuring Your MCP Client + +### ChatGPT Developer Mode + +1. Open [chatgpt.com](https://chatgpt.com) → **Settings** → **Connectors**. +2. Click `Create` and add a new connector. +3. Set **MCP Server URL** to: `https://YOUR_NGROK_URL.ngrok-free.app/model_context_protocol/2025-03-26/mcp` +4. Save. The tunnel must be running whenever you use ChatGPT with Pieces. + +See [ChatGPT Developer Mode integration](/products/mcp/chatgpt-developer-mode) for full setup. + +### Claude Cowork (Connectors UI) + +1. Open Claude Desktop → **Settings** → **Connectors**. +2. Click `Add custom connector`. +3. Enter: `https://YOUR_NGROK_URL.ngrok-free.app/model_context_protocol/2025-03-26/mcp` +4. Save and restart Claude Desktop. + +See [Claude Cowork integration](/products/mcp/claude-cowork) for full setup. + +### OpenClaw (Remote) + +Install `mcp-remote` globally (`npm install -g mcp-remote@0.1.38`), then edit `~/.openclaw/workspace/config/mcporter.json`: + +```json +{ + "mcpServers": { + "pieces": { + "command": "mcp-remote", + "args": [ + "https://YOUR_NGROK_URL.ngrok-free.app/model_context_protocol/2024-11-05/sse" + ] + } + } +} +``` + +See [OpenClaw integration](/products/mcp/openclaw) for full setup. + +## Tips & Troubleshooting + +The tunnel is active only while `ngrok http 39300` is running. Start ngrok when you need remote access, or keep it running in a dedicated terminal for regular use. + + + Free ngrok accounts get a random subdomain each time you start a tunnel. If the URL changes, update the MCP Server URL in your client (ChatGPT: Settings → Connectors; Claude Cowork: Settings → Connectors; OpenClaw: edit `~/.openclaw/workspace/config/mcporter.json`). + + +### Troubleshooting + +1. **Tunnel not connecting** — Ensure PiecesOS is running and listening on the port. Test locally: `curl http://localhost:39300/.well-known/version` + +2. **Wrong port** — Use the port from the PiecesOS Quick Menu or Settings → Model Context Protocol (MCP). It may not be 39300. + +3. **URL not accessible** — Verify ngrok is running and the HTTPS URL loads in a browser. Free plans may show an ngrok interstitial page on first visit; that's normal. + +4. **Subdirectory paths** — Use the exact paths: `/model_context_protocol/2025-03-26/mcp` or `/model_context_protocol/2024-11-05/sse`. Paths like `/functions/v1/mcp` do not work. + +5. **Connection refused** — Restart PiecesOS and ngrok. Ensure no firewall is blocking the port. + +### Security + +ngrok exposes PiecesOS to the internet—use it only when required. Keep your ngrok auth token private. For private network access, consider [Tailscale](https://tailscale.com) or a VPN instead of a public tunnel. + +*** + +## Next Steps + +Configure your MCP client with the ngrok URL: [ChatGPT Developer Mode](/products/mcp/chatgpt-developer-mode), [Claude Cowork](/products/mcp/claude-cowork), [OpenClaw](/products/mcp/openclaw), or [MCP Bridge](/products/mcp/mcp-remote). diff --git a/public/content/mcp/openai-codex-cli.md b/public/content/mcp/openai-codex-cli.md new file mode 100644 index 0000000..4a6f44c --- /dev/null +++ b/public/content/mcp/openai-codex-cli.md @@ -0,0 +1,117 @@ +--- +title: Pieces MCP + OpenAI Codex CLI Integration +path: /mcp/openai-codex-cli +visibility: PUBLIC +status: PUBLISHED +description: The Pieces MCP integration with OpenAI Codex CLI lets you use Pieces Long-Term Memory directly from the Codex command-line agent. +metaTitle: Integrate Pieces Model Context Protocol (MCP) with OpenAI Codex CLI +metaDescription: Learn how to integrate Pieces MCP with OpenAI Codex CLI. Use TOML config format for MCP server setup. Requires Codex 0.2.0+. +--- + + + +*** + +## Get Started + +Integrating the [Pieces MCP](/products/mcp/get-started) with OpenAI Codex CLI brings your workflow context directly into the Codex command-line agent. Codex uses **TOML** (not JSON) for its configuration. + + + **Minimum version:** Codex CLI 0.2.0 or later is required for MCP support. + + +## Prerequisites + +There are **two** prerequisites for integrating Pieces with Codex CLI as an MCP—an active instance of **PiecesOS** and the fully-enabled **Long-Term Memory** engine. + + + + Make sure that PiecesOS is installed and running. This is *required* for the MCP server to communicate with your workflow data. + + + + Enable the Long-Term Memory Engine (LTM-2.7) through the Pieces Desktop App or the [PiecesOS Quick Menu](/products/core-dependencies/pieces-os/quick-menu) in your toolbar. + + + +### Installing PiecesOS & Configuring Permissions + +Follow the instructions below for a detailed guide on setting up and configuring PiecesOS to correctly pass captured workflow context to the Pieces MCP server. + + + +## Setting Up OpenAI Codex CLI + +Codex stores its MCP configuration in `~/.codex/config.toml`. The file format is **TOML**, not JSON. + +### Config File Location + +| Scope | Path | +|-------|------| +| **User (global)** | `~/.codex/config.toml` | +| **Project** | `.codex/config.toml` at project root (trusted projects only) | + +### Local Setup (Streamable HTTP — recommended) + +Edit `~/.codex/config.toml`: + +```toml +[mcp_servers.pieces] +url = "http://localhost:39300/model_context_protocol/2025-03-26/mcp" +startup_timeout_sec = 10 +tool_timeout_sec = 60 +``` + +### Optional: Filter Specific Tools + +To only expose specific Pieces tools: + +```toml +[mcp_servers.pieces] +url = "http://localhost:39300/model_context_protocol/2025-03-26/mcp" +enabled_tools = ["ask_pieces_ltm", "workstream_summaries_full_text_search"] +``` + +## Using Pieces MCP Server in Codex CLI + +Once integrated, you can utilize [Pieces LTM](/products/core-dependencies/pieces-os#ltm-27) directly in Codex. + + + + Run `codex` in your terminal. + + + + Codex announces available MCP tools on startup. Ask: *"What Pieces tools are available?"* + + + + Ask context-rich questions about your workflow. + + + + + Check out this [MCP-specific prompting guide](/products/mcp/prompting) if you want to effectively utilize the Long-Term Memory Engine (LTM-2.7) with your new Pieces MCP server. + + +## Updating + +Edit `~/.codex/config.toml`, update the `url`, and run a new Codex session. + +## Troubleshooting + +If you're experiencing issues integrating Pieces MCP with Codex CLI: + +1. **Verify PiecesOS Status**: Ensure [PiecesOS is actively running](/products/core-dependencies/pieces-os/troubleshooting) on your system. Verify the URL responds. + +2. **Use TOML, Not JSON**: Codex uses TOML format. Creating a `.json` file will not work. + +3. **Update Codex**: MCP support requires Codex CLI 0.2.0 or later. + +4. **Config File Not Found**: Create `~/.codex/config.toml` manually. + +5. **Timeout Errors**: Increase `startup_timeout_sec` or `tool_timeout_sec` if you encounter timeouts. + +*** + +You're now set to enhance your Codex CLI workflow with powerful context retrieval through Pieces MCP. Happy coding! diff --git a/public/content/mcp/openclaw.md b/public/content/mcp/openclaw.md new file mode 100644 index 0000000..9abedee --- /dev/null +++ b/public/content/mcp/openclaw.md @@ -0,0 +1,136 @@ +--- +title: Pieces MCP + OpenClaw Integration +path: /mcp/openclaw +visibility: PUBLIC +status: PUBLISHED +description: The Pieces MCP integration with OpenClaw lets you use Pieces Long-Term Memory in the open-source self-hosted AI agent that runs 24/7 and connects to messaging platforms. +metaTitle: Integrate Pieces Model Context Protocol (MCP) with OpenClaw +metaDescription: Learn how to integrate Pieces MCP with OpenClaw. OpenClaw executes MCP tools via MCPorter. Automate standups, meeting prep, and more. +--- + + + +*** + +## Get Started + +Integrating the [Pieces MCP](/products/mcp/get-started) with OpenClaw brings your workflow context directly into this open-source continuous AI agent runtime. OpenClaw (formerly ClawdBot, formerly Moltbot) runs as a persistent Node.js service—unlike chatbots that respond to one-off prompts, it runs 24/7, executing tasks proactively via cron jobs and event listeners. + +With Pieces MCP connected, OpenClaw gains access to your Long-Term Memory. It can autonomously query your past work, generate standups, monitor recent activity, and surface relevant context without you asking. + +## Prerequisites + + + + Install Node.js 18 or later. + + + + Clone and configure OpenClaw following the [OpenClaw setup guide](https://github.com/clawdbot). + + + + PiecesOS must be running locally (port 39300-39333). Enable the Long-Term Memory Engine (LTM-2.7) through the Pieces Desktop App or the [PiecesOS Quick Menu](/products/core-dependencies/pieces-os/quick-menu). + + + +### Installing PiecesOS & Configuring Permissions + +Follow the instructions below for a detailed guide on setting up and configuring PiecesOS to correctly pass captured workflow context to the Pieces MCP server. + + + +## Setting Up OpenClaw + +OpenClaw executes MCP tools via **MCPorter**, its built-in MCP management layer. Edit `~/.openclaw/workspace/config/mcporter.json`: + +Install `mcp-remote` globally with a pinned version for security: + +```bash +npm install -g mcp-remote@0.1.38 +``` + +See [MCP Bridge](/products/mcp/mcp-remote) for why we recommend a locally installed binary over `npx`. + +### Local Setup (SSE with mcp-remote — recommended) + +When OpenClaw and PiecesOS run on the same machine, use the localhost URL with the mcp-remote bridge: + +```json +{ + "mcpServers": { + "pieces": { + "command": "mcp-remote", + "args": [ + "http://localhost:39300/model_context_protocol/2024-11-05/sse" + ] + } + } +} +``` + +### Remote Setup (ngrok) + +When OpenClaw needs to reach PiecesOS on a different machine: + +```json +{ + "mcpServers": { + "pieces": { + "command": "mcp-remote", + "args": [ + "https://YOUR_NGROK_URL.ngrok-free.app/model_context_protocol/2024-11-05/sse" + ] + } + } +} +``` + +See [Tunneling](/products/mcp/ngrok-setup) for tunnel setup. + +## Example Use Cases + +Once Pieces MCP is connected to OpenClaw, you can automate workflows like: + +**Autonomous daily standup:** Schedule OpenClaw to run every morning, query yesterday's workstream summaries, and post a formatted standup to your Slack or Teams channel. + +**Meeting prep:** Before a calendar event, OpenClaw searches audio transcriptions and workstream summaries for context related to the meeting topic and drafts a brief for you. + +**Automated debugging log:** When OpenClaw detects a production alert, it queries recent workstream events for error-related content and creates a pieces_memory entry with the incident context. + +## Verification + +1. Start OpenClaw. +2. Ask via your connected messaging platform: *"What Pieces tools do you have?"* +3. Pieces LTM tools should be listed. +4. Try: *"What did I work on yesterday?"*—OpenClaw will call `ask_pieces_ltm`. + +## Security Note + +OpenClaw can run with `permissionMode: 'bypassPermissions'` to execute tools autonomously. When combined with Pieces MCP write tools (like `create_pieces_memory`), this is powerful but should be used carefully. Consider: + +* Running OpenClaw in Docker with limited filesystem access +* Disabling write tools in MCPorter if running fully autonomously +* Monitoring execution logs + +## Updating + +Edit `~/.openclaw/workspace/config/mcporter.json`, update the URL, and restart OpenClaw. + +## Troubleshooting + +If you're experiencing issues integrating Pieces MCP with OpenClaw: + +1. **Verify PiecesOS Status**: Ensure [PiecesOS is actively running](/products/core-dependencies/pieces-os/troubleshooting) on your system. + +2. **MCPorter Config Not Found**: Create `~/.openclaw/workspace/config/` directory manually. + +3. **Bridge Process Not Starting**: Run `npm install -g mcp-remote@0.1.38` and ensure the global npm bin directory is in your PATH. + +4. **Tools Not Available**: Restart OpenClaw after editing MCPorter config. + +5. **ngrok URL Expired**: Restart the ngrok tunnel and update the URL in MCPorter config. See [ngrok Setup](/products/mcp/ngrok-setup) for details. + +*** + +You're now set to enhance your OpenClaw workflow with powerful context retrieval through Pieces MCP. Happy coding! diff --git a/public/content/mcp/raycast.md b/public/content/mcp/raycast.md new file mode 100644 index 0000000..fae6586 --- /dev/null +++ b/public/content/mcp/raycast.md @@ -0,0 +1,157 @@ +--- +title: Pieces MCP + Raycast Integration +path: /mcp/raycast +visibility: PUBLIC +status: PUBLISHED +description: The Pieces MCP integration with Raycast lets you use Pieces Long-Term Memory in the Raycast macOS launcher via an stdio-to-HTTP bridge. +metaTitle: Integrate Pieces Model Context Protocol (MCP) with Raycast +metaDescription: Learn how to integrate Pieces MCP with Raycast. Raycast supports stdio only—use mcp-remote bridge to connect to PiecesOS. macOS only. +--- + + + +*** + +## Get Started + +Integrating the [Pieces MCP](/products/mcp/get-started) with Raycast brings your workflow context directly into your macOS launcher. Raycast does not natively support HTTP-based MCP servers—you need an **stdio-to-HTTP bridge** (like [mcp-remote](/products/mcp/mcp-remote)) to connect to PiecesOS. + + + **macOS only:** Raycast is currently available only on macOS. + + +## Prerequisites + +There are **three** prerequisites for integrating Pieces with Raycast: + + + + Make sure that PiecesOS is installed and running. This is *required* for the MCP server to communicate with your workflow data. + + + + Enable the Long-Term Memory Engine (LTM-2.7) through the Pieces Desktop App or the [PiecesOS Quick Menu](/products/core-dependencies/pieces-os/quick-menu) in your toolbar. + + + + The `mcp-remote` bridge requires Node.js. Ensure Node.js and `npm` are installed. + + + + Install `mcp-remote` globally with a pinned version for security: + + ```bash + npm install -g mcp-remote@0.1.38 + ``` + + See [MCP Bridge](/products/mcp/mcp-remote) for why we recommend a locally installed binary over `npx`. + + + +### Installing PiecesOS & Configuring Permissions + +Follow the instructions below for a detailed guide on setting up and configuring PiecesOS to correctly pass captured workflow context to the Pieces MCP server. + + + +## Setting Up Raycast + +There are two ways to set up Pieces MCP for Raycast: use the Pieces CLI for automatic configuration, or configure manually with the mcp-remote bridge. + +### Method 1: CLI Install (Recommended) + +The Pieces CLI can automatically configure Pieces MCP for Raycast—no manual config editing required. + + + + Install the [Pieces CLI](/products/cli/get-started) if you haven't already. + + + In your terminal, run: + + ```bash + pieces mcp setup + ``` + + + A platform selection menu appears with options: *VS Code*, *Cursor*, *Claude Desktop*, *Windsurf*, *Claude Code*, *Raycast*, and *Warp*. Use the arrow keys to navigate to *Raycast*, then press `return` (macOS) or `enter` (Windows/Linux) to auto-install. + + + +### Method 2: Manual Configuration with mcp-remote Bridge + +Raycast uses `mcpServers` in its config. All servers must use `type: "stdio"` because Raycast does not support HTTP natively. + +### Config File Location + +Open Raycast, search for **Manage MCP Servers**, then press **Cmd+K** and select **Show Config File in Finder** to locate `mcp-config.json`. + +### Local Setup (same machine as PiecesOS) + +Add to `mcp-config.json`: + +```json +{ + "mcpServers": { + "pieces": { + "command": "mcp-remote", + "args": [ + "http://localhost:39300/model_context_protocol/2024-11-05/sse" + ] + } + } +} +``` + +### Adding via Raycast UI + + + + Open Raycast (Cmd+Space or your hotkey) and search for **Install Server**. + + + + * **Name:** pieces + * **Type:** stdio + * **Command:** mcp-remote + * **Args:** `http://localhost:39300/model_context_protocol/2024-11-05/sse` + + + +## Using Pieces MCP in Raycast + +After setup, use `@pieces` in Raycast AI (Quick AI, AI Chat, or Presets) to invoke Pieces tools. Raycast automatically shows AI all available servers. + + + + Open Raycast AI Chat. + + + + Type `@pieces` to mention the Pieces MCP server. + + + + Ask: *"What tools do you have from Pieces?"* or *"What was I working on yesterday?"* + + + +## Updating + +Edit `mcp-config.json` (found via **Show Config File in Finder**), update the URL in `args`, and restart Raycast AI. + +## Troubleshooting + +If you're experiencing issues integrating Pieces MCP with Raycast: + +1. **Verify PiecesOS Status**: Ensure [PiecesOS is actively running](/products/core-dependencies/pieces-os/troubleshooting) on your system. + +2. **mcp-remote: command not found**: Run `npm install -g mcp-remote@0.1.38` and ensure the global npm bin directory is in your PATH. + +3. **Bridge Not Connecting**: Verify the SSE endpoint responds: `curl http://localhost:39300/.well-known/version` + +4. **Config File Location**: Use Raycast's **Manage MCP Servers > Show Config File in Finder** to locate the exact path. + +*** + +You're now set to enhance your Raycast workflow with powerful context retrieval through Pieces MCP. Happy coding! diff --git a/public/content/mcp/rovo-dev-cli.md b/public/content/mcp/rovo-dev-cli.md new file mode 100644 index 0000000..c292b94 --- /dev/null +++ b/public/content/mcp/rovo-dev-cli.md @@ -0,0 +1,133 @@ +--- +title: Pieces MCP + Rovo Dev CLI Integration +path: /mcp/rovo-dev-cli +visibility: PUBLIC +status: PUBLISHED +description: The Pieces MCP integration with Rovo Dev CLI (Atlassian's AI developer tool) lets you use Pieces Long-Term Memory directly from the command line. +metaTitle: Integrate Pieces Model Context Protocol (MCP) with Rovo Dev CLI +metaDescription: Learn how to integrate Pieces MCP with Rovo Dev CLI. Access Long-Term Memory for enhanced, context-aware productivity. +--- + + + +*** + +## Get Started + +Integrating the [Pieces MCP](/products/mcp/get-started) with Rovo Dev CLI brings your workflow context directly into Atlassian's AI developer tool. Rovo Dev CLI supports stdio, SSE, and Streamable HTTP for flexible setup. + +## Prerequisites + +There are **two** prerequisites for integrating Pieces with Rovo Dev CLI as an MCP—an active instance of **PiecesOS** and the fully-enabled **Long-Term Memory** engine. + + + + Make sure that PiecesOS is installed and running. This is *required* for the MCP server to communicate with your workflow data. + + + + Enable the Long-Term Memory Engine (LTM-2.7) through the Pieces Desktop App or the [PiecesOS Quick Menu](/products/core-dependencies/pieces-os/quick-menu) in your toolbar. + + + +### Installing PiecesOS & Configuring Permissions + +Follow the instructions below for a detailed guide on setting up and configuring PiecesOS to correctly pass captured workflow context to the Pieces MCP server. + + + +## Setting Up Rovo Dev CLI + +Rovo Dev CLI stores its MCP configuration in `~/.rovodev/mcp.json`. It uses a `servers` root key with a `transport` field (not `type`). + +### Config File Location + +| Platform | Path | +|----------|------| +| **All platforms** | `~/.rovodev/mcp.json` | + +### Local Setup (Streamable HTTP — recommended) + +Edit `~/.rovodev/mcp.json`: + +```json +{ + "servers": { + "pieces": { + "name": "Pieces LTM", + "transport": "http", + "url": "http://localhost:39300/model_context_protocol/2025-03-26/mcp" + } + } +} +``` + +### Local Setup (SSE) + +```json +{ + "servers": { + "pieces": { + "name": "Pieces LTM", + "transport": "sse", + "url": "http://localhost:39300/model_context_protocol/2024-11-05/sse" + } + } +} +``` + +### Opening the Config in Your Editor + +Run this command to open the config file in your default editor: + +```bash +acli rovodev mcp +``` + +## Using Pieces MCP Server in Rovo Dev CLI + +Once integrated, you can utilize [Pieces LTM](/products/core-dependencies/pieces-os#ltm-27) directly in Rovo Dev sessions. + + + + Start a Rovo Dev session from your terminal. + + + + Run `/mcp list` to see configured servers and their status. + + + + Ask: *"What Pieces tools do you have?"* or *"What was I working on yesterday?"* + + + +### Managing Servers in Interactive Mode + +Within a Rovo Dev session, use the `/mcp` command to open an interactive interface showing: + +* Configured servers and their status +* Available tools from each server +* Enable/disable toggles + +## Updating + +Edit `~/.rovodev/mcp.json` (via `acli rovodev mcp` or directly), update the URL, and restart the Rovo Dev session. + +## Troubleshooting + +If you're experiencing issues integrating Pieces MCP with Rovo Dev CLI: + +1. **Verify PiecesOS Status**: Ensure [PiecesOS is actively running](/products/core-dependencies/pieces-os/troubleshooting) on your system. + +2. **Use transport, Not type**: Rovo Dev CLI uses the `transport` key (not `type`) for the transport type. + +3. **Config File Not Found**: Create `~/.rovodev/` and `~/.rovodev/mcp.json` manually if the directory does not exist. + +4. **Restart Session**: Restart the Rovo Dev session after editing the config. + +5. **Atlassian OAuth**: Pieces does not require Atlassian OAuth. If prompted, this is for the Atlassian Rovo MCP Server, not Pieces. + +*** + +You're now set to enhance your Rovo Dev CLI workflow with powerful context retrieval through Pieces MCP. Happy coding! diff --git a/public/content/mcp/vs-code.md b/public/content/mcp/vs-code.md new file mode 100644 index 0000000..861af28 --- /dev/null +++ b/public/content/mcp/vs-code.md @@ -0,0 +1,197 @@ +--- +title: Pieces MCP + VS Code Integration +path: /mcp/vs-code +visibility: PUBLIC +status: PUBLISHED +description: The Pieces MCP integration with Visual Studio Code lets you use Pieces Long-Term Memory directly in your editor, enhancing your coding workflow with context-aware AI assistance. +metaTitle: Integrate Pieces Model Context Protocol (MCP) with VS Code +metaDescription: Learn how to integrate Pieces MCP with Visual Studio Code. Access Long-Term Memory within your editor for enhanced, context-aware productivity. +--- + + + +*** + +## Get Started + +Integrating the [Pieces MCP](/products/mcp/get-started) with Visual Studio Code brings your workflow context directly into your editor. With this integration, your AI assistant can access past implementations, similar code, and historical debugging context—without searching through commits or notes. + +## Prerequisites + +There are **two** prerequisites for integrating Pieces with VS Code as an MCP—an active instance of **PiecesOS** and the fully-enabled **Long-Term Memory** engine. + + + + Make sure that PiecesOS is installed and running. This is *required* for the MCP server to communicate with your workflow data and pass context through to VS Code. + + If you do not have PiecesOS, you can download it alongside the [Pieces Desktop App](/products/desktop/download) or [install it standalone](/products/core-dependencies/pieces-os/manual-installation#manual-download--installation) here. + + + + For the MCP server to interact with your workflow context, you must enable the Long-Term Memory Engine (LTM-2.7) through the Pieces Desktop App or the [PiecesOS Quick Menu](/products/core-dependencies/pieces-os/quick-menu) in your toolbar. + + + +### Installing PiecesOS & Configuring Permissions + +Follow the instructions below for a detailed guide on setting up and configuring PiecesOS to correctly pass captured workflow context to the Pieces MCP server. + + + +### Getting the MCP Endpoint for PiecesOS + +To use Pieces MCP with VS Code, you'll need the MCP endpoint from PiecesOS. VS Code supports Streamable HTTP (recommended) or SSE. + +**Streamable HTTP (recommended):** +```plaintext +http://localhost:39300/model_context_protocol/2025-03-26/mcp +``` + +**SSE (legacy):** +```plaintext +http://localhost:39300/model_context_protocol/2024-11-05/sse +``` + + + Keep in mind that the **specific port** (e.g., `39300`) PiecesOS is running on **may vary**. + + +To find the current MCP endpoint with the active instance of PiecesOS, open the PiecesOS Quick Menu and expand the **Model Context Protocol (MCP) Servers** tab. You can copy the endpoint, which includes the active port number. + +You can also find this in the Pieces Desktop App by opening **Settings** and clicking **Model Context Protocol (MCP)**. + +## Setting Up VS Code + +There are two ways to set up Pieces MCP for VS Code: use the Pieces CLI for automatic configuration, or configure manually. + +### One-Click Install + +Install Pieces MCP in VS Code with a single click. Ensure [PiecesOS is running](/products/core-dependencies/pieces-os) and [Long-Term Memory is enabled](/products/core-dependencies/pieces-os/quick-menu#ltm-2-engine) before clicking. + + + +### Method 1: CLI Install (Recommended) + +The Pieces CLI can automatically configure Pieces MCP for VS Code—no manual config editing required. + + + + Install the [Pieces CLI](/products/cli/get-started) if you haven't already. + + + In your terminal, run: + + ```bash + pieces mcp setup + ``` + + + A platform selection menu appears with options: *VS Code*, *Cursor*, *Claude Desktop*, *Windsurf*, *Claude Code*, *Raycast*, and *Warp*. Use the arrow keys to navigate to *VS Code*, then press `return` (macOS) or `enter` (Windows/Linux) to auto-install. + + + For VS Code, you'll be asked to choose *User Settings* (MCP available in all projects) or *Workspace Settings* (MCP for the current project only). + + + +### Method 2: Manual Configuration + +VS Code uses a `servers` root key (not `mcpServers`) in its MCP configuration. The transport type is set with a `type` field. + +### Config File Location + +| Scope | Path | +|-------|------| +| **Workspace** | `.vscode/mcp.json` in your project root | +| **User (global)** | Via Settings > search "MCP Servers" | + +### Local Setup (Streamable HTTP — recommended) + +Add or edit `.vscode/mcp.json` in your project root: + +```json +{ + "servers": { + "pieces": { + "type": "http", + "url": "http://localhost:39300/model_context_protocol/2025-03-26/mcp" + } + } +} +``` + +### Local Setup (SSE — legacy) + +```json +{ + "servers": { + "pieces": { + "type": "sse", + "url": "http://localhost:39300/model_context_protocol/2024-11-05/sse" + } + } +} +``` + +### Adding via Command Palette + + + + Press `Cmd+Shift+P` (macOS) or `Ctrl+Shift+P` (Windows/Linux). + + + + Search for **MCP: Add Server** and select the command. + + + + Select **HTTP** or **SSE** as the transport type. + + + + Paste your MCP endpoint and name it `pieces`. + + + +## Using Pieces MCP Server in VS Code + +Once integrated, you can utilize [Pieces LTM](/products/core-dependencies/pieces-os#ltm-27) directly in VS Code through extensions that support MCP, such as GitHub Copilot Chat. + + + + Open the chat interface for your MCP-enabled extension (e.g., GitHub Copilot Chat). + + + + If your extension has chat modes, switch to *Agent* mode so it can use the `ask_pieces_ltm` tool. + + + + Ask context-rich questions about your workflow. For example: *"What was I working on yesterday?"* or *"Show me previous implementations of this authentication method."* + + + + + Check out this [MCP-specific prompting guide](/products/mcp/prompting) if you want to effectively utilize the Long-Term Memory Engine (LTM-2.7) with your new Pieces MCP server. + + +## Updating + +To update the URL, edit `.vscode/mcp.json` and save. VS Code picks up changes without a restart. You can also use **MCP: Edit Server** in the Command Palette to update the URL for the `pieces` server. + +## Troubleshooting + +If you're experiencing issues integrating Pieces MCP with VS Code: + +1. **Verify PiecesOS Status**: Ensure [PiecesOS is actively running](/products/core-dependencies/pieces-os/troubleshooting) on your system. + +2. **Confirm LTM Engine Activation**: Make sure the [Long-Term Memory Engine (LTM-2.7) is enabled in PiecesOS](/products/core-dependencies/pieces-os/quick-menu#ltm-2-engine). + +3. **Check Config Location**: The file must be `.vscode/mcp.json` (not `.cursor/mcp.json` or `mcp.json` at root). + +4. **Verify Transport Type**: Use `type: "http"` for Streamable HTTP or `type: "sse"` for SSE. Ensure you're using the correct `servers` key (not `mcpServers`). + +5. **Tools Not Visible**: Ensure your MCP-enabled extension (e.g., GitHub Copilot Chat) is installed and active. Run **MCP: List Servers** to confirm `pieces` shows as connected. + +*** + +You're now set to enhance your VS Code workflow with powerful context retrieval through Pieces MCP. Happy coding! diff --git a/public/content/mcp/windsurf.md b/public/content/mcp/windsurf.md new file mode 100644 index 0000000..3a4c245 --- /dev/null +++ b/public/content/mcp/windsurf.md @@ -0,0 +1,155 @@ +--- +title: Pieces MCP + Windsurf Integration +path: /mcp/windsurf +visibility: PUBLIC +status: PUBLISHED +description: The Pieces MCP integration with Windsurf lets you use Pieces Long-Term Memory directly in the Windsurf IDE, enhancing your coding workflow with context-aware AI assistance via Cascade. +metaTitle: Integrate Pieces Model Context Protocol (MCP) with Windsurf +metaDescription: Learn how to integrate Pieces MCP with Windsurf. Access Long-Term Memory within Cascade for enhanced, context-aware productivity. +--- + + + +*** + +## Get Started + +Integrating the [Pieces MCP](/products/mcp/get-started) with Windsurf brings your workflow context directly into the Cascade AI panel. With this integration, Windsurf can access your past work, similar code, and historical debugging context to provide smarter, personalized assistance. + +## Prerequisites + +There are **two** prerequisites for integrating Pieces with Windsurf as an MCP—an active instance of **PiecesOS** and the fully-enabled **Long-Term Memory** engine. + + + + Make sure that PiecesOS is installed and running. This is *required* for the MCP server to communicate with your workflow data and pass context through to Windsurf. + + If you do not have PiecesOS, you can download it alongside the [Pieces Desktop App](/products/desktop/download) or [install it standalone](/products/core-dependencies/pieces-os/manual-installation#manual-download--installation) here. + + + + For the MCP server to interact with your workflow context, you must enable the Long-Term Memory Engine (LTM-2.7) through the Pieces Desktop App or the [PiecesOS Quick Menu](/products/core-dependencies/pieces-os/quick-menu) in your toolbar. + + + +### Installing PiecesOS & Configuring Permissions + +Follow the instructions below for a detailed guide on setting up and configuring PiecesOS to correctly pass captured workflow context to the Pieces MCP server. + + + +### Getting the MCP Endpoint for PiecesOS + +To use Pieces MCP with Windsurf, you'll need the MCP endpoint from PiecesOS: + +```plaintext +http://localhost:39300/model_context_protocol/2025-03-26/mcp +``` + + + Keep in mind that the **specific port** (e.g., `39300`) PiecesOS is running on **may vary**. + + + + Windsurf uses **`serverUrl`** (not `url`) for HTTP/remote servers—this is a Windsurf-specific key name. + + +## Setting Up Windsurf + +There are two ways to set up Pieces MCP for Windsurf: use the Pieces CLI for automatic configuration, or configure manually. + +### Method 1: CLI Install (Recommended) + +The Pieces CLI can automatically configure Pieces MCP for Windsurf—no manual config editing required. + + + + Install the [Pieces CLI](/products/cli/get-started) if you haven't already. + + + In your terminal, run: + + ```bash + pieces mcp setup + ``` + + + A platform selection menu appears with options: *VS Code*, *Cursor*, *Claude Desktop*, *Windsurf*, *Claude Code*, *Raycast*, and *Warp*. Use the arrow keys to navigate to *Windsurf*, then press `return` (macOS) or `enter` (Windows/Linux) to auto-install. + + + +### Method 2: Manual Configuration + +Windsurf stores its MCP configuration in a global config file. Edit `~/.codeium/windsurf/mcp_config.json`: + +### Local Setup (Streamable HTTP — recommended) + +```json +{ + "mcpServers": { + "pieces": { + "serverUrl": "http://localhost:39300/model_context_protocol/2025-03-26/mcp" + } + } +} +``` + +### Adding via MCP Marketplace + + + + Open the Cascade panel in Windsurf. + + + + Click the `MCP icon` to open the MCP Marketplace. + + + + Search for Pieces, or click `Add custom` and enter your MCP URL. + + + +## Using Pieces MCP Server in Windsurf + +Once integrated, you can utilize [Pieces LTM](/products/core-dependencies/pieces-os#ltm-27) directly in Windsurf through the Cascade panel. + + + + Open the Cascade AI panel in Windsurf. + + + + Check the MCP tools section—Pieces LTM tools should appear. Ask Cascade: *"What Pieces tools are available?"* + + + + Ask context-rich questions about your workflow. For example: *"What was I working on yesterday?"* or *"Show me similar code snippets to this React component."* + + + + + Check out this [MCP-specific prompting guide](/products/mcp/prompting) if you want to effectively utilize the Long-Term Memory Engine (LTM-2.7) with your new Pieces MCP server. + + +## Updating + +Edit `~/.codeium/windsurf/mcp_config.json`, update the `serverUrl`, then restart Windsurf. + +## Troubleshooting + +If you're experiencing issues integrating Pieces MCP with Windsurf: + +1. **Verify PiecesOS Status**: Ensure [PiecesOS is actively running](/products/core-dependencies/pieces-os/troubleshooting) on your system. + +2. **Confirm LTM Engine Activation**: Make sure the [Long-Term Memory Engine (LTM-2.7) is enabled in PiecesOS](/products/core-dependencies/pieces-os/quick-menu#ltm-2-engine). + +3. **Use serverUrl, Not url**: Windsurf requires the `serverUrl` key—using `url` will not work. + +4. **Restart Windsurf**: After editing `mcp_config.json`, restart Windsurf for changes to take effect. + +5. **Disable a Server**: Add `"disabled": true` to the server config object if you need to temporarily disable Pieces MCP. + +*** + +You're now set to enhance your Windsurf workflow with powerful context retrieval through Pieces MCP. Happy coding! diff --git a/public/content/mcp/zed.md b/public/content/mcp/zed.md new file mode 100644 index 0000000..ef18d51 --- /dev/null +++ b/public/content/mcp/zed.md @@ -0,0 +1,131 @@ +--- +title: Pieces MCP + Zed Integration +path: /mcp/zed +visibility: PUBLIC +status: PUBLISHED +description: The Pieces MCP integration with Zed lets you use Pieces Long-Term Memory in the Zed editor using an stdio-to-HTTP bridge, enhancing your coding workflow with context-aware AI assistance. +metaTitle: Integrate Pieces Model Context Protocol (MCP) with Zed +metaDescription: Learn how to integrate Pieces MCP with Zed. Zed uses stdio only—connect via mcp-remote bridge to access Long-Term Memory. +--- + + + +*** + +## Get Started + +Integrating the [Pieces MCP](/products/mcp/get-started) with Zed brings your workflow context directly into the Zed editor. Because Zed currently supports **stdio only** (not native HTTP), you'll use an stdio-to-HTTP bridge such as [mcp-remote](/products/mcp/mcp-remote) to connect to PiecesOS. + +## Prerequisites + +There are **three** prerequisites for integrating Pieces with Zed: + + + + Make sure that PiecesOS is installed and running. This is *required* for the MCP server to communicate with your workflow data. + + + + Enable the Long-Term Memory Engine (LTM-2.7) through the Pieces Desktop App or the [PiecesOS Quick Menu](/products/core-dependencies/pieces-os/quick-menu) in your toolbar. + + + + The `mcp-remote` bridge requires Node.js. Ensure Node.js and `npm` are installed. + + + + Install `mcp-remote` globally with a pinned version for security: + + ```bash + npm install -g mcp-remote@0.1.38 + ``` + + See [MCP Bridge](/products/mcp/mcp-remote) for why we recommend a locally installed binary over `npx`. + + + +### Installing PiecesOS & Configuring Permissions + +Follow the instructions below for a detailed guide on setting up and configuring PiecesOS to correctly pass captured workflow context to the Pieces MCP server. + + + +## Setting Up Zed with mcp-remote Bridge + +Zed uses a custom `context_servers` key (not `mcpServers` or `servers`). Because Zed does not support HTTP MCP servers natively, you must use the `mcp-remote` bridge. + +### Config File Location + +| Scope | Path | +|-------|------| +| **User settings** | `~/.config/zed/settings.json` (Linux/macOS) | +| **Project settings** | `.zed/settings.json` in your project root | + +### Local Setup (same machine as PiecesOS) + +Add to `~/.config/zed/settings.json`: + +```json +{ + "context_servers": { + "pieces": { + "command": { + "path": "mcp-remote", + "args": [ + "http://localhost:39300/model_context_protocol/2024-11-05/sse" + ], + "env": {} + }, + "settings": {} + } + } +} +``` + + + The port (e.g., `39300`) may vary. Find your current PiecesOS port in the PiecesOS Quick Menu under **Model Context Protocol (MCP) Servers**. + + +### Alternative: supergateway Bridge + +You can also use `supergateway` instead of `mcp-remote`. Install with `npm install -g supergateway`, then use `"path": "supergateway"` and `"args": ["--sse", "http://localhost:39300/model_context_protocol/2024-11-05/sse"]`. For security, prefer a locally installed binary over `npx`. + +## Using Pieces MCP Server in Zed + +Once integrated, you can utilize [Pieces LTM](/products/core-dependencies/pieces-os#ltm-27) directly in Zed's AI assistant panel. + + + + Open the AI assistant panel in Zed. + + + + Ask: *"What context tools do you have?"* Pieces LTM tools should be available. + + + + Ask context-rich questions about your workflow, such as: *"What was I working on yesterday?"* + + + +## Updating + +Edit your `settings.json`, update the URL in the `args` array, and save. Zed reloads context servers on config change. + +## Troubleshooting + +If you're experiencing issues integrating Pieces MCP with Zed: + +1. **Verify PiecesOS Status**: Ensure [PiecesOS is actively running](/products/core-dependencies/pieces-os/troubleshooting) on your system. + +2. **Use context_servers**: Zed uses `context_servers`, not `mcpServers` or `servers`. + +3. **mcp-remote: command not found**: Run `npm install -g mcp-remote@0.1.38` and ensure the global npm bin directory is in your PATH. + +4. **Bridge process crashes**: Check that PiecesOS is running and the SSE endpoint responds. You can test with: `curl http://localhost:39300/.well-known/version` + +5. **No tools visible**: Restart Zed; ensure `mcp-remote` is in your PATH. + +*** + +You're now set to enhance your Zed workflow with powerful context retrieval through Pieces MCP. Happy coding! diff --git a/public/content/meet-pieces.md b/public/content/meet-pieces.md index 06f7853..e7c3d35 100644 --- a/public/content/meet-pieces.md +++ b/public/content/meet-pieces.md @@ -11,7 +11,6 @@ ogImage: "https://storage.googleapis.com/hashnode_product_documentation_assets/o -*** ## Introducing Pieces diff --git a/public/content/meet-pieces/troubleshooting/macos.md b/public/content/meet-pieces/troubleshooting/macos.md index 9a2f609..4eb58e2 100644 --- a/public/content/meet-pieces/troubleshooting/macos.md +++ b/public/content/meet-pieces/troubleshooting/macos.md @@ -29,22 +29,22 @@ If you’re experiencing difficulties installing PiecesOS or the Pieces Desktop If you’re unsure which `.dmg` or `.pkg` you need based on your device’s CPU, [click here.](/products/meet-pieces/troubleshooting/macos#checking-cpu-type) -### via PKG Files - -Make sure to select the correct Pieces `.pkg` for your macOS device—Apple Silicon (ARM) or Intel. - -| **Apple Silicon (ARM)** | **Intel** | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Download Pieces PKG for macOS (Apple Silicon / ARM) | Download Pieces PKG for macOS (Intel) | - ### via DMG Files Make sure to select the correct Pieces `.dmg` files for your macOS device—Apple Silicon (ARM) or Intel. | **Apple Silicon (ARM)** | **Intel** | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Download Pieces Desktop App DMG for macOS (ARM) | Download Pieces Desktop App DMG for macOS (Intel) | | Download PiecesOS DMG for macOS (ARM) | Download PiecesOS DMG for macOS (Intel) | -| [Download Pieces Desktop App DMG for macOS (ARM)](https://builds.pieces.app/stages/production/pieces_for_x/dmg-arm64/download?download=true\&product=DOCUMENTATION_WEBSITE) | Download Pieces Desktop App DMG for macOS (Intel) | + +### via PKG Files + +Make sure to select the correct Pieces `.pkg` for your macOS device—Apple Silicon (ARM) or Intel. + +| **Apple Silicon (ARM)** | **Intel** | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Download Pieces PKG for macOS (Apple Silicon / ARM) | Download Pieces PKG for macOS (Intel) | ### via Homebrew diff --git a/public/content/meet-pieces/windows-installation-guide.md b/public/content/meet-pieces/windows-installation-guide.md index 45bd3d6..b6534e0 100644 --- a/public/content/meet-pieces/windows-installation-guide.md +++ b/public/content/meet-pieces/windows-installation-guide.md @@ -75,7 +75,7 @@ If you prefer an alternative installation method aside from the `.appinstaller` If you cannot use the `.appinstaller` method for any reason, you can also install Pieces via `.exe`. - + *Alternative Method* Windows 10 (20H0) or higher required. diff --git a/public/content/organizations-and-teams.md b/public/content/organizations-and-teams.md index 65a1533..ad6c5d1 100644 --- a/public/content/organizations-and-teams.md +++ b/public/content/organizations-and-teams.md @@ -3,9 +3,9 @@ title: Organizations & Teams path: /desktop/organizations-and-teams visibility: PUBLIC status: PUBLISHED -description: Create and manage organizations and teams to collaborate with others, share resources, and maintain consistent settings across your team in Pieces. +description: Create and manage organizations to collaborate with others, share resources, and maintain consistent settings across your organization in Pieces. metaTitle: Organizations & Teams in Pieces Desktop | Pieces Docs -metaDescription: Learn how to create organizations, invite team members, manage team settings, and collaborate effectively with your team in Pieces. +metaDescription: Learn how to create organizations, invite members, manage settings, and collaborate effectively with your organization in Pieces. --- @@ -15,13 +15,12 @@ metaDescription: Learn how to create organizations, invite team members, manage /> -*** ## Creating and Joining Organizations -Create a new organization to start collaborating with your team, or accept an invitation to join an existing organization. As an organization owner, you'll have full control over team settings, member access, and shared resources. +Create a new organization to start collaborating with your team, or accept an invitation to join an existing organization. As an organization owner, you'll have full control over organization settings, member access, and shared resources. - + > Account settings page showing Organizations & Teams section with Create organization button @@ -33,21 +32,21 @@ Create a new organization to start collaborating with your team, or accept an in As an organization owner or admin, you can manage members, configure settings, control billing, and oversee all aspects of your organization. Access powerful admin features to maintain team-wide consistency and control. - + -> Organization overview page showing updates, members, teams, billing, and settings options +> Organization Home page showing management tools, setup instructions, and resource links - Explore organization management features including member management, billing, teams, and settings configuration. + Explore organization management features including member management, billing, and settings configuration. ## Organization Member Guide -As a member of an organization, you can collaborate with your team, post updates, view shared content, and participate in team activities. Understand what you can do and how your role affects your access and permissions. +As a member of an organization, you can collaborate with your team, view shared resources, and participate in team activities. Understand what you can do and how your role affects your access and permissions. - + -> Organization overview page from a member's perspective showing available features and limitations +> Organization Home page from a member's perspective showing available features Learn about member features, permissions, and how to effectively collaborate within your organization. diff --git a/public/content/organizations-and-teams/billing.md b/public/content/organizations-and-teams/billing.md index c853723..6169bdf 100644 --- a/public/content/organizations-and-teams/billing.md +++ b/public/content/organizations-and-teams/billing.md @@ -10,103 +10,100 @@ metaDescription: Guide to managing organization subscriptions, seat counts, bill ## Billing -The Billing tab allows you to manage your organization's subscription, view billing details, update seat counts, and configure billing addresses. All billing changes are processed through the *Paddle* payment system. +The Billing page allows you to manage your organization's subscription, view billing details, adjust seat counts, and add billing contact information. - + -> Billing tab showing subscription details, seat count, and billing address options +> Billing tab showing subscription information, seats, and billing contact +## How to Get to Billing -### Viewing Subscription Information + + + Go to [portal.pieces.app](https://portal.pieces.app) and sign in. Select your organization from the *sidebar* dropdown if needed. + + + Click `Billing` in the *sidebar* navigation. + + -Access your current subscription details, billing amounts, and important dates. +## Viewing Subscription Information - - From your *organization overview* page, click `Billing` in the *sidebar* navigation. + + Go to [portal.pieces.app](https://portal.pieces.app), sign in, and select your organization. Click `Billing` in the sidebar. - - The *Billing* page displays your current subscription plan (e.g., "Enterprise Seat Yearly") and subscription status (Active or Canceled). + The *Subscription Information* section displays your current plan (e.g., "Enterprise Seat Yearly") and subscription status shown as an *Active* or *Canceled* badge. - - View important billing information: - * **Billing Amount**: Your subscription cost (e.g., "$275.99 / year") - * **Total for X seats**: Total cost based on current seat count - * **Subscription Started**: Date when your subscription began - * **Next Billing Date**: When your next payment will be processed + + The *Billing* section shows your pricing breakdown: + * **Price** — Cost per seat per billing period (e.g., "$275.99/seat per year") + * **Total** — Combined cost for all seats (e.g., "$275.99 per year") + * **Next billing date** — When your next payment will be processed + * **Started** — Date when your subscription began -### Changing Seat Count +### Changing or Managing Your Plan -Update the number of seats in your subscription to accommodate more or fewer team members. +Update your subscription plan or apply discounts from the *Subscription Information* section. - - In the *Billing* page, find the *seat count* field. Use the `+` and `-` buttons to increase or decrease the number of seats, or type a number directly into the field. + + Click the `Change plan` button to view available plans and switch your subscription to a different billing period or tier. - - Note the minimum seats requirement shown below the seat count (e.g., "Minimum seats: 1 (based on 1 active member)"). You cannot set seats below this minimum. + + Click the `Add discount` button to apply a discount code to your subscription. + - - Click the `Update Seats` button to proceed with the seat change. This will open the billing window where you can review the new total and complete payment for the updated subscription. +### Changing Seat Count + +Update the number of seats in your subscription to accommodate more or fewer team members. + + + + In the *Seats* section, use the `+` and `-` buttons to increase or decrease the number of seats, or type a number directly into the field. - - In the *billing* window, review the updated subscription details and complete payment through *Paddle*. Your seat count will update immediately after payment confirmation. + + Below the seat count, a message shows how many members you have and the minimum seats required (e.g., "You have 1 member, so you need at least 1 seats"). You cannot set seats below this minimum. -## Configuring Billing Address +## Billing Contact -Configure or update your organization's billing address for invoices and payment processing. +Add or update billing contact information for invoices and payment correspondence. The *Billing Contact* section is located below the *Subscription Information* and *Seats* sections on the Billing page. - + -> Billing Address section showing address fields and edit button +> Billing Contact section with fields for name, email, phone, and address - - Scroll down on the *Billing* page to find the *Billing Address* section. - - - - Click the `Edit Address` button in the top right of the *Billing Address* section. + + From your organization's `Home` page, click `Billing` in the *sidebar* navigation. - - Fill in all required *billing address* fields: - * *Billing Contact* - * *Billing Email* - * *Billing Phone* - * *Billing Country* - * *Billing Street Address* - * *Billing City* - * *Billing State* - * *Billing ZIP Code* + + Scroll down past the *Subscription Information* and *Seats* sections. The *Billing Contact* section appears below, with fields for Name, Email, Phone, Country, Street address, City, State, and ZIP Code. - - Click `Save` to save your billing address. This address will be used for invoices and payment processing. + + If no billing contact is on file, click the `Add` button to enter your billing contact details. If a contact exists, edit the fields directly. A save reminder appears at the bottom of the page. Click `Save` to apply. ## Understanding Seat Minimums -Your organization must maintain a minimum number of seats based on your active member count. Understanding seat minimums helps you manage your subscription effectively. - -Key points about seat minimums: - -* **Active Members** - Each active member requires one seat -* **Minimum Calculation** - Minimum seats = Number of active members -* **Seat Reduction** - You can only reduce seats if you first remove members to free up seats -* **Seat Increase** - You can add seats at any time, which will be billed according to your subscription plan +Your organization must maintain a minimum number of seats based on your active member count. -When you try to reduce seats below the minimum, you'll see a warning indicating how many active members you have and the minimum seat requirement. +* **Active Members** — Each active member requires one seat +* **Minimum Calculation** — Minimum seats equals the number of active members +* **Seat Reduction** — You can only reduce seats if you first remove members to free up seats +* **Seat Increase** — You can add seats at any time, billed according to your subscription plan *** diff --git a/public/content/organizations-and-teams/creating-and-joining-organizations.md b/public/content/organizations-and-teams/creating-and-joining-organizations.md index ade49ab..4e894e8 100644 --- a/public/content/organizations-and-teams/creating-and-joining-organizations.md +++ b/public/content/organizations-and-teams/creating-and-joining-organizations.md @@ -14,13 +14,13 @@ Create a new organization to start collaborating with your team, or accept an in -> Account settings page showing Organizations & Teams section with Create organization button +> Modal showing the walkthrough of creating an organization ## Creating an Organization Set up a new organization to start collaborating with your team. The creation process includes selecting a subscription plan and configuring initial settings. - + @@ -90,4 +90,4 @@ Accept an invitation to join an existing organization and start collaborating wi ## Next Steps -Now that you've created or joined an organization, learn about [managing organizations](/products/organizations-and-teams/managing-organizations) to explore member management, billing, and settings, or check out the [Organization Overview](/products/organizations-and-teams/organization-overview) to learn how to navigate your organization dashboard. +Now that you've created or joined an organization, learn about [managing organizations](/products/organizations-and-teams/managing-organizations) to explore member management, billing, and settings, or check out the [Organization Home page](/products/organizations-and-teams/organization-overview) to learn how to navigate your organization dashboard. diff --git a/public/content/organizations-and-teams/inviting-members.md b/public/content/organizations-and-teams/inviting-members.md index 0454be1..9229785 100644 --- a/public/content/organizations-and-teams/inviting-members.md +++ b/public/content/organizations-and-teams/inviting-members.md @@ -10,12 +10,23 @@ metaDescription: Step-by-step guide to inviting members to your organization, in ## Inviting Members -Add team members to your organization by sending invitations. You can invite members individually, add multiple members at once, or bulk upload invitations via CSV file. Each member must have an available seat in your subscription. +Add team members by sending invitations. You can invite one at a time, add multiple, or bulk upload via CSV. Each member needs an available seat. > Invite members modal showing email input, role selection, and CSV upload option +## How to Open the Invite Modal + + + + Go to [portal.pieces.app](https://portal.pieces.app) and sign in. Select your organization from the *sidebar* dropdown if needed. + + + Click the `Invite people` button in the top right corner. The button is available from any tab (Home, Members, Models, Long Term Memory, Billing, Settings). The invite modal opens. + + + ## Understanding Member Roles Before inviting members, understand the different roles available and what each role can do within your organization. @@ -38,13 +49,10 @@ Invite team members using different methods depending on your needs and team siz ### Inviting a Single Member -Invite one team member at a time with a specific role assignment. - - - From the *organization overview* page, click the `Invite people` button in the top right corner. + + Go to [portal.pieces.app](https://portal.pieces.app), sign in, and select your organization. Click `Invite people` in the top right corner (available from any tab). - In the *Invite Organization Members* modal, enter the email address of the person you want to invite in the *email input* field. @@ -60,11 +68,9 @@ Invite one team member at a time with a specific role assignment. ### Inviting Multiple Members -Add multiple members in a single invitation flow. - - - Click the `Invite people` button from the *organization overview* page. + + Go to [portal.pieces.app](https://portal.pieces.app), sign in, and select your organization. Click `Invite people` in the top right corner (available from any tab). @@ -86,11 +92,9 @@ Add multiple members in a single invitation flow. ### Bulk Inviting via CSV -Upload a CSV file to invite multiple members at once, which is efficient for large teams. - - - Click the `Invite people` button from the *organization overview* page. + + Go to [portal.pieces.app](https://portal.pieces.app), sign in, and select your organization. Click `Invite people` in the top right corner (available from any tab). @@ -125,7 +129,7 @@ Before inviting members, check your current seat usage: - From your *organization overview* page, click `Members` in the *sidebar* navigation. + From your organization's `Home` page, click `Members` in the *sidebar* navigation. At the top of the *Members* page, you'll see the *Seat Usage* card showing how many seats are used out of your total subscription (e.g., "1 of 1 seats used"). @@ -135,7 +139,7 @@ Before inviting members, check your current seat usage: - + > Members tab showing seat usage card with current usage and total seats diff --git a/public/content/organizations-and-teams/managing-members.md b/public/content/organizations-and-teams/managing-members.md index e17b3b0..df1ab69 100644 --- a/public/content/organizations-and-teams/managing-members.md +++ b/public/content/organizations-and-teams/managing-members.md @@ -12,17 +12,26 @@ metaDescription: Comprehensive guide to managing organization members, roles, an The Members tab provides a comprehensive view of all organization members, seat usage, pending invitations, and member management tools. Use this section to track membership, update roles, and manage access. - + > Members tab showing seat usage, current members list, and pending invites -## Viewing Members and Seat Usage +## How to Get to Members -Access the Members tab to see current members, seat allocation, and pending invitations. + + + Go to [portal.pieces.app](https://portal.pieces.app) and sign in. Select your organization from the *sidebar* dropdown if needed. + + + Click `Members` in the *sidebar* navigation. + + + +## Viewing Members and Seat Usage - From your *organization overview* page, click `Members` in the *sidebar* navigation. + From your organization's `Home` page, click `Members` in the *sidebar* navigation. @@ -72,7 +81,7 @@ Update member roles to change their permissions and access levels within the org - Click `Save` to apply the role change. The member's permissions will update immediately. + A save reminder appears at the bottom of the page. Click `Save` to apply the role change. The member's permissions will update immediately. @@ -113,4 +122,4 @@ Understanding how seats work helps you manage your organization effectively: ## Next Steps -Now that you understand member management, learn about [billing](/products/organizations-and-teams/billing) to manage your subscription and seat count, or explore [managing teams](/products/organizations-and-teams/managing-teams) to organize members into smaller groups. +Now that you understand member management, learn about [billing](/products/organizations-and-teams/billing) to manage your subscription and seat count. diff --git a/public/content/organizations-and-teams/managing-organizations.md b/public/content/organizations-and-teams/managing-organizations.md index d0974af..50f13f5 100644 --- a/public/content/organizations-and-teams/managing-organizations.md +++ b/public/content/organizations-and-teams/managing-organizations.md @@ -3,9 +3,9 @@ title: Managing Organizations path: /desktop/organizations-and-teams/managing-organizations visibility: PUBLIC status: PUBLISHED -description: Learn how to manage your organization as an owner or admin, including member management, billing, teams, and settings. +description: Learn how to manage your organization as an owner or admin, including member management, billing, and settings. metaTitle: Managing Organizations | Pieces Docs -metaDescription: Comprehensive guide to managing organizations, members, teams, billing, and settings in Pieces. +metaDescription: Comprehensive guide to managing organizations, members, billing, and settings in Pieces. --- @@ -17,16 +17,16 @@ metaDescription: Comprehensive guide to managing organizations, members, teams, *** -## Organization Overview +## Organization Home -Access your organization dashboard to view updates, post content, invite members, and navigate to different sections of your organization. +Access your organization's Home page to get set up, navigate to management tools, and find helpful resources for your team. - + -> Organization overview page showing recent updates, post update button, and sidebar navigation +> Organization Home page showing setup instructions, management links, and resource cards - Learn how to navigate your organization dashboard, post updates, and interact with team content. + Learn how to navigate your organization Home page, access setup resources, and manage your organization. ## Inviting Members @@ -45,7 +45,7 @@ Add team members to your organization by sending invitations. You can invite mem View and manage all organization members, track seat usage, handle pending invitations, and update member roles and permissions. - + > Members tab showing seat usage, current members list, and pending invites @@ -53,40 +53,52 @@ View and manage all organization members, track seat usage, handle pending invit Learn how to manage member roles, view seat usage, and handle member-related tasks. -## Managing Teams +## Billing -Create and manage teams within your organization to organize members into smaller groups. Teams can post updates and collaborate on specific projects. +Manage your organization's subscription, update seat counts, view billing information, and configure billing addresses. - + -> Teams dropdown showing team list and create team option +> Billing tab showing subscription details, seat count, and billing address options - - Explore how to create teams, manage team members, and organize your organization into smaller groups. + + Learn how to manage subscriptions, update seats, and configure billing information. -## Billing +## Models (Organization Management for AI) -Manage your organization's subscription, update seat counts, view billing information, and configure billing addresses. +The Models section is the organization management area for AI configuration. It appears as a top-level item in the sidebar with two tabs: *Models* (general settings, allow-lists, processing mode) and *API Keys* (OpenAI, Anthropic, GCP credentials). - + -> Billing tab showing subscription details, seat count, and billing address options +> Models section showing general settings and API keys configuration - - Learn how to manage subscriptions, update seats, and configure billing information. + + Configure model allow-lists, processing mode, and API keys for your organization. + + +## Long Term Memory + +Configure context capture settings, application sources, denied websites, and default models for memory processing. Long Term Memory is a top-level item in the sidebar. + + + +> Long Term Memory section showing Memory Formation toggles and Default Models + + + Configure context capture, application sources, denied websites, and default models for LTM. ## Organization Settings -Configure organization-wide settings that sync to team members' Pieces Desktop and PiecesOS installations. Control features, API keys, models, and LTM sources for your entire organization. +Configure organization-wide settings that sync to team members' Pieces Desktop and PiecesOS installations. Settings includes General (contact info, address) and Features (External Cloud, Analytics toggles). - + -> Settings page showing tabs for General, Teams, Features, API Keys, Models, LTM Sources, and LTM Websites +> Settings page showing tabs for General and Features - Discover how to configure organization settings, manage feature toggles, and control team-wide configurations. + Discover how to configure organization settings and control feature toggles. *** diff --git a/public/content/organizations-and-teams/member-overview.md b/public/content/organizations-and-teams/member-overview.md index 2c4414f..3bb07a2 100644 --- a/public/content/organizations-and-teams/member-overview.md +++ b/public/content/organizations-and-teams/member-overview.md @@ -3,26 +3,18 @@ title: Member Overview path: /desktop/organizations-and-teams/member-overview visibility: PUBLIC status: PUBLISHED -description: Learn how to navigate your organization dashboard, post updates, and interact with team content as a member. +description: Learn how to navigate your organization dashboard and collaborate with your team as a member. metaTitle: Member Overview | Pieces Docs -metaDescription: Guide to using the organization overview page as a Read or Write member. +metaDescription: Guide to using the organization Home page as a Read or Write member. --- ## Member Overview -As a member of an organization, you can access the organization overview page to view updates, post content, and interact with your team. Your view is similar to owners and admins, but with some limitations on administrative features. - - - -> Organization overview page from a member's perspective showing available features +As a member of an organization, you can access the organization's Home page to get set up with Pieces, view resources, and collaborate with your team. Your view is similar to owners and admins, but with limitations on administrative features. ## Accessing Your Organization -Navigate to your organization from your Personal Workspace to access the overview page. - - - -> Personal Workspace showing organization dropdown and navigation options +Navigate to your organization from your Personal Workspace to access the Home page. @@ -33,116 +25,30 @@ Navigate to your organization from your Personal Workspace to access the overvie In the *sidebar*, click the *organization dropdown* at the top. Select the organization you want to access from the list of organizations you belong to. - - The organization overview page displays recent updates, team activity, and provides access to member-available features through the sidebar navigation. - - - -## Working with Updates - -Post, view, interact with, and manage content updates on your organization overview page. - - - -### Posting Content Updates - -Share updates, announcements, or information with your team by posting content updates to the organization. - - - - On the organization overview page, click the `Post Update` button in the top right (or the pencil icon next to "Recent Updates"). - - - - In the *Create Content Update* modal, fill in: - * **Title**: Enter a title describing what the update is about - * **Content**: Add the details of your update in the content field - * **Tags**: Add comma-separated tags (e.g., `# feature, bug-fix, announcement`) - - - - Click `Post Update` to publish your update. The update will appear in the *Recent Updates* section for all organization members to see. - - - -### Viewing and Interacting with Updates - -View team updates, add reactions, and comment on posts to engage with your team. - - - - Scroll through the *Recent Updates* section to see all posted updates. Each update shows the author, timestamp, tags, and content. - - - - Click the smiley face icon below an update to add a reaction. This helps team members quickly acknowledge updates. - - - - Click on the *comments* section (showing "X comments") to view existing comments on an update. - - - - Click the arrow down next to "comments" to expand the *comment* section. Type your comment in the text box and click the submit button (paper airplane icon) to post your comment. - - - -### Editing Your Updates - -Edit your own posted updates to update information or correct mistakes. Note that tags cannot be edited after posting. - - - - Find your update and click the pencil icon next to it. You can only edit updates you created. - - - - Update the title and *content* fields as needed. Tags cannot be modified after posting. - - - - Click the `Save` button (with checkmark icon) to save your changes. Click `Cancel` to discard changes. - - - -### Deleting Your Updates - -Remove your own updates that are no longer relevant or were posted by mistake. - - - - Find your update and click the trash can icon next to it. You can only delete updates you created. - - - - Confirm the deletion in the browser *popup*. This action cannot be undone. + + The Home page displays setup instructions, management links, and resources for your organization. ## Understanding Member Limitations -As a member, you have access to collaboration features but cannot access administrative functions. Understanding these limitations helps you know what you can do and when you might need to contact an Owner or Admin. +As a member, you have access to collaboration features but cannot access administrative functions. Members cannot access: * Member management (inviting, removing, or changing roles) * Billing and subscription management * Organization settings configuration - * Team creation or deletion (from settings) These features are reserved for Owners and Admins. If you need administrative access, contact your organization owner or admin. ## Available Sidebar Navigation -As a member, you can access: - The *sidebar* includes the following navigation options available to members: -* **Overview** - Current page showing recent updates and team activity -* **Members** - View organization members (read-only access) -* **Teams** - View and access teams within the organization -* **Support** - Quick access to support resources +* **Home** — Dashboard showing setup, management, and resource links +* **Members** — View organization members (read-only access) Administrative sections like *Billing* and *Settings* are not visible to members and are reserved for Owners and Admins. diff --git a/public/content/organizations-and-teams/member-permissions.md b/public/content/organizations-and-teams/member-permissions.md index 5220b61..0a12a77 100644 --- a/public/content/organizations-and-teams/member-permissions.md +++ b/public/content/organizations-and-teams/member-permissions.md @@ -16,6 +16,10 @@ Understanding your role and permissions helps you know what you can do within yo Organizations have four main roles with different permission levels. Each role determines what you can do within the organization. + + +> Members tab showing seat usage and member list with role indicators + The four roles are: * **Owner** - Full control including organization deletion @@ -34,21 +38,13 @@ Members with the Read role have the most limited access. They can view content b **What Read members CAN do:** -* View organization overview and recent updates +* View organization Home page and resources * View organization members list -* View teams and team updates -* Add reactions to updates -* View comments on updates -* Access support resources **What Read members CANNOT do:** -* Post updates or create content -* Comment on updates * Invite or manage members * Access billing or settings -* Create or delete teams -* Edit or delete any content ### Write Role Permissions @@ -56,18 +52,12 @@ Members with the Write role can create and edit content but cannot manage the or **What Write members CAN do:** * Everything Read members can do, plus: -* Post content updates -* Comment on updates -* Edit their own updates -* Delete their own updates * Create and manage their own content **What Write members CANNOT do:** * Invite or manage members * Change member roles * Access billing or settings -* Create or delete teams (from settings) -* Edit or delete content created by others * Manage organization-wide settings ### Admin Role Permissions @@ -80,7 +70,6 @@ Admins have extensive access but cannot delete the organization. * Change member roles * Access billing and manage subscriptions * Configure organization settings -* Create and delete teams * Manage all organization content **What Admins CANNOT do:** @@ -102,7 +91,7 @@ Your role determines what you see and can do in the organization interface: * **Sidebar Navigation** - Read and Write members see fewer options than Admins and Owners * **Action Buttons** - Some buttons (like `Invite people`) only appear for Admins and Owners * **Settings Access** - Only Admins and Owners can access the *Settings* and *Billing* sections -* **Content Management** - Your ability to create, edit, and delete content depends on your role +* **Content Management** - Your ability to manage content depends on your role ## Requesting Access Changes diff --git a/public/content/organizations-and-teams/organization-member-guide.md b/public/content/organizations-and-teams/organization-member-guide.md index 710ec1b..0ffd642 100644 --- a/public/content/organizations-and-teams/organization-member-guide.md +++ b/public/content/organizations-and-teams/organization-member-guide.md @@ -11,18 +11,18 @@ metaDescription: Learn about member features, permissions, and how to effectivel ## Organization Member Guide -As a member of an organization, you can collaborate with your team, post updates, view shared content, and participate in team activities. This guide explains what you can do as a member and how your role affects your access and permissions. +As a member of an organization, you can collaborate with your team, view shared resources, and participate in team activities. This guide explains what you can do as a member and how your role affects your access and permissions. -## Organization Overview +## Organization Home -Access your organization dashboard to view updates, post content, and interact with your team. Members can participate in team collaboration while having limited administrative access. +Access your organization's Home page to get set up with Pieces and collaborate with your team. Members can view resources and participate in team activities while having limited administrative access. - + -> Organization overview page from a member's perspective showing available features +> Organization Home page from a member's perspective showing available features - Learn how to navigate your organization dashboard, post updates, and interact with team content as a member. + Learn how to navigate your organization Home page and collaborate with your team as a member. ## Understanding Member Permissions diff --git a/public/content/organizations-and-teams/organization-overview.md b/public/content/organizations-and-teams/organization-overview.md index cc7c942..0b566c2 100644 --- a/public/content/organizations-and-teams/organization-overview.md +++ b/public/content/organizations-and-teams/organization-overview.md @@ -3,137 +3,65 @@ title: Organization Overview path: /desktop/organizations-and-teams/organization-overview visibility: PUBLIC status: PUBLISHED -description: Learn how to navigate your organization dashboard, post updates, and interact with team content as an owner or admin. +description: Learn how to navigate your organization's Home page, access setup resources, and manage your organization from the dashboard. metaTitle: Organization Overview | Pieces Docs -metaDescription: Guide to using the organization overview page, posting updates, and managing organization content. +metaDescription: Guide to using the organization Home page, accessing setup resources, managing members, and navigating organization features. --- -## Organization Overview +## Organization Home -The organization overview page is your main dashboard for managing and interacting with your organization. From here, you can post updates, view team activity, invite members, and navigate to different sections of your organization. +The Home page is your central dashboard for managing your organization in the Pieces User Portal. The sidebar gives you quick access to Members, Models, Long Term Memory, Billing, and Settings. - + -> Organization overview page showing recent updates, post update button, and sidebar navigation +> Organization Home page with Setup, Manage, and Resources sections -## Accessing Your Organization - -Navigate to your organization from your Personal Workspace to access the overview page. +## How to Get to Your Organization - - Click your `User Profile` in the top left, then click `Settings` and select `Account` to access your Personal Workspace. + + Go to [portal.pieces.app](https://portal.pieces.app) and sign in. Or from Pieces Desktop, click your `User Profile` in the top left → `Settings` → `Account`. - - - In the *sidebar*, click the *organization dropdown* at the top. Select the organization you want to access from the list of organizations you belong to. + + In the *sidebar*, click the *organization dropdown* at the top (shows your org name). Select the organization you want to access. - - - The organization overview page displays recent updates, team activity, and provides access to all organization features through the sidebar navigation. + + The Home page shows setup instructions, management links, and resources. Use the sidebar to jump to any section. -## Working with Updates - -Post, view, interact with, and manage content updates on your organization overview page. - - +## How to Get to Each Section -### Posting Content Updates - -Share updates, announcements, or information with your team by posting content updates to the organization. +Use the sidebar to reach the main organization areas: - - On the organization overview page, click the `Post Update` button in the top right (or the pencil icon next to "Recent Updates"). - - - - In the *Create Content Update* modal, fill in: - * **Title**: Enter a title describing what the update is about - * **Content**: Add the details of your update in the content field - * **Tags**: Add comma-separated tags (e.g., `# feature, bug-fix, announcement`) - - - - Click `Post Update` to publish your update. The update will appear in the *Recent Updates* section for all organization members to see. + + Click `Members` in the sidebar to view members, seat usage, and pending invites. Click `Invite people` to add new members. - - -### Viewing and Interacting with Updates - -View team updates, add reactions, and comment on posts to engage with your team. - - - - Scroll through the *Recent Updates* section to see all posted updates. Each update shows the author, timestamp, tags, and content. + + Click `Models` in the sidebar to configure AI models and API keys. Use the *Models* tab for provider toggles and allow-lists; use the *API Keys* tab to add credentials. - - - Click the smiley face icon below an update to add a reaction. This helps team members quickly acknowledge updates. + + Click `Long Term Memory` in the sidebar to manage context capture, blocked applications, blocked websites, and default models. - - - Click on the *comments* section (showing "X comments") to view existing comments on an update. + + Click `Billing` in the sidebar to view your plan, change seats, and manage billing contact. Owners and Admins only. - - - Click the arrow down next to "comments" to expand the *comment* section. Type your comment in the text box and click the submit button (paper airplane icon) to post your comment. + + Click `Settings` in the sidebar to configure General (org name, contact, domains) and Features (External Cloud, Analytics). Owners and Admins only. -### Editing Updates - -Edit your posted updates to update information or correct mistakes. Note that tags cannot be edited after posting. - - - - Find the update you want to edit and click the pencil icon next to the update. - - - - Update the title and *content* fields as needed. Tags cannot be modified after posting. - - - - Click the `Save` button (with checkmark icon) to save your changes. Click `Cancel` to discard changes. - - - -### Deleting Updates - -Remove updates that are no longer relevant or were posted by mistake. - - - - Find the update you want to delete and click the trash can icon next to the update. - - - - Confirm the deletion in the browser *popup*. This action cannot be undone. - - - -## Understanding Sidebar Navigation - -The *sidebar* provides quick access to all organization features. Use the *sidebar* to navigate between different sections of your organization. - - - -> Organization sidebar navigation showing Overview, Members, Teams, Billing, Settings, and Support options +## Setup, Manage, and Resources -The sidebar includes the following navigation options: +The Home page body has three areas: -* **Overview** - Current page showing recent updates and team activity -* **Members** - View and manage organization members, track seat usage, and handle invitations -* **Teams** - Access and manage teams within the organization -* **Billing** - Manage subscription and billing information (Owners and Admins only) -* **Settings** - Configure organization settings that sync to team members (Owners and Admins only) -* **Support** - Quick access to support resources +* **Setup** — Prompts to sign in with your account email in Desktop & PiecesOS, plus buttons to open or download Pieces Desktop. +* **Manage** — Cards that link directly to Members, Models, and Billing. Click a card to jump to that section. +* **Resources** — Links to documentation, pro tips, support, and GitHub. *** ## Next Steps -Now that you understand the organization overview, learn about [inviting members](/products/organizations-and-teams/inviting-members) to grow your team, or explore [managing members](/products/organizations-and-teams/managing-members) to understand member management features. +[Invite members](/products/organizations-and-teams/inviting-members), configure [Models and API keys](/products/organizations-and-teams/settings-models), or check [Settings](/products/organizations-and-teams/organization-settings) for General and Features. diff --git a/public/content/organizations-and-teams/organization-settings.md b/public/content/organizations-and-teams/organization-settings.md index e33a635..102b8e3 100644 --- a/public/content/organizations-and-teams/organization-settings.md +++ b/public/content/organizations-and-teams/organization-settings.md @@ -5,100 +5,66 @@ visibility: PUBLIC status: PUBLISHED description: Configure organization-wide settings that sync to team members' Pieces Desktop and PiecesOS installations. metaTitle: Organization Settings | Pieces Docs -metaDescription: Learn how to configure organization settings, manage feature toggles, API keys, models, and LTM sources for your team. +metaDescription: Learn how to configure organization settings and control feature toggles for your team. --- *** -## General Settings - -Configure basic organization information, contact details, domains, and SSO integration settings. You can also delete your organization from this section. +## How to Get to Settings - + + + Go to [portal.pieces.app](https://portal.pieces.app) and sign in. Select your organization from the *sidebar* dropdown if needed. + + + Click `Settings` in the *sidebar* navigation. + + -> General settings tab showing organization name, contact info, domains, and danger zone - - - Learn how to update organization details, configure domains, and manage organization deletion. - - -## Teams Settings +## General Settings -View all teams in your organization, see member counts, and delete teams from the settings interface. +Configure basic organization information, contact details, and address. Update your organization's identity and how Pieces reaches you for billing and support. - + -> Teams settings tab showing list of teams with member counts and delete options +> General settings tab showing organization name, contact info, and address fields - - Discover how to manage teams from the settings interface and view team information. + + Learn how to update organization details, contact information, and address. ## Features Settings -Toggle organization-wide features that sync to team members' Pieces Desktop and PiecesOS. Control external cloud, analytics, processing capabilities, and workstream pattern engine settings. +Toggle organization-wide features that sync to team members' Pieces Desktop and PiecesOS. Control external cloud, analytics, and reporting features. - + -> Features settings tab showing various feature toggles and processing options +> Features settings tab showing External Cloud and Analytics toggles Learn how to enable and disable features that sync across your team's installations. -## API Keys Settings - -Configure API keys for AI services that sync to team members. Set up credentials for OpenAI, Gemini, Claude, Bedrock, and Azure OpenAI. - - - -> API Keys settings tab showing configuration options for different AI platforms - - - Explore how to configure API keys for various AI services that your team can use. - +## Models and Long Term Memory -## Models Settings +Model access, API keys, and Long Term Memory settings are managed from separate sections in the sidebar: -Control which AI models are available to your organization. Toggle model providers on or off and manage individual model access. - - - -> Models settings tab showing available model providers and individual models +* **Models** — Organization management for AI configuration. Click `Models` in the sidebar to access the Models tab (allow-lists, processing mode) and the API Keys tab (OpenAI, Anthropic, GCP credentials). +* **Long Term Memory** — Manage context capture settings, application sources, denied websites, and default models for memory processing. Click `Long Term Memory` in the sidebar to access. - Learn how to manage model access and control which AI models your team can use. + Configure model access and API keys for your organization. -## LTM Sources Settings - -Manage which applications Pieces can access for the workstream pattern engine. Add, remove, and toggle application access for your organization. - - - -> LTM Sources settings tab showing available applications and access controls - - Discover how to control which applications Pieces can access for LTM functionality. - - -## LTM Websites Settings - -Configure which websites Pieces is denied from accessing. Add individual URLs or bulk upload via CSV to control website access. - - - -> LTM Websites settings tab showing denied websites list and upload options - - - Learn how to manage denied websites and control Pieces' access to specific URLs. + Configure Long Term Memory settings and context capture. *** @@ -107,4 +73,4 @@ All organization settings automatically sync to team members' Pieces Desktop and ## Next Steps -Now that you understand organization settings, learn about [managing organizations](/products/organizations-and-teams/managing-organizations) to explore member management and billing, or check out [Account Settings](/products/desktop/configuration/account) to manage your personal account. +Now that you understand organization settings, learn about [Models and API keys](/products/organizations-and-teams/settings-models) to configure AI providers, or explore [Long Term Memory](/products/organizations-and-teams/settings-ltm-sources) to control context capture and default models. diff --git a/public/content/organizations-and-teams/settings-api-keys.md b/public/content/organizations-and-teams/settings-api-keys.md index 03fe413..b6aacf5 100644 --- a/public/content/organizations-and-teams/settings-api-keys.md +++ b/public/content/organizations-and-teams/settings-api-keys.md @@ -3,174 +3,133 @@ title: API Keys Settings path: /desktop/organizations-and-teams/settings-api-keys visibility: PUBLIC status: PUBLISHED -description: Configure API keys for AI services that sync to team members' Pieces Desktop and PiecesOS installations. +description: Configure API keys for AI services in the Models section. API Keys is a tab within Models (organization management for AI). metaTitle: API Keys Settings | Pieces Docs -metaDescription: Learn how to configure API keys for OpenAI, Gemini, Claude, Bedrock, and Azure OpenAI that your team can use. +metaDescription: Learn how to configure API keys for OpenAI, Anthropic, and GCP in the API Keys tab within the Models section. --- ## API Keys Settings -The API Keys settings tab allows you to configure API credentials for various AI services. These API keys automatically sync to all team members' Pieces Desktop and PiecesOS installations, enabling your team to use these services without individual configuration. +The API Keys tab is one of two tabs within the *Models* section—the organization management area for AI configuration. From the API Keys tab, you configure credentials for model providers (OpenAI, Anthropic, GCP). These API keys automatically sync to all team members' Pieces Desktop and PiecesOS installations, enabling your team to use these services without individual configuration. - + -> API Keys settings tab showing configuration options for different AI platforms +> API Keys tab showing OpenAI, Anthropic, and GCP configuration sections All API keys configured here automatically sync to team members' Pieces Desktop and PiecesOS installations, allowing your entire team to use these AI services with organization-managed credentials. -## Accessing API Keys Settings - -Navigate to the API Keys settings tab to configure AI service credentials. These credentials enable your team to use various AI services without individual configuration. +## How to Get to the API Keys Tab - - From your *organization overview* page, click `Settings` in the sidebar navigation. + + Go to [portal.pieces.app](https://portal.pieces.app) and sign in. Select your organization from the *sidebar* dropdown if needed. + + + Click `Models` in the *sidebar* navigation. - - Click the `API Keys` tab at the top of the *Settings* page. + On the Models page, click the `API Keys` tab at the top. ## Configuring API Keys -Set up API credentials for various AI services. Each service has its own configuration section. +Set up API credentials for model providers. Each provider has its own configuration section: OpenAI, Anthropic (Claude), and GCP Configuration. - + ### Configuring OpenAI Set up OpenAI API credentials for your organization. - - Find the *OpenAI Configuration* section in the *API Keys settings* page. - - - - Click the `+ Add Credential` button next to the *OpenAI Configuration* section. - - - - Fill in the OpenAI-specific *credential* form with your API key and any required configuration details. - - - - Click `Save` to save your OpenAI credentials. The credentials will sync to all team members. - - - -### Configuring Gemini - -Set up Google Gemini API credentials for your organization. - - - - Find the *Gemini Configuration* section in the *API Keys settings* page. + + Find the *OpenAI* section with the description "API credentials and organization settings." - - Click the `+ Add Credential` button next to the *Gemini Configuration* section. + + Click the `+ Add API Key` button next to the OpenAI section. - Fill in the Gemini-specific *credential* form with your API key and any required configuration details. + Fill in the form with: + * **Name** (required) — A descriptive name (e.g., "Personal Pro", "Production") + * **API Key** (required) — Your OpenAI API key + * **Organization ID** (optional) — For OpenAI org-specific usage + * **Project ID** (optional) — For project-specific usage + * **Custom API URL** (optional) — Defaults to `https://api.openai.com` - Click `Save` to save your Gemini credentials. + A save reminder appears at the bottom of the page. Click `Save` to save your OpenAI credentials. The credentials will sync to all team members. -### Configuring Claude +### Configuring Anthropic (Claude) Set up Anthropic Claude API credentials for your organization. - - Find the *Claude Configuration* section in the *API Keys settings* page. + + Find the *Anthropic (Claude)* section with the description "API credentials." - - Click the `+ Add Credential` button next to the *Claude Configuration* section. + + Click the `+ Add API Key` button next to the Anthropic section. - Fill in the Claude-specific *credential* form with your API key and any required configuration details. + Fill in the Anthropic-specific credential form with your API key and any required configuration details. - Click `Save` to save your Claude credentials. + A save reminder appears at the bottom of the page. Click `Save` to save your Anthropic credentials. -### Configuring Bedrock +### Configuring GCP -Set up AWS Bedrock access credentials and API keys for your organization. +Set up GCP API keys and Vertex AI service accounts for your organization. - - Find the *Bedrock Access Credentials* and *Bedrock API Keys* sections in the *API Keys settings* page. + + Find the *GCP Configuration* section with the description "Manage GCP API keys and Vertex AI service accounts." - - Click the `+ Add Credentials` button next to *Bedrock Access Credentials* to configure AWS access credentials for Bedrock service. - - - - Click the `+ Add API Key` button next to *Bedrock API Keys* to configure API keys for Bedrock service. + + Click the `+ Add API Key` button next to the GCP Configuration section. - Fill in the Bedrock-specific *credential* forms with your AWS access credentials and API keys. - - - - Click `Save` to save your Bedrock credentials. - - - -### Configuring Azure OpenAI - -Set up Azure OpenAI API configuration for your organization. - - - - Find the *Manage Azure OpenAI API configuration* section in the *API Keys settings* page. - - - - Click the `+ Add Configuration` button next to the *Azure OpenAI* section. - - - - Fill in the Azure OpenAI-specific *configuration* form with your Azure endpoint, API key, and deployment details. + Fill in the GCP-specific credential form with your API key and service account details. - Click `Save` to save your Azure OpenAI configuration. + A save reminder appears at the bottom of the page. Click `Save` to save your GCP credentials. ## Managing API Keys -View and manage existing API key configurations. +View, edit, and remove existing API key configurations. + + - +> Edit API Key form showing name, API key, and optional fields - Review all configured API keys in their respective *sections*. Each section shows "No credentials configured" or "No API keys configured" if none are set up. + Review all configured API keys in their respective sections. Each section shows "No API keys configured" if none are set up. - Use the options available for each configured credential to edit or remove API keys as needed. + Use the edit icon to modify an existing key or the delete icon to remove it. When editing, you can update the name, API key, Organization ID, Project ID, or Custom API URL. - - Click `Save` in the top right corner to save any changes made to API key configurations. + + A save reminder appears at the bottom of the page. Click `Save` to apply your changes. A warning appears if you have unsaved changes when navigating away. @@ -178,4 +137,4 @@ View and manage existing API key configurations. ## Next Steps -Now that you understand API keys settings, explore [Models Settings](/products/organizations-and-teams/settings-models) to control which AI models are available to your organization, or check out [Features Settings](/products/organizations-and-teams/settings-features) to configure team-wide features. +Now that you understand API keys settings, explore [Models Settings](/products/organizations-and-teams/settings-models) to configure processing mode and model access, or check out [Features Settings](/products/organizations-and-teams/settings-features) to configure team-wide feature toggles. diff --git a/public/content/organizations-and-teams/settings-features.md b/public/content/organizations-and-teams/settings-features.md index 2a84e26..560a438 100644 --- a/public/content/organizations-and-teams/settings-features.md +++ b/public/content/organizations-and-teams/settings-features.md @@ -12,7 +12,7 @@ metaDescription: Learn how to enable and disable features that sync across your The Features settings tab allows you to control organization-wide feature toggles that automatically sync to all team members' Pieces Desktop and PiecesOS installations. These settings ensure consistent feature availability across your team. - + > Features settings tab showing various feature toggles and processing options @@ -20,31 +20,31 @@ The Features settings tab allows you to control organization-wide feature toggle All feature settings configured here automatically sync to team members' Pieces Desktop and PiecesOS installations, ensuring everyone has the same feature availability. -## Accessing Features Settings - -Navigate to the Features settings tab to configure organization-wide feature toggles. These settings control what features are available to your entire team. +## How to Get to Features Settings + + Go to [portal.pieces.app](https://portal.pieces.app) and sign in. Select your organization from the *sidebar* dropdown if needed. + - From your *organization overview* page, click `Settings` in the sidebar navigation. + Click `Settings` in the *sidebar* navigation. - - Click the `Features` tab at the top of the *Settings* page. + Click the `Features` tab at the top of the Settings page. ## Feature Categories -Configure organization-wide features organized by category. All feature settings automatically sync to team members' Pieces Desktop and PiecesOS installations. +Configure organization-wide features organized by category. All feature settings automatically sync to team members' Pieces Desktop and PiecesOS installations. Model access, processing mode, and API keys are configured in the [Models](/products/organizations-and-teams/settings-models) section (organization management for AI). -### External Cloud Features +### External Cloud Control cloud-related operations and features for your organization. - Find the *External Cloud* section in the *Features settings* page. + Find the *External Cloud* section in the *Features* tab. @@ -52,79 +52,29 @@ Control cloud-related operations and features for your organization. - Click `Save` in the top right corner to save your changes. The setting will sync to all team members. + A save reminder appears at the bottom of the page. Click `Save` to apply. The setting will sync to all team members. -### Analytics Features +### Analytics Configure analytics and reporting features for your organization. - Find the *Analytics* section in the *Features settings* page. + Find the *Analytics* section in the *Features* tab. Use the toggle switch next to *Telemetry* to enable or disable BigQuery and Segment analytics integrations. - + Use the toggle switch next to *Send Internal Summary Reports* to enable or disable sending internal summary reports to user team service. - Click `Save` to apply your analytics settings. - - - -### External Provider Features - -Control external provider and processing features for your organization. - - - - Find the *External Provider* section in the *Features settings* page. - - - - Use the toggle switch next to *Customized Allowed Models* to enable or disable customizing allowed models with an allow-list. - - - - Use the toggle switch next to *Denied Workstream Pattern Engine Sources* to enable or disable denying specific workstream pattern engine sources. - - - - Use the toggle switch next to *Denied Workstream Pattern Engine Websites* to enable or disable denying specific websites for workstream pattern engine. - - - - Click `Save` to apply your external provider settings. - - - -### Processing Capabilities - -Configure processing capabilities for your organization. - - - - Find the *Processing* section in the *Features settings* page. - - - - Use the *dropdown* menu to select processing capabilities: - * **LOCAL**: Process everything locally - * **BLENDED**: Use a combination of local and cloud processing - - - - Use the toggle switch to enable or disable processing capabilities based on your selected mode. - - - - Click `Save` to apply your processing configuration. + A save reminder appears at the bottom of the page. Click `Save` to apply your analytics settings. @@ -132,4 +82,4 @@ Configure processing capabilities for your organization. ## Next Steps -Now that you understand features settings, explore [API Keys Settings](/products/organizations-and-teams/settings-api-keys) to configure AI service credentials, or check out [Models Settings](/products/organizations-and-teams/settings-models) to control which AI models are available to your organization. +Now that you understand features settings, explore [Models and API Keys](/products/organizations-and-teams/settings-models) to configure AI providers and processing mode, or check out [Long Term Memory](/products/organizations-and-teams/settings-ltm-sources) to configure context capture and default models. diff --git a/public/content/organizations-and-teams/settings-general.md b/public/content/organizations-and-teams/settings-general.md index aa0b7b6..088a25c 100644 --- a/public/content/organizations-and-teams/settings-general.md +++ b/public/content/organizations-and-teams/settings-general.md @@ -12,21 +12,21 @@ metaDescription: Learn how to update organization details, configure domains, se The General settings tab allows you to configure basic organization information, contact details, associated domains, SSO integration, and delete your organization. These settings control fundamental aspects of your organization's identity and access. - + > General settings tab showing organization name, contact info, domains, and danger zone -## Accessing General Settings - -Navigate to the General settings tab to configure organization details. This is the default tab when you first open Settings. +## How to Get to General Settings + + Go to [portal.pieces.app](https://portal.pieces.app) and sign in. Select your organization from the *sidebar* dropdown if needed. + - From your *organization overview* page, click `Settings` in the *sidebar* navigation. + Click `Settings` in the *sidebar* navigation. - - Click the `General` tab at the top of the *Settings* page. This is the default tab when you first open Settings. + Click the `General` tab at the top. It's the default tab when you open Settings. @@ -45,22 +45,22 @@ Modify your organization's basic details including name, contact information, an Update the following contact fields: - * **Organization Contact**: Name of the primary contact person - * **Organization Email**: Primary email address for the organization - * **Organization Phone**: Contact phone number + * **Name** — Name of the primary contact person + * **Email** — Primary email address for the organization + * **Phone** — Contact phone number Fill in or modify the organization address fields: - * **Organization Country**: Select from the *dropdown* - * **Organization Street Address**: Enter street address - * **Organization City**: Enter city name - * **Organization State**: Select state from *dropdown* - * **Organization ZIP Code**: Enter ZIP/postal code + * **Country** — Select from the *dropdown* + * **Street address** — Enter street address + * **City** — Enter city name + * **State** — Select state from *dropdown* + * **ZIP Code** — Enter ZIP/postal code - Click the `Save` button in the top right corner to save all your changes. + A save reminder appears at the bottom of the page. Click `Save` to apply your changes. @@ -78,7 +78,7 @@ Set up domains that are associated with your organization for automatic user ass - Click `Save` to save your domain configuration. Domains associated with this organization enable automatic user assignment for users with matching email domains. + A save reminder appears at the bottom of the page. Click `Save` to save your domain configuration. @@ -92,7 +92,7 @@ Configure SSO (Single Sign-On) integration using a tenant ID for *Descope* integ - Click `Save` to save your SSO configuration. This is optional and only needed if you're using *Descope* for SSO integration. + A save reminder appears at the bottom of the page. Click `Save` to save your SSO configuration. This is optional and only needed if you're using *Descope* for SSO integration. @@ -100,10 +100,10 @@ Configure SSO (Single Sign-On) integration using a tenant ID for *Descope* integ Permanently delete your organization and all associated data. This action cannot be undone. - + - Deleting an organization is permanent and irreversible. This will permanently delete all organization data, team data, member associations, and billing information. Subscriptions will be cancelled. Make sure you have backups of any important data before proceeding. + Deleting an organization is permanent and irreversible. This will permanently delete all organization data, member associations, and billing information. Subscriptions will be cancelled. Make sure you have backups of any important data before proceeding. @@ -114,7 +114,6 @@ Permanently delete your organization and all associated data. This action cannot Review the warning message that explains what will be deleted: * All organization data and settings - * All team data within this organization * All member associations * All billing and subscription information (subscriptions will be cancelled) @@ -132,4 +131,4 @@ Permanently delete your organization and all associated data. This action cannot ## Next Steps -Now that you understand general settings, explore other organization settings like [Features Settings](/products/organizations-and-teams/settings-features) to configure team-wide features, or check out [API Keys Settings](/products/organizations-and-teams/settings-api-keys) to configure AI service credentials. +Now that you understand general settings, explore other organization settings like [Features Settings](/products/organizations-and-teams/settings-features) to configure team-wide features, or check out [Models](/products/organizations-and-teams/settings-models) (including the API Keys tab) to configure AI providers and credentials. diff --git a/public/content/organizations-and-teams/settings-ltm-sources.md b/public/content/organizations-and-teams/settings-ltm-sources.md index 49305ff..5332651 100644 --- a/public/content/organizations-and-teams/settings-ltm-sources.md +++ b/public/content/organizations-and-teams/settings-ltm-sources.md @@ -1,54 +1,101 @@ --- -title: LTM Sources Settings +title: Long Term Memory Settings path: /desktop/organizations-and-teams/settings-ltm-sources visibility: PUBLIC status: PUBLISHED -description: Manage which applications Pieces can access for the workstream pattern engine. -metaTitle: LTM Sources Settings | Pieces Docs -metaDescription: Learn how to control which applications Pieces can access for LTM functionality. +description: Configure Long Term Memory context capture, application sources, denied websites, and default models for your organization. +metaTitle: Long Term Memory Settings | Pieces Docs +metaDescription: Learn how to configure LTM context capture, application sources, denied websites, and default models for memory processing. --- -## LTM Sources Settings +## Long Term Memory Settings -The LTM Sources settings tab allows you to manage which applications Pieces can access for the workstream pattern engine. You can view available applications, add new applications, toggle access on or off, and these settings automatically sync to all team members' Pieces Desktop installations. +The Long Term Memory section allows you to configure context capture settings, manage which applications and websites Pieces can access, and set default models for memory processing. These settings automatically sync to all team members' Pieces Desktop and PiecesOS installations. Long Term Memory is a top-level section in the organization sidebar. - + -> LTM Sources settings tab showing available applications and access controls +> Long Term Memory section showing Memory Formation toggles and Default Models - All LTM source settings configured here automatically sync to team members' Pieces Desktop installations, ensuring consistent application access control across your team. + All Long Term Memory settings configured here automatically sync to team members' Pieces Desktop and PiecesOS installations, ensuring consistent context capture and model configuration across your team. -## Accessing LTM Sources Settings + + To enable LTM websites or applications: turn **on** the corresponding toggle in the General tab, then use the *Applications* or *Websites* tab to manage what's blocked. To fully turn off: turn the toggle **off** in the General tab. + -Navigate to the LTM Sources settings tab to configure application access. These settings control which applications Pieces can access for the workstream pattern engine. +## How to Get to Long Term Memory - - From your *organization overview* page, click `Settings` in the sidebar navigation. + + Go to [portal.pieces.app](https://portal.pieces.app) and sign in. Select your organization from the *sidebar* dropdown if needed. + + + Click `Long Term Memory` in the *sidebar* navigation. + + + The *General* tab shows Memory Formation toggles and Default Models. Use *Applications* and *Websites* tabs to manage blocked apps and sites after enabling their toggles. + + + +## Enabling Memory Formation Toggles + +The *General* tab has three toggles that control how Pieces captures context. Turn them on or off as needed. + + + + In the *General* tab, find *Audio Context Capture* and turn the toggle **on** to let Pieces process audio (meetings, conversations) for memory. Turn **off** to disable. + + + Turn the *Organization managed application sources* toggle **on** to control which applications Pieces can access. When on, click `Manage applications` or open the *Applications* tab to allow or block apps. Turn **off** to disable organization-managed app control. + + + Turn the *Organization managed denied websites* toggle **on** to block specific websites from Long Term Memory. When on, click `Manage websites` or open the *Websites* tab to add blocked sites. Turn **off** to disable organization-managed website blocking. + + A save reminder appears at the bottom of the page. Click `Save` to apply. Settings sync to all team members. + + + +## Configuring Default Models + +Default models are used for memory event processing, auto-generated summaries, and audio transcription. Configure them after setting up API keys in [Models](/products/organizations-and-teams/settings-models). + + + +> Default Models section on the LTM General tab showing model assignment options - - Click the `LTM Sources` tab at the top of the *Settings* page. + + + In the *General* tab, find the *Default Models* section and click the `Manage models` button. + + + For each feature (Memory event processing, Auto-generated summaries, Audio transcription), choose a primary model and optional fallback. Models come from your enabled providers and API keys. + + + A save reminder appears at the bottom of the page. Click `Save` to apply. Default models sync to all team members. ## Managing Application Access -View, add, and control which applications Pieces can access for the workstream pattern engine. +When *Organization managed application sources* is enabled in the General tab, click the `Manage applications` button or select the *Applications* tab to manage which applications Pieces can access for context capture. - + > Available applications list showing application names, bundle IDs, and toggle switches -### Viewing Available Applications +### Viewing Applications -See all applications that Pieces can potentially access for the workstream pattern engine. +The *Applications* tab shows two sections: *Blocked Applications* (apps blocked from context capture) and *Available Applications* (apps that can be allowed or blocked). Each application has a toggle to enable or disable it for context capture. + + Click the `Applications` tab at the top of the Long Term Memory page. + + - The *LTM Sources* page displays all available applications in the *Available Applications* section. Each application shows: + The *Available Applications* section displays applications Pieces can access. Each application shows: * Application name * Global tag (if applicable) * Related bundle IDs and identifiers @@ -59,7 +106,7 @@ See all applications that Pieces can potentially access for the workstream patte - Each application has a toggle switch indicating whether Pieces has access to it (on) or is denied access (off). + Each application has a toggle switch. Turn it **on** to allow context capture from that application, or **off** to block it. @@ -69,7 +116,7 @@ Add custom applications to control access for specific tools your team uses. - Click the `+ Add Application` button at the top of the *LTM Sources* page. + Click the `+ Add Application` button at the top of the *Applications* tab. @@ -85,21 +132,21 @@ Add custom applications to control access for specific tools your team uses. -### Managing Application Access +### Enabling or Disabling Applications -Toggle access on or off for specific applications to control what Pieces can access. +Toggle access on or off for specific applications. Enable an application to allow context capture from it; disable it to block it from Long Term Memory. - Find the application you want to configure in the *Available Applications* list. + Find the application in the *Blocked Applications* or *Available Applications* list. - Use the toggle switch next to the application name to grant (on) or deny (off) Pieces access to that application for the workstream pattern engine. + Use the toggle switch next to the application name. Turn **on** to allow context capture, or **off** to block it. - Click `Save` in the top right corner to save your access changes. The settings will sync to all team members. + A save reminder appears at the bottom of the page. Click `Save` to apply. The settings will sync to all team members. diff --git a/public/content/organizations-and-teams/settings-ltm-websites.md b/public/content/organizations-and-teams/settings-ltm-websites.md index 26607b0..9279007 100644 --- a/public/content/organizations-and-teams/settings-ltm-websites.md +++ b/public/content/organizations-and-teams/settings-ltm-websites.md @@ -3,114 +3,118 @@ title: LTM Websites Settings path: /desktop/organizations-and-teams/settings-ltm-websites visibility: PUBLIC status: PUBLISHED -description: Configure which websites Pieces is denied from accessing for the workstream pattern engine. +description: Configure which websites are blocked from Long Term Memory context capture. metaTitle: LTM Websites Settings | Pieces Docs -metaDescription: Learn how to manage denied websites and control Pieces' access to specific URLs. +metaDescription: Learn how to enable LTM website management and block specific websites from Long Term Memory. --- ## LTM Websites Settings -The LTM Websites settings tab allows you to configure which websites Pieces is denied from accessing for the workstream pattern engine. You can add individual URLs or bulk upload via CSV, and these settings automatically sync to all team members' Pieces Desktop installations. +The LTM Websites settings allow you to configure which websites are blocked from Long Term Memory. You must **enable** *Organization managed denied websites* in the General tab first; then use the *Websites* tab to add blocked sites. **Disable** the toggle to fully turn off organization-managed website blocking. These settings automatically sync to all team members' Pieces Desktop and PiecesOS installations. - + -> LTM Websites settings tab showing denied websites list and upload options +> Blocked websites list with add input and CSV upload - All LTM website settings configured here automatically sync to team members' Pieces Desktop installations, ensuring consistent website access control across your team. + All LTM website settings configured here automatically sync to team members' Pieces Desktop and PiecesOS installations, ensuring consistent blocked website lists across your team. ## Accessing LTM Websites Settings -Navigate to the LTM Websites settings tab to configure denied websites. These settings control which websites Pieces is denied from accessing for the workstream pattern engine. +Enable the toggle in the General tab, then use the Websites tab to manage blocked sites. + + + +> Enabling Organization managed denied websites in the General tab - - From your *organization overview* page, click `Settings` in the sidebar navigation. + + From your organization's `Home` page, click `Long Term Memory` in the *sidebar* navigation. + + + + In the *General* tab, turn on the *Organization managed denied websites* toggle in the Memory Formation section. You can also click the `Manage websites` button to jump to the Websites tab. - - Click the `LTM Websites` tab at the top of the *Settings* page. + + Click the `Websites` tab at the top of the Long Term Memory page to add or manage blocked websites. -## Managing Denied Websites +## Managing Blocked Websites -Add websites to the denied list to prevent Pieces from accessing them. You can add websites individually or upload multiple sites via CSV. +The *Blocked websites* section lists sites that will not be tracked or used for Long Term Memory. Add websites individually or upload multiple sites via CSV. -### Adding Denied Websites Manually +### Adding Blocked Websites Manually -Add individual websites to the denied list to prevent Pieces from accessing them. +Add individual websites to the blocked list. - In the *website input* field, enter the URL of the website you want to deny access to (e.g., `https://example.com` or `example.com`). + In the input field (placeholder: "example.com or https://example.com"), enter the URL or domain you want to block (e.g., `example.com` or `https://example.com`). - Click the `add` button or press Enter to add the website to your *denied* list. + Click the `+ Add` button to add the website to your blocked list. - Click `Save` in the top right corner to save your *denied websites* list. + A save reminder appears at the bottom of the page. Click `Save` to apply. Your blocked websites list will sync to all team members. -### Bulk Uploading Denied Websites +### Bulk Uploading Blocked Websites -Upload multiple websites at once using a CSV file for efficient management. +Upload multiple websites at once using a CSV file. Format: one website per line. - Create a CSV file with one website URL per line. For example: + Create a CSV file with one website URL or domain per line. For example: ``` https://example.com - https://another-site.com - https://third-site.com + another-site.com + third-site.com ``` - Click the `Upload CSV` button or drag and drop your CSV file into the *upload* area on the *LTM Websites settings* page. + Click the `Upload CSV` button or drag and drop your CSV file into the upload area. - - Review the list of websites that were imported from your CSV file. - - - - Click `Save` to save all imported websites to your *denied* list. + + Review the imported websites. A save reminder appears at the bottom of the page. Click `Save` to add them to your blocked list. -### Managing Denied Websites List +### Removing Blocked Websites -View and manage your current list of denied websites. +To allow a website for Long Term Memory again, remove it from the blocked list. - - Review all websites currently in your *denied* list on the *LTM Websites settings* page. + + Find the website in the *Blocked websites* list. - - Use the remove option (typically an X icon or delete button) next to each website to remove it from the *denied* list if needed. + + Click the trash icon next to the website to remove it from the blocked list. - Click `Save` to apply any changes to your *denied websites* list. + A save reminder appears at the bottom of the page. Click `Save` to apply your changes. -## Understanding Website Denial +## Understanding Blocked Websites -When a website is added to the *denied* list, Pieces will not access data from that website for the workstream pattern engine. This helps you control what information Pieces can collect and use. +When a website is added to the *Blocked websites* list, it will not be tracked or used for Long Term Memory. This helps you control what information Pieces can collect and use. -* **Privacy Control** - Prevent Pieces from accessing sensitive or private websites -* **Team Consistency** - Ensure all team members have the same website access restrictions -* **Automatic Sync** - Settings automatically apply to all team members' installations +* **Privacy Control** — Prevent Pieces from accessing sensitive or private websites +* **Team Consistency** — All team members share the same blocked website list +* **Fully Disable** — Turn off the *Organization managed denied websites* toggle in the General tab to disable organization-managed website blocking entirely *** ## Next Steps -Now that you understand LTM websites settings, explore [LTM Sources Settings](/products/organizations-and-teams/settings-ltm-sources) to control which applications Pieces can access, or check out [Features Settings](/products/organizations-and-teams/settings-features) to configure team-wide features. +Now that you understand LTM websites settings, explore [LTM Applications](/products/organizations-and-teams/settings-ltm-sources) to control which applications are blocked or allowed for context capture, or check out [Features Settings](/products/organizations-and-teams/settings-features) to configure team-wide features. diff --git a/public/content/organizations-and-teams/settings-models.md b/public/content/organizations-and-teams/settings-models.md index 72f199a..372989f 100644 --- a/public/content/organizations-and-teams/settings-models.md +++ b/public/content/organizations-and-teams/settings-models.md @@ -3,115 +3,135 @@ title: Models Settings path: /desktop/organizations-and-teams/settings-models visibility: PUBLIC status: PUBLISHED -description: Control which AI models are available to your organization and sync to team members' installations. +description: Organization management for AI—control model access, processing mode, and API keys. Models is the parent section; API Keys is a tab within it. metaTitle: Models Settings | Pieces Docs -metaDescription: Learn how to manage model access and control which AI models your team can use in Pieces. +metaDescription: Learn how to manage model access, processing mode, and API keys in the Models section (organization management for AI). --- ## Models Settings -The Models settings tab allows you to control which AI models are available to your organization. You can toggle entire model providers on or off, manage individual models, and these settings automatically sync to all team members' Pieces Desktop and PiecesOS installations. +The Models section is the organization management area for AI. From here you control which models are available, enable or disable providers (Google, OpenAI, etc.), configure processing mode, and set up API keys. All settings sync to team members' Pieces Desktop and PiecesOS. - + + +> Models page showing provider sections (Google, OpenAI) with model lists and toggles - All model settings configured here automatically sync to team members' Pieces Desktop and PiecesOS installations, ensuring everyone has access to the same models. + All model settings configured here automatically sync to team members' Pieces Desktop and PiecesOS installations. -## Accessing Models Settings - -Navigate to the Models settings tab to configure model access. +## How to Get to the Models Page - - From your *organization overview* page, click `Settings` in the sidebar navigation. + + Go to [portal.pieces.app](https://portal.pieces.app) and sign in. Or from Pieces Desktop, click your `User Profile` → `Settings` → `Account` to reach your workspace. + + + In the *sidebar*, click the *organization dropdown* at the top and select your organization. + + + Click `Models` in the *sidebar* navigation. The Models page opens with the *Models* tab selected. Use the `API Keys` tab to add provider credentials. + + +## Enabling the Customized Model Allow-List + +By default, all models from enabled providers are available. To control which providers and models members can use, you must first enable the customized model allow-list. **The provider toggles (Google, OpenAI, etc.) are only active when the allow-list is enabled.** - - Click the `Models` tab at the top of the *Settings* page. + + + On the Models page, find the *Customized Model Allow-List* toggle and turn it **on**. + + + A save reminder appears at the bottom of the page. Click `Save` to apply. The provider sections below become active so you can enable or disable providers and select specific models. -## Managing Model Access +## Enabling or Disabling a Provider (Google, OpenAI, etc.) -Control which AI models are available to your organization by toggling providers and managing individual models. + + The customized model allow-list must be enabled for provider toggles to be active. See the section above. + -### Toggling Model Providers +Each provider (Google, OpenAI, Anthropic, etc.) has a toggle at the top of its section. Turn it on to make that provider's models available; turn it off to disable them. -Enable or disable entire model providers for your organization. + + +> Provider sections with on/off toggles for Google, OpenAI, and other providers - - Find the model provider you want to configure (e.g., ANTHROPIC, GOOGLE, OPENAI). + + Ensure the *Customized Model Allow-List* toggle is **on** near the top of the Models page. Provider toggles are inactive until the allow-list is enabled. - - - Read the description that explains these models will use the Pieces default configurations. + + On the Models page, scroll to the provider you want to change (e.g., *Google*, *OpenAI*). - - - Use the toggle switch next to the provider name to turn the entire provider on or off. When off, none of that provider's models will be available to your organization. + + Use the toggle switch at the top right of the provider section. Turn it **on** to enable that provider's models for your organization, or **off** to disable them. - - - Click `Save` in the top right corner to save your changes. + + A save reminder appears at the bottom of the page. Click `Save` to apply. Changes sync to all team members. -### Managing Individual Models +## Selecting Allowed Models -View and understand individual models within each provider. +With the allow-list and provider toggles configured, choose which specific models members can use. - - Under each enabled provider, you'll see a list of available models with their descriptions and labels. + + On the Models page, scroll to each enabled provider (e.g., *Google*, *OpenAI*). - - - Models are labeled with their characteristics: - * **Accurate** (green badge): Models optimized for accuracy and detailed analysis - * **Fast** (blue badge): Models optimized for speed and efficiency + + Use the checkboxes or controls next to each model to include or exclude it. Only models you explicitly allow will be available to members. - - - Each model includes a description explaining its capabilities, context window, and use cases. + + A save reminder appears at the bottom of the page. Click `Save` to apply. -### Using Toggle All Functions +## Setting Organization-Wide Processing Mode -Quickly enable or disable all models at once. +Control whether your organization uses local, cloud, or blended processing for AI features. - - Find the `Toggle All On` and `Toggle All Off` buttons at the top of the *Model Access* section. + + On the Models page, find the *Organization Managed Processing Mode* toggle and turn it **on**. - - - Click `Toggle All On` to enable all model providers and their models at once. + + Use the *Organization-Wide Processing Mode* dropdown to select: + * **BLENDED** — Mix of local and cloud (recommended) + * **Local** — Process locally only (limits features) - - - Click `Toggle All Off` to disable all model providers and their models at once. - - - - Click `Save` to apply your changes after using the toggle all functions. + + A save reminder appears at the bottom of the page. Click `Save` to apply. The chosen mode applies to all organization members. -## Example Model Providers + + Blended mode is recommended. Local-only mode severely limits AI features. + + +## Adding API Keys for Providers -Common model providers you may see include: +To use models from OpenAI, Anthropic, or GCP, you need to add API keys. Switch to the API Keys tab within Models. -* **ANTHROPIC**: Claude models (4.5 Opus, 4.5 Sonnet, 4.5 Haiku, 4 Sonnet, 3.7 Sonnet, 3.5 Sonnet, 3.5 Haiku) -* **GOOGLE**: Gemini models (3 Pro Preview, 3 Flash Preview, 2.5 Pro, 2.5 Flash, 2.5 Flash Lite, 2 Flash Lite) -* **OPENAI**: GPT models (5.2 Pro, 5.2, 5.1, GPT-5 Thinking, GPT-5, GPT-5 Fast, o4 Mini, o3 Pro, o3 Mini, o3, o1, GPT-4.1, GPT-4o, GPT-4o Mini) + + + On the Models page, click the `API Keys` tab at the top. + + + Find the provider section (OpenAI, Anthropic, GCP) and click `+ Add API Key`. Enter your credentials and click `Save`. + + + Switch back to the *Models* tab to enable that provider and choose which models to use. + + -Each provider's models use the Pieces default configurations and sync to your team members' installations. +For full API key instructions, see [API Keys Settings](/products/organizations-and-teams/settings-api-keys). *** ## Next Steps -Now that you understand models settings, explore [LTM Sources Settings](/products/organizations-and-teams/settings-ltm-sources) to control which applications Pieces can access, or check out [API Keys Settings](/products/organizations-and-teams/settings-api-keys) to configure AI service credentials. +Add credentials in [API Keys](/products/organizations-and-teams/settings-api-keys), or configure [Long Term Memory](/products/organizations-and-teams/settings-ltm-sources) for context capture and default models. diff --git a/public/content/organizations-and-teams/troubleshooting.md b/public/content/organizations-and-teams/troubleshooting.md index ba39abb..2038645 100644 --- a/public/content/organizations-and-teams/troubleshooting.md +++ b/public/content/organizations-and-teams/troubleshooting.md @@ -101,7 +101,7 @@ If you've joined a new organization but cannot use Pieces until you configure mo - Click the `Save` button to save your model selections. After saving, you should be able to use Pieces with your organization. + A save reminder appears at the bottom of the page. Click `Save` to apply your model selections. After saving, you should be able to use Pieces with your organization. diff --git a/public/content/paid-plans.md b/public/content/paid-plans.md index 859b4b3..07322bf 100644 --- a/public/content/paid-plans.md +++ b/public/content/paid-plans.md @@ -223,6 +223,10 @@ Proceed through the purchase form to enter your contact and payment information. Check the purchase overview on the right, and switch to annual billing if desired. + + Look for the small green `Add discount` text above the credit card fields. Click it to reveal the discount code input, enter your code, and apply. The totals will update to reflect the discounted price. Apply your code *before* completing payment—most codes cannot be applied retroactively. + + Click `Continue` to advance to the payment form. @@ -245,7 +249,7 @@ Proceed through the purchase form to enter your contact and payment information. After completing your purchase, you'll receive an email receipt along with a separate message containing your subscription details and direct links to update your payment method or cancel your subscription. - **Not seeing your Pro status?** Restart the Pieces Desktop app to force sync your account with the latest subscription status. + Restart the Pieces Desktop app to force sync your account with the latest subscription status if Pro status doesn't appear. ## Billing & Account Management @@ -348,6 +352,15 @@ Browse your billing history in the *Payments* tab. Click `any entry` to view a c ## Troubleshooting +### Discount Code Not Working? + +* **Check for typos** — Discount codes are usually case-sensitive. Enter the code exactly as provided. +* **Verify expiration** — Some codes have an expiration date. Confirm your code is still valid. +* **Plan eligibility** — Certain codes may only apply to Pieces Pro or Pieces Enterprise. Ensure the code matches the plan you're purchasing. +* **Apply before paying** — Make sure you clicked `Apply` after entering the code. It won't auto-apply. If the discount still doesn't appear, refresh the page and re-enter the code. + +### Blank Upgrade Page or Checkout Error + If you're seeing a blank upgrade page with a minimal table showing $0.00 for all values, followed by an error that returns you to the previous screen, this is a known issue related to our payments pipeline. It commonly occurs when **JavaScript is disabled in your browser** or if an **ad blocker** is interfering with the checkout process. diff --git a/public/content/privacy-security-your-data.md b/public/content/privacy-security-your-data.md index 196e89b..7c5c16a 100644 --- a/public/content/privacy-security-your-data.md +++ b/public/content/privacy-security-your-data.md @@ -11,7 +11,6 @@ ogImage: "https://storage.googleapis.com/hashnode_product_documentation_assets/o -*** ## Private and Secure diff --git a/public/content/quick-guides/ltm-prompting.md b/public/content/quick-guides/ltm-prompting.md index 9f51e60..44fa341 100644 --- a/public/content/quick-guides/ltm-prompting.md +++ b/public/content/quick-guides/ltm-prompting.md @@ -3,26 +3,62 @@ title: Long-Term Memory Prompting Guide path: /quick-guides/ltm-prompting visibility: PUBLIC status: PUBLISHED -description: Learn some top tricks and prompt suggestions to get the most out of the Pieces Long-Term Memory and Workstream Activities view. +description: Learn how to query Pieces Long-Term Memory effectively using time, source, gesture, topic, and people—plus best practices and example prompts for the Workstream Activity view. metaTitle: Long-Term Memory prompting guide | Pieces Docs -metaDescription: Learn some top tricks and prompt suggestions to get the most out of the Pieces Long-Term Memory and Workstream Activities view. +metaDescription: Learn how to query Pieces Long-Term Memory effectively. Combine time, source, topic, and more for better results. Includes example prompts and best practices. --- ## Why This Matters -Over the years, LLM users have learned how to prompt LLMs effectively, using tricks like prompt chaining. +With Pieces Long-Term Memory, you can query across captured memories using natural language—like asking a colleague who was there with you. The key to great results is combining a few dimensions in your questions: when, where, what, and who. -With Pieces Long-Term Memory, you can add more dimensions to your prompts, querying across captured memories using keywords related to your activities, applications, or time periods. +These guides show how to query LTM context using the Pieces Copilot in the Pieces Desktop App or any app with a Pieces plugin or extension. -These guides show how to query the stored LTM context using the Pieces Copilot in the Pieces Desktop App or any app with a Pieces plugin or extension. - - - When using these prompts, ensure you have LTM-2.7 turned on, both the [LTM](/products/core-dependencies/pieces-os/quick-menu#ltm-2-engine), and the LTM context source in the copilot chat. + + For any chat, you must activate the **LTM Context** (or Long-Term Memory Context) button in the chat interface. Without it, Pieces Copilot cannot search your Long-Term Memory—even with a well-structured query. -## Guide Links +You also need [LTM-2.7 enabled](/products/core-dependencies/pieces-os/quick-menu#ltm-2-engine) in PiecesOS. + +## The Five Keys to Great LTM Queries + +Combine these elements in your questions for better results. You don't need all five—even one or two helps significantly. + +| **Dimension** | **What to include** | **Example** | +|---------------|---------------------|-------------| +| **Time** | When did it happen? | "yesterday," "last week," "this morning" | +| **Source** | Where did it happen? (which app) | "in VS Code," "from Chrome," "in Teams" | +| **Gesture** | What were you doing? | "copying," "searching," "editing" | +| **Topic** | What project or subject? | "authentication module," "API integration" | +| **People** | Who were you working with? | "Sarah," "the security team" | + +**Pro tip:** Be specific when you can. "What did I work on for the customer portal yesterday?" works better than "What was I doing?" + +### Modality Filtering -These guides introduce some of the ways you can query the databased of stored LTM-2.7 context using the Pieces Copilot in the Pieces Desktop App, or any of the applications you use that have a Pieces plugin or extension. +You can narrow results by the type of activity: + +| **Scope** | **Use when you want** | **Example phrases** | +|-----------|------------------------|----------------------| +| All sources | General summaries, themes | "everything I did," "my work today" | +| Communications | Emails, chats, meetings | "in my conversations," "in meetings" | +| Code/Technical | Terminal, IDE, code | "commands I ran," "in VS Code" | +| Capture | Clipboard, screenshots | "things I copied," "snippets I saved" | + +### Query Best Practices + +**Do:** +* Write naturally—ask like you'd ask a colleague +* Be specific about time when it matters ("last Tuesday" > "recently") +* Combine dimensions (time + topic + people works well) +* Mention the project or theme when you remember it + +**Don't:** +* Overthink it—start simple and add details if needed +* Be too vague ("show me stuff" won't help) +* Give up after one try—small tweaks often improve results + +## Guide Links Click one of the cards below to jump to that guide. diff --git a/public/content/quick-guides/ltm-prompting/examples.md b/public/content/quick-guides/ltm-prompting/examples.md index 3100bc3..c7d6c86 100644 --- a/public/content/quick-guides/ltm-prompting/examples.md +++ b/public/content/quick-guides/ltm-prompting/examples.md @@ -114,6 +114,12 @@ Use some of these time-based example prompts to ask Pieces Copilot to provide ac +### More Examples by Time Horizon + +**Daily / 24–48 hours:** "Generate my standup for today: what I accomplished in the past 24 hours, what I'm working on, and any blockers." | "What follow-ups came up in my emails and meetings over the past 48 hours?" + +**Weeks to months:** "Find the conversation I had with my team a few weeks ago about [topic] and summarize what we decided." | "Based on my work over the past quarter, give me a performance review." + ## Get Next Steps Pieces can detect any upcoming activities, such as tasks in a task management tool, emails in your inbox, or discussions around future work in chat tools. diff --git a/public/content/raycast.md b/public/content/raycast.md index ed48e91..473dba5 100644 --- a/public/content/raycast.md +++ b/public/content/raycast.md @@ -10,7 +10,6 @@ metaDescription: Understand the benefits and importance of using the Pieces Rayc -*** V2 Documentation for the Pieces extension for the Raycast productivity tool is under construction.