From 340830c2fab8a9b4aecb2f6fb2aed68d12fc674c Mon Sep 17 00:00:00 2001 From: pieces-docs-mirror-app Date: Thu, 26 Mar 2026 15:36:34 +0000 Subject: [PATCH] chore(mirror): sync docs from pieces-documentation (run 23603143080) --- public/content/cli.md | 12 ++-- public/content/cli/commands.md | 2 +- public/content/cli/configuration.md | 4 +- public/content/cli/copilot.md | 4 +- public/content/cli/copilot/chat.md | 12 ++-- public/content/cli/copilot/llms-settings.md | 2 +- public/content/cli/drive.md | 8 +-- public/content/cli/drive/edit-and-update.md | 4 +- public/content/cli/drive/saving-materials.md | 6 +- public/content/cli/drive/search-reuse.md | 6 +- public/content/cli/drive/sharing.md | 6 +- public/content/cli/get-started.md | 14 ++-- public/content/cli/tui.md | 4 +- public/content/cli/tui/commands.md | 2 +- public/content/cli/tui/copilot.md | 2 +- public/content/cli/tui/get-started.md | 12 ++-- public/content/cli/tui/workstream.md | 4 +- public/content/core-dependencies.md | 16 ++--- .../content/core-dependencies/local-models.md | 2 +- .../local-models/download.md | 12 ++-- .../local-models/supported-models.md | 2 +- public/content/core-dependencies/ollama.md | 2 +- .../ollama/supported-models.md | 2 +- .../core-dependencies/on-device-storage.md | 2 +- public/content/core-dependencies/pieces-os.md | 14 ++-- .../pieces-os/manual-installation.md | 12 ++-- .../core-dependencies/pieces-os/quick-menu.md | 32 ++++----- .../pieces-os/troubleshooting.md | 26 ++++--- public/content/desktop.md | 12 ++-- public/content/desktop/actions.md | 4 +- .../desktop/actions/keyboard-shortcuts.md | 2 +- public/content/desktop/configuration.md | 16 ++--- .../content/desktop/configuration/account.md | 4 +- .../desktop/configuration/appearance.md | 2 +- .../configuration/connected-applications.md | 2 +- .../desktop/configuration/copilot-chats.md | 4 +- .../desktop/configuration/long-term-memory.md | 6 +- public/content/desktop/configuration/mcp.md | 2 +- .../content/desktop/configuration/models.md | 6 +- .../desktop/configuration/troubleshooting.md | 2 +- .../desktop/configuration/views-layouts.md | 10 +-- .../content/desktop/conversational-search.md | 2 +- .../chat-with-timeline-events.md | 6 +- .../context-integration.md | 4 +- .../using-conversational-search.md | 16 ++--- public/content/desktop/copilot.md | 10 +-- .../content/desktop/copilot/configuration.md | 10 +-- public/content/desktop/copilot/integration.md | 14 ++-- public/content/desktop/copilot/interaction.md | 20 +++--- .../desktop/copilot/multiple-environments.md | 8 +-- public/content/desktop/download.md | 4 ++ .../desktop/drive/enrichment-and-metadata.md | 8 +-- .../desktop/drive/save-and-organize.md | 4 +- .../desktop/drive/search-and-filter.md | 6 +- public/content/desktop/drive/sharing.md | 8 +-- .../desktop/drive/transforming-code.md | 2 +- public/content/desktop/navigation.md | 6 +- .../desktop/navigation/global-search.md | 8 +-- public/content/desktop/navigation/settings.md | 12 ++-- public/content/desktop/navigation/updates.md | 4 +- public/content/desktop/onboarding.md | 14 ++-- .../content/desktop/single-click-summaries.md | 10 +-- public/content/desktop/timeline.md | 10 +-- .../desktop/timeline/conversational-chat.md | 8 +-- .../content/desktop/timeline/event-actions.md | 10 +-- .../desktop/timeline/filtering-events.md | 12 ++-- .../content/desktop/timeline/ltm-rollups.md | 12 ++-- .../desktop/timeline/timeline-events.md | 8 +-- .../content/desktop/timeline/your-memories.md | 8 +-- .../desktop/troubleshooting/cross-platform.md | 2 +- .../content/desktop/troubleshooting/linux.md | 14 ++-- .../content/desktop/troubleshooting/macos.md | 8 +-- .../desktop/troubleshooting/windows.md | 8 +-- public/content/enterprise/features.md | 2 +- public/content/enterprise/onboarding.md | 2 +- .../content/extensions-plugins/jetbrains.md | 4 ++ .../content/extensions-plugins/jupyterlab.md | 4 ++ .../extensions-plugins/neovim-plugin.md | 4 ++ .../extensions-plugins/state-of-plugins.md | 54 ++++++++++++++ public/content/extensions-plugins/sublime.md | 4 ++ .../extensions-plugins/visual-studio-code.md | 4 ++ .../extensions-plugins/visual-studio.md | 4 ++ public/content/large-language-models.md | 4 +- .../large-language-models/cloud-models.md | 2 +- .../large-language-models/local-models.md | 2 +- public/content/mcp/amazon-q-developer.md | 2 +- public/content/mcp/chatgpt-developer-mode.md | 2 +- public/content/mcp/claude-code.md | 2 +- public/content/mcp/claude-cowork.md | 37 +++++++--- public/content/mcp/claude-desktop.md | 12 ++-- public/content/mcp/cline.md | 2 +- public/content/mcp/continue-dev.md | 2 +- public/content/mcp/cursor.md | 14 ++-- public/content/mcp/get-started.md | 10 +-- public/content/mcp/github-copilot.md | 12 ++-- public/content/mcp/google-gemini-cli.md | 2 +- public/content/mcp/goose.md | 12 ++-- public/content/mcp/jetbrains-ides.md | 2 +- public/content/mcp/ngrok-setup.md | 70 +++++++++++++------ public/content/mcp/openai-codex-cli.md | 2 +- public/content/mcp/openclaw.md | 69 +++++++++++------- public/content/mcp/raycast.md | 2 +- public/content/mcp/rovo-dev-cli.md | 2 +- public/content/mcp/vs-code.md | 2 +- public/content/mcp/windsurf.md | 2 +- public/content/mcp/zed.md | 2 +- public/content/meet-pieces.md | 18 ++--- public/content/meet-pieces/fundamentals.md | 8 +-- .../meet-pieces/linux-installation-guide.md | 10 +-- .../meet-pieces/macos-installation-guide.md | 8 ++- .../content/meet-pieces/sign-into-pieces.md | 10 +-- .../troubleshooting/cross-platform.md | 6 +- .../meet-pieces/troubleshooting/linux.md | 16 ++--- .../meet-pieces/troubleshooting/macos.md | 10 +-- .../meet-pieces/troubleshooting/windows.md | 10 +-- .../meet-pieces/windows-installation-guide.md | 12 ++-- public/content/organizations-and-teams.md | 8 +-- .../organizations-and-teams/billing.md | 4 +- .../creating-and-joining-organizations.md | 6 +- .../inviting-members.md | 6 +- .../managing-members.md | 6 +- .../managing-organizations.md | 14 ++-- .../member-permissions.md | 2 +- .../organization-member-guide.md | 4 +- .../organization-overview.md | 2 +- .../organization-settings.md | 4 +- .../settings-api-keys.md | 6 +- .../settings-features.md | 2 +- .../settings-general.md | 4 +- .../settings-ltm-sources.md | 6 +- .../settings-ltm-websites.md | 4 +- .../settings-models.md | 4 +- .../troubleshooting.md | 2 +- public/content/paid-plans.md | 22 +++--- public/content/privacy-security-your-data.md | 4 +- .../quick-guides/copilot-with-context.md | 10 +-- .../ltm-prompting/workstream-activity.md | 6 +- public/content/quick-guides/overview.md | 2 +- public/content/raycast.md | 20 +++--- public/content/support.md | 12 ++-- public/content/web-extension.md | 10 +-- 141 files changed, 678 insertions(+), 526 deletions(-) create mode 100644 public/content/extensions-plugins/state-of-plugins.md diff --git a/public/content/cli.md b/public/content/cli.md index 1cb3348..a3e5b95 100644 --- a/public/content/cli.md +++ b/public/content/cli.md @@ -8,7 +8,7 @@ metaTitle: Using the Pieces CLI | Pieces Docs metaDescription: Learn how to use Pieces CLI for seamless command-line integration, allowing you to save, retrieve, and manage code snippets efficiently. --- - +Pieces CLI banner ## Pieces CLI @@ -39,13 +39,13 @@ This software is designed to offer **two main features**: AI Assistance with the Through the Pieces CLI, users can boost productivity by having AI-driven conversations that use [relevant notes and folders as context](/products/cli/copilot/chat), all within their terminal. - +Using context in Pieces Copilot chat ### Integrated Snippet Management With Pieces Drive and PiecesOS in their terminal, users can [save, search, and share their code snippets](/products/cli/drive). This enhances productivity by making reusable code accessible and organized within their notes and project files. - +Pieces Drive list view in terminal ## Using Pieces Copilot @@ -59,7 +59,7 @@ From here, you’ll find several actions, including: * `Create and Delete`: Pieces CLI allows you to [manage your snippets easily from within your terminal](/products/cli/drive/saving-materials), allowing you to create and delete snippets. - +Edit command interface for snippet metadata ## Managing Your Code Snippets @@ -73,7 +73,7 @@ To save a snippet, copy a section of text or code to your clipboard, head over t When you save snippets to your Pieces Drive with Pieces CLI, they get AI-generated metadata like [tags, titles, authorship details, and descriptions](/products/cli/drive/saving-materials#whats-stored-when-you-save-a-snippet). This keeps everything organized and easy to access and use at any point. - +Saved snippet content display ### Referencing & Reusing @@ -93,7 +93,7 @@ A new terminal window will open and you’ll be presented with a list of materia Scroll down or up with the `arrow keys` and select the material by pressing `enter`. The material will display with its attributes and the code that was stored in the material. - +Neural code search results list *** diff --git a/public/content/cli/commands.md b/public/content/cli/commands.md index 3063d4c..c93e9e3 100644 --- a/public/content/cli/commands.md +++ b/public/content/cli/commands.md @@ -9,7 +9,7 @@ status: PUBLISHED Below is a table containing all the commands available for use in the Pieces CLI. - +Pieces CLI help menu ### Command Table diff --git a/public/content/cli/configuration.md b/public/content/cli/configuration.md index 82cf30e..7057ff3 100644 --- a/public/content/cli/configuration.md +++ b/public/content/cli/configuration.md @@ -11,7 +11,7 @@ status: PUBLISHED Configure the Pieces CLI by changing both language models and the code editor. - +Available models and settings configuration > Available models and settings configuration interface @@ -19,7 +19,7 @@ Configure the Pieces CLI by changing both language models and the code editor. The Pieces CLI supports 26 cloud-based language models that you can switch between. -We continually update and configure our plugins and extensions to ensure compatibility with the latest large language models (LLMs). +We continually update and configure our MCP integrations to ensure compatibility with the latest large language models (LLMs). | Supported LLMs | Supported LLMs | | ----------------------------- | ---------------- | diff --git a/public/content/cli/copilot.md b/public/content/cli/copilot.md index 854e150..7a7e83d 100644 --- a/public/content/cli/copilot.md +++ b/public/content/cli/copilot.md @@ -11,7 +11,7 @@ If you're facing an issue or stuck on a difficult debug, ask the Pieces Copilot You can ask questions that don't need context, like *“What is the basic format for a JSON object?”* or more detailed questions where the Pieces Copilot requires context from your saved materials. - +Asking a question to Pieces Copilot ## Adding Conversation Context @@ -19,7 +19,7 @@ Contextual awareness lets the Pieces Copilot help you solve problems faster by p To best add conversation context, [include materials](/products/cli/copilot/chat#via-material-index) or [file context](/products/cli/copilot/chat#via-file-path) for more accurate responses from the Pieces Copilot chat. - +Adding file context to Copilot chat ## Pieces Copilot As a Daily Driver diff --git a/public/content/cli/copilot/chat.md b/public/content/cli/copilot/chat.md index 6225126..f8f83e9 100644 --- a/public/content/cli/copilot/chat.md +++ b/public/content/cli/copilot/chat.md @@ -23,7 +23,7 @@ To quickly start a conversation with Pieces Copilot: If you’re not in Pieces CLI, in your terminal, you can type `pieces ask query`, replacing `query` with your question. - + Using the ask command in Pieces CLI @@ -67,7 +67,7 @@ You can narrow Copilot’s focus by feeding it specific materials or files when Pieces Copilot will load material #4 as context. - + Providing material context to Copilot @@ -95,7 +95,7 @@ Use a folder of specific file as context for Pieces Copilot by initiating the co Copilot loads material #2 and `specs.md` before generating its response. - + Adding multiple contexts to chat query @@ -123,7 +123,7 @@ Run `pieces mcp setup` from your terminal to open an interactive menu and automa * Raycast * Warp - + MCP platform selection menu @@ -142,7 +142,7 @@ The `mcp list` command displays the current implementations of Pieces MCP on you 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). - +MCP implementations list ### Docs @@ -162,5 +162,5 @@ If it finds that an implementation is broken, it will ask if you want to auto-re Type `y` for yes or `n` for no, and press `return` (macOS) or `enter` (Windows/Linux) to confirm your choice. - +MCP setup completion confirmation diff --git a/public/content/cli/copilot/llms-settings.md b/public/content/cli/copilot/llms-settings.md index d82441a..a4710c9 100644 --- a/public/content/cli/copilot/llms-settings.md +++ b/public/content/cli/copilot/llms-settings.md @@ -29,7 +29,7 @@ Follow the steps below to change the cloud LLM utilized by the Pieces MCP: Use your `scroll wheel` or `arrow keys` to navigate to your desired LLM and press `return` (macOS) or `enter` (Windows/Linux) to set the LLM runtime. - + List of available LLM models diff --git a/public/content/cli/drive.md b/public/content/cli/drive.md index 0422f72..cee0157 100644 --- a/public/content/cli/drive.md +++ b/public/content/cli/drive.md @@ -38,13 +38,13 @@ By using the Pieces CLI, capture and manage snippets in Pieces Drive to streamli Easily [save a function, script, or piece of boilerplate](/products/cli/drive/saving-materials) directly from the tool menu or with a keyboard shortcut. These snippets are stored in your personal Pieces Drive and include context, metadata, and tags for easy retrieval. - +Saved snippet details with metadata To save a code snippet, copy a snippet from a website or your IDE, go over to the Pieces CLI, and type `create`. If you’re not in a running Pieces CLI, you can type `pieces create` and enter the command. This will automatically grab whatever is in your clipboard and save it to your Pieces Drive. - +Creating a new snippet with pieces create command ### Search & Reuse @@ -52,7 +52,7 @@ You can search your collection of saved materials directly from your terminal. T To search, you can access the `search` action inside of the Pieces CLI. - +Search interface in Pieces CLI From within Pieces CLI you can enter `search “query”` to do a basic search. If you’re not within the Pieces CLI, you can enter `pieces search “query”`. @@ -72,7 +72,7 @@ In the `pieces save` command of the **Pieces Drive** within Pieces Copilot, open This keeps your library up-to-date, relevant, and aligned with your project's progress. Enhancing your materials makes them more efficient, which benefits you in the long run. - +Edit command for updating snippets ### Reusable Scheduling Functions diff --git a/public/content/cli/drive/edit-and-update.md b/public/content/cli/drive/edit-and-update.md index b7ba25e..4d0f556 100644 --- a/public/content/cli/drive/edit-and-update.md +++ b/public/content/cli/drive/edit-and-update.md @@ -31,7 +31,7 @@ Follow the steps below to edit a saved material in the Pieces CLI. Any changes made and saved within your IDE will update the Pieces Drive automatically, allowing you to use the changed snippet immediately. - + Modifying snippet in IDE and auto-saving @@ -51,7 +51,7 @@ With the Pieces CLI, you can rename saved materials and have those changes apply This will open a new prompt for you to change the name and classification for the snippet. - + Edit command interface for renaming snippets When you’re complete, the snippet will update across your Pieces Drive automatically. diff --git a/public/content/cli/drive/saving-materials.md b/public/content/cli/drive/saving-materials.md index 9f09022..69ddc0f 100644 --- a/public/content/cli/drive/saving-materials.md +++ b/public/content/cli/drive/saving-materials.md @@ -41,7 +41,7 @@ For Pieces CLI, you can save a snippet to your Pieces Drive with one command. If you’re within the Pieces CLI `pieces run` mode, you can enter `create`. - + Running pieces create command to save a snippet @@ -65,13 +65,13 @@ The Pieces Copilot captures several different kinds of metadata: * `Related People`: Associated collaborators or contributors. - +Saved snippet showing metadata and details Furthermore, the Pieces Copilot reviews stored snippets for sensitive data, including API keys, passwords, and authentication tokens, ensuring that **no confidential information** is unintentionally saved. ## Where Saved Snippets 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 with Pieces Drive. +Saved snippets are stored locally on your device, ensuring offline accessibility. This also means that any Pieces MCP integration or even the Pieces Desktop App has constant, up-to-date access to your saved materials with Pieces Drive. You can find your saved snippets via the `pieces list` command or the `pieces search` feature. diff --git a/public/content/cli/drive/search-reuse.md b/public/content/cli/drive/search-reuse.md index 8b2ed37..e4280c6 100644 --- a/public/content/cli/drive/search-reuse.md +++ b/public/content/cli/drive/search-reuse.md @@ -27,7 +27,7 @@ If you want to access your saved snippets directly within Pieces CLI, you can: Alternatively, you can launch into Pieces CLI run mode with `pieces run`. This will enable you to just enter `search “query”`. - + Neural code search results @@ -43,13 +43,13 @@ For example, `pieces search "query" --mode fts` will use the full-text search on [Saved snippets](/products/cli/drive/saving-materials) can be viewed by opening them up directly from the Pieces Drive with `pieces list`, using your scroll wheel or arrow keys, and selecting the snippet with the `return` (macOS) or `enter` (Windows/Linux) key, all from within your terminal. - +Pieces Drive materials list In your terminal, you can also open snippets with the `pieces search “query” [optional: --mode ncs,fts]` command. If Pieces finds snippets that match your query, you will be presented with a list of snippets. You can open a snippet from the list using your scroll wheel or arrow keys and select it with the `return` (macOS) or `enter` (Windows/Linux) key. - +Searching and selecting snippets *** diff --git a/public/content/cli/drive/sharing.md b/public/content/cli/drive/sharing.md index 78b5938..a0502e0 100644 --- a/public/content/cli/drive/sharing.md +++ b/public/content/cli/drive/sharing.md @@ -35,7 +35,7 @@ Read below for detailed steps on using the `share` command within the Pieces CLI Open it in a browser with `y` or deny it with `n`. After entering your option, press `return` (macOS) or `enter` (Windows/Linux). - + Sharing a snippet and opening in browser @@ -59,7 +59,7 @@ When you save a snippet to the Pieces Cloud, the code is [enriched with valuable This information appears to the right of the code block when the shared snippet is open in your browser: - +Shared snippet with metadata displayed ### Sensitive Information Watchdog @@ -67,6 +67,6 @@ The share command does more than enable you to share snippets with your entire t You'll see a section titled **Sensitive Information:** - +Sensitive information detection in shared snippet Our in-house ML model scans snippets for potentially sensitive information, such as API keys or passwords, and alerts you so you can make an informed decision before sharing the snippet. diff --git a/public/content/cli/get-started.md b/public/content/cli/get-started.md index e68065f..712ee88 100644 --- a/public/content/cli/get-started.md +++ b/public/content/cli/get-started.md @@ -26,7 +26,7 @@ Before installation, you’ll need: ### 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). +Pieces requires all users to sign in before using any Pieces products, including MCP integrations and the CLI. 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 CLI @@ -36,7 +36,7 @@ Follow the instructions below to install the Pieces CLI and any required depende Head to [Python’s website](https://www.python.org/downloads/) and download the version that best suits your environment. - + Python download page After downloading the Python version 3.xx, you will be guided through the installation process. Follow their steps until Python is installed. @@ -134,7 +134,7 @@ Follow the steps below to update the Pieces CLI. - + Pieces CLI update command output @@ -142,7 +142,7 @@ Follow the steps below to update the Pieces CLI. The Pieces CLI offers a walkthrough to guide you through the steps of saving your first material and introduces you to the Long-Term Memory Engine (LTM-2.7), enabling you to make the most of the Pieces CLI. - +Onboarding first step interface ### Save Your First Material @@ -166,7 +166,7 @@ This will display a list of all your saved materials. You can navigate through t Select the material you're highlighting by pressing `return`(macOS) or `enter`(Windows/Linux). - +Selecting a material from pieces list ### Start a Session @@ -196,7 +196,7 @@ If you enter `y` it will open the GitHub discussion board in a new tab in your b After completing the feedback, Pieces will prompt you to type `pieces contribute` and then ask if you’d like to open the source code for Pieces CLI on GitHub to improve it. You can optionally say yes by entering `y`; otherwise, enter `n`. - +Feedback and contribution options in onboarding ## Uninstalling @@ -236,6 +236,6 @@ If you also want to uninstall PiecesOS, [follow these steps](/products/core-depe - + Pip uninstall command output diff --git a/public/content/cli/tui.md b/public/content/cli/tui.md index 17f4a61..484a1f4 100644 --- a/public/content/cli/tui.md +++ b/public/content/cli/tui.md @@ -10,14 +10,14 @@ status: PUBLISHED The Pieces CLI Text User Interface (TUI) provides an interactive, terminal-based experience for managing materials and interacting with Pieces Copilot. When you launch the TUI with `pieces tui`, you're greeted with the Copilot interface featuring a sidebar for navigation, chat area for conversations, and keyboard shortcuts for quick access. - +TUI Copilot interface with sidebar and chat ## Workstream Activities Use `shift+ctrl+w` to navigate to the Workstream view. Once there, you can manage your workstream activities. Select an activity from the left sidebar to view its content in read mode or switch to edit mode `ctrl+e` to modify it. Save your changes with `ctrl+s`. - +TUI Workstream Activities view ## TUI As a Daily Driver diff --git a/public/content/cli/tui/commands.md b/public/content/cli/tui/commands.md index 0cff413..e2e06e7 100644 --- a/public/content/cli/tui/commands.md +++ b/public/content/cli/tui/commands.md @@ -12,7 +12,7 @@ metaDescription: Explore all available commands in the Pieces TUI with this comp Below is a comprehensive table containing every command and shortcut available in the Pieces TUI (Text User Interface). - +TUI command palette interface *** diff --git a/public/content/cli/tui/copilot.md b/public/content/cli/tui/copilot.md index 4cd1bd3..9b27f34 100644 --- a/public/content/cli/tui/copilot.md +++ b/public/content/cli/tui/copilot.md @@ -9,7 +9,7 @@ status: PUBLISHED The TUI Copilot provides a full-featured chat interface directly in your terminal. The interface is divided into three main areas: chat history, conversation window, and quick options. - +TUI Copilot with chat history sidebar ## Chat History diff --git a/public/content/cli/tui/get-started.md b/public/content/cli/tui/get-started.md index b9794b1..e4f1c62 100644 --- a/public/content/cli/tui/get-started.md +++ b/public/content/cli/tui/get-started.md @@ -29,7 +29,7 @@ Before you can use the Pieces CLI Text User Interface (TUI), you'll need: ### 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). +Pieces requires all users to sign in before using any Pieces products, including MCP integrations and the CLI. 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 TUI @@ -37,7 +37,7 @@ The TUI is included with the Pieces CLI installation, but requires a one-time se On your first launch, you'll need to run `pieces tui install` to download and set up the TUI components. This is a one-time setup process. - +TUI installation process If you haven't installed the Pieces CLI yet, follow the [CLI installation guide](/products/cli/get-started) first. @@ -64,7 +64,7 @@ To start using the TUI, follow these simple steps: This will launch the interactive Text User Interface. - + Launching TUI with pieces tui command @@ -105,7 +105,7 @@ Let's walk through your first interaction with the TUI to get you comfortable wi Press `return` (macOS) or `enter` (Windows/Linux) to send your question. Copilot will open a new chat and respond if not already in a chat. - +TUI chat interface showing conversation **New Chat Button:** You can start a fresh conversation anytime by clicking the "+new chat" button at the top of the left sidebar. This creates a new chat session while keeping your previous conversations accessible. @@ -124,7 +124,7 @@ Let's walk through your first interaction with the TUI to get you comfortable wi Press `return` (macOS) or `enter` (Windows/Linux) to open the selected workstream. - + Selected workstream activity display @@ -173,7 +173,7 @@ Follow the steps below to uninstall the TUI. - + TUI uninstall process diff --git a/public/content/cli/tui/workstream.md b/public/content/cli/tui/workstream.md index f31ff36..dbd24b3 100644 --- a/public/content/cli/tui/workstream.md +++ b/public/content/cli/tui/workstream.md @@ -12,7 +12,7 @@ metaDescription: Learn how to view, edit, and manage your workstream activities The TUI Workstream Activities view provides terminal-based access to your Long-Term Memory (LTM-2.7) roll-ups and workflow summaries. Access this feature directly from your command line to view, edit, and manage your workstream activities. - +TUI Workstream Activities with sidebar ## Accessing Workstream Activities @@ -32,7 +32,7 @@ The TUI Workstream Activities view provides terminal-based access to your Long-T Press `ctrl+e` to toggle into edit mode and modify the activity content. - + Workstream activity in edit mode diff --git a/public/content/core-dependencies.md b/public/content/core-dependencies.md index 3ff1c44..c1ff689 100644 --- a/public/content/core-dependencies.md +++ b/public/content/core-dependencies.md @@ -3,12 +3,12 @@ title: Core Dependencies path: /core-dependencies visibility: PUBLIC status: PUBLISHED -description: Learn about PiecesOS, the core dependency that powers the Pieces Desktop App and the entire Pieces suite of plugins and extensions, including built-in local models for on-device AI. +description: Learn about PiecesOS, the core dependency that powers the Pieces Desktop App and the entire Pieces suite of MCP integrations, including built-in local models for on-device AI. metaTitle: Pieces Core Dependencies -metaDescription: Learn about PiecesOS, the core dependency that powers the Pieces Desktop App and the entire Pieces suite of plugins and extensions, including built-in local models for on-device AI. +metaDescription: Learn about PiecesOS, the core dependency that powers the Pieces Desktop App and the entire Pieces suite of MCP integrations, including built-in local models for on-device AI. --- - +Core dependencies overview banner ## What Are Core Dependencies? @@ -19,7 +19,7 @@ Pieces products, including the [Pieces Desktop Application](/products/desktop), To run any Pieces software, you will need **PiecesOS,** the backbone of the Pieces Suite. This lightweight application runs in the background of your device. -It powers the [Long-Term Memory (LTM-2.7) Engine](/products/core-dependencies/pieces-os#ltm-27), [Pieces Drive,](/products/desktop/drive) and the [Pieces Copilot.](/products/desktop/copilot) +It powers the [Long-Term Memory (LTM-2.7) Engine](/products/core-dependencies/pieces-os#ltm-27), [Pieces Drive,](/products/desktop/drive) and [Conversational Search](/products/desktop/conversational-search) with Pieces Copilot. **PiecesOS**: The backbone of the Pieces suite, managing local memory, AI-driven workflow enhancements, [Pieces MCP](/products/mcp/get-started), and other integrations within your development environment. @@ -39,19 +39,19 @@ All local processing happens entirely on your device through PiecesOS, ensuring PiecesOS is a lightweight service that handles everything from local model management and context storage to advanced local inference for AI-assisted workflows. - +Pieces Desktop App, PiecesOS, and local models architecture PiecesOS is **required** for all Pieces products, including: * Pieces Desktop App -* Plugins & Extensions for [JetBrains](/products/extensions-plugins/jetbrains), [VS Code](/products/extensions-plugins/visual-studio-code), [Sublime Text](/products/extensions-plugins/sublime), [JupyterLab](/products/extensions-plugins/jupyterlab), [Neovim](/products/extensions-plugins/neovim-plugin), [Raycast](/products/raycast), [Obsidian](/products/obsidian), [the Pieces CLI](/products/cli), and more. +* [MCP integrations](/products/mcp/get-started) for [JetBrains IDEs](/products/mcp/jetbrains-ides), [VS Code](/products/mcp/vs-code), [Raycast](/products/mcp/raycast), and [many other tools](/products/mcp/get-started), plus [the Pieces CLI](/products/cli). ## Why Do We Need PiecesOS? Pieces is designed with **speed and efficiency** in mind, so PiecesOS acts as the central hub between different Pieces products to minimize client-side overhead and additional code while also being secure and highly configurable. - +PiecesOS performance, privacy, and flexibility benefits Our focus on **security and flexibility** is why we've built local models directly into PiecesOS—users can work entirely with on-device generative AI, and by offloading most operations locally, the user experience benefits from: @@ -71,6 +71,6 @@ This is especially useful in enterprise settings where strong device security is | **Dependency** | **Purpose** | **Required?** | | -------------- | --------------------------------------------------------------------- | ----------------------------------------------- | -| *PiecesOS* | Manages memory, developer material storage, and plugin communication. Includes built-in local models for on-device AI. | Yes — this is required for all Pieces products. | +| *PiecesOS* | Manages memory, developer material storage, and MCP client communication. Includes built-in local models for on-device AI. | Yes — this is required for all Pieces products. | *** diff --git a/public/content/core-dependencies/local-models.md b/public/content/core-dependencies/local-models.md index 468a4ca..b90d3c7 100644 --- a/public/content/core-dependencies/local-models.md +++ b/public/content/core-dependencies/local-models.md @@ -13,7 +13,7 @@ ogImage: "https://storage.googleapis.com/hashnode_product_documentation_assets/o Local models are *optional* but powerful AI capabilities built into PiecesOS that allow you to run Large Language Models (LLMs) directly on your device instead of relying on cloud-based AI processing. - +Local models for on-device generative AI Unlike cloud models—which require an internet connection—local models run entirely on your device, providing complete privacy and offline functionality. diff --git a/public/content/core-dependencies/local-models/download.md b/public/content/core-dependencies/local-models/download.md index f70b8f7..2ab657c 100644 --- a/public/content/core-dependencies/local-models/download.md +++ b/public/content/core-dependencies/local-models/download.md @@ -28,7 +28,7 @@ The easiest way to download and manage local models is directly from Conversatio Click your active model button (e.g., `Gemini 3 Pro Preview`) in the bottom toolbar of the Conversational Search interface. - + Active model selection button in Conversational Search > Clicking the active model button in Conversational Search to open the model dropdown @@ -44,7 +44,7 @@ The easiest way to download and manage local models is directly from Conversatio Toggle the switch next to any model you want to enable. Models that are already downloaded will be immediately available for use. - + Model management interface with toggle switches to enable models > Model management interface showing toggle switches to enable or disable models @@ -54,11 +54,11 @@ The easiest way to download and manage local models is directly from Conversatio -## Downloading Through IDE Plugins +## Downloading Through an MCP Integration -You can also download local models through any Pieces plugin or extension: +You can also download local models through any Pieces MCP integration: -1. Open Conversational Search in your IDE plugin. +1. Open Conversational Search in your editor or tool where Pieces MCP is connected. 2. Click the **Active Model** or **Change Model** button. @@ -96,7 +96,7 @@ To free up storage space, you can delete downloaded local models directly from t Click the trash icon on the model card to delete the downloaded model. Confirm the deletion when prompted to remove the model from your device. - + Deleting a downloaded local model via the trash icon > Model management interface showing a downloaded model with trash icon visible for deletion diff --git a/public/content/core-dependencies/local-models/supported-models.md b/public/content/core-dependencies/local-models/supported-models.md index 3395f36..b28fae2 100644 --- a/public/content/core-dependencies/local-models/supported-models.md +++ b/public/content/core-dependencies/local-models/supported-models.md @@ -5,7 +5,7 @@ visibility: PUBLIC status: PUBLISHED description: Find an up-to-date list of local large language models (LLMs) that are compatible with Pieces software and can be downloaded through PiecesOS. metaTitle: Supported Local Models | Pieces Docs -metaDescription: Find reference information about local models that are currently supported by PiecesOS, the Pieces Desktop App, and other Pieces plugins and extensions. +metaDescription: Find reference information about local models that are currently supported by PiecesOS, the Pieces Desktop App, and other Pieces MCP integrations. --- diff --git a/public/content/core-dependencies/ollama.md b/public/content/core-dependencies/ollama.md index 062c2bd..5f96da5 100644 --- a/public/content/core-dependencies/ollama.md +++ b/public/content/core-dependencies/ollama.md @@ -13,7 +13,7 @@ ogImage: "https://storage.googleapis.com/hashnode_product_documentation_assets/o Ollama is an *optional* but powerful dependency that allows PiecesOS to run Large Language Models (LLMs) directly on your device instead of relying on cloud-based AI processing. - +Ollama core dependency for on-device generative AI Unlike PiecesOS—which is required for all Pieces functionality—Ollama is only needed if you want to use local AI models with Pieces Copilot. diff --git a/public/content/core-dependencies/ollama/supported-models.md b/public/content/core-dependencies/ollama/supported-models.md index 18b94d9..50ad61d 100644 --- a/public/content/core-dependencies/ollama/supported-models.md +++ b/public/content/core-dependencies/ollama/supported-models.md @@ -5,7 +5,7 @@ visibility: PRIVATE status: PUBLISHED description: Find an up-to-date list of local large language models (LLMs) that are compatible with Pieces software & are served and supported through the Ollama client. metaTitle: Supported Models for Ollama | Pieces Docs -metaDescription: Find reference information of models for Ollama that are currently supported by PiecesOS, the Pieces Desktop App, and other Pieces plugins and extensions. +metaDescription: Find reference information of models for Ollama that are currently supported by PiecesOS, the Pieces Desktop App, and other Pieces MCP integrations. --- \ No newline at end of file diff --git a/public/content/core-dependencies/on-device-storage.md b/public/content/core-dependencies/on-device-storage.md index 5b22a60..5e7f95d 100644 --- a/public/content/core-dependencies/on-device-storage.md +++ b/public/content/core-dependencies/on-device-storage.md @@ -79,6 +79,6 @@ There are several options to backup, restore or reset your database from within ## Need Help?**​** -You can open GitHub issues for PiecesOS, the Pieces Desktop App, or any other Pieces plugin or extension by opening an issue in our GitHub repository. +You can open GitHub issues for PiecesOS, the Pieces Desktop App, or any other Pieces MCP integration by opening an issue in our GitHub repository. If you would prefer not to use GitHub, you can still leave feedback or report a bug here. diff --git a/public/content/core-dependencies/pieces-os.md b/public/content/core-dependencies/pieces-os.md index 4a5175c..e42cacc 100644 --- a/public/content/core-dependencies/pieces-os.md +++ b/public/content/core-dependencies/pieces-os.md @@ -15,17 +15,17 @@ PiecesOS is a background service that runs on your machine. It orchestrates loca The core functionality powered by PiecesOS is [LTM-2.7](/products/core-dependencies/pieces-os#ltm-27), which enables the [Timeline](/products/desktop/timeline) feature in the Pieces Desktop App. - +PiecesOS powering Long-Term Memory, Pieces Drive, and Copilot > PiecesOS powering core Pieces functionality ## The Role of PiecesOS -PiecesOS provides the intelligence and power behind Pieces software in two key ways. First, it supplies the essential components of the Pieces infrastructure and supports various processes. Second, it powers standalone Pieces plugins and extensions when used without the Pieces Desktop App. +PiecesOS provides the intelligence and power behind Pieces software in two key ways. First, it supplies the essential components of the Pieces infrastructure and supports various processes. Second, it powers [MCP integrations](/products/mcp/get-started) when you use Pieces without the Pieces Desktop App. This 'brain' is required to enable the fundamental features of the Pieces development experience. - +PiecesOS bridging all Pieces products and services > PiecesOS bridging all Pieces products and services @@ -37,7 +37,7 @@ With [Conversational Search](/products/desktop/conversational-search), you can h ## Fundamental Components -Using the Pieces Desktop App or a Pieces plugin or extension for your favorite IDE requires PiecesOS. It is a required dependency for memory and context preservation, storing and accessing materials, and interacting with generative AI. +Using the Pieces Desktop App or a [Pieces MCP integration](/products/mcp/get-started) in your favorite IDE requires PiecesOS. It is a required dependency for memory and context preservation, storing and accessing materials, and interacting with generative AI. ## LTM-2.7 @@ -65,7 +65,7 @@ Deep Study reports typically take 10–20 minutes to generate. While running, pr Deep Study always runs on a dedicated cloud LLM managed by Pieces (currently a Google model, subject to change). Changing the selected LLM via the standard runtime modal does not affect Deep Study generations. - +Deep Study progress indicators and cooperating agents > Deep Study in action showing progress indicators and cooperating agents @@ -114,7 +114,7 @@ The Model Context Protocol (MCP) is an open framework that lets Large Language M [MCP is fully supported within the Pieces ecosystem](/products/mcp/get-started) and acts as the link between PiecesOS and external applications that need real-time, local context. - +Pieces MCP integration with Cursor for context-aware changes > Pieces MCP integration with Cursor showing context-aware documentation changes @@ -126,7 +126,7 @@ LTM continuously captures workflow context as you work, creating timeline events The Timeline view [lets you search for keywords, open references or links, and even launch Conversational Search chats](/products/desktop/timeline) directly from timeline events. - +Exploring timeline events in the Timeline view > Exploring timeline events in the Timeline view diff --git a/public/content/core-dependencies/pieces-os/manual-installation.md b/public/content/core-dependencies/pieces-os/manual-installation.md index a772035..3551c96 100644 --- a/public/content/core-dependencies/pieces-os/manual-installation.md +++ b/public/content/core-dependencies/pieces-os/manual-installation.md @@ -50,7 +50,7 @@ If you need help determining your device’s OS version or system specifications ## Why Install PiecesOS Manually? -PiecesOS is installed by default when installing the Pieces Desktop App as a core dependency, but it can be installed manually for use with a Pieces plugin or extension if you’re not ready to dive into the entire Pieces ecosystem. +PiecesOS is installed by default when installing the Pieces Desktop App as a core dependency, but it can be installed manually for use with a [Pieces MCP integration](/products/mcp/get-started) if you’re not ready to dive into the entire Pieces ecosystem. LTM, Pieces Drive, and Pieces Copilot will still be available to you. @@ -64,6 +64,10 @@ There are different ways to install PiecesOS as a standalone entity, separate fr To install, download the appropriate link for your device’s OS and architecture (if using a macOS device) and open the file, then walk through the guided installation steps as necessary. + + **Installation path:** Avoid **OneDrive**, **iCloud Drive**, and other **cloud-synced** install locations—use a **local drive** (the default path is recommended). + + ## Windows Click the download buttons below to install PiecesOS via `.exe` or `.appinstaller`. @@ -144,7 +148,7 @@ Select your operating system below to platform-specific steps to uninstalling Pi Scroll or search until you find `PiecesOS.` Right-click on these two applications and select `Move to Trash`. - + Uninstalling PiecesOS from macOS Applications folder @@ -154,7 +158,7 @@ Select your operating system below to platform-specific steps to uninstalling Pi The **PiecesOS application** will appear after that query. Click the three dots to the right of the application title, and click `Uninstall`. - + Uninstalling PiecesOS from Windows Settings @@ -164,7 +168,7 @@ Select your operating system below to platform-specific steps to uninstalling Pi To remove **PiecesOS,** type `sudo snap remove pieces-os` and press `enter`. - + Uninstalling PiecesOS from the Linux terminal diff --git a/public/content/core-dependencies/pieces-os/quick-menu.md b/public/content/core-dependencies/pieces-os/quick-menu.md index 625bf43..3ce07c2 100644 --- a/public/content/core-dependencies/pieces-os/quick-menu.md +++ b/public/content/core-dependencies/pieces-os/quick-menu.md @@ -37,7 +37,7 @@ There are several views and buttons you can click to expand or enter in the Piec *PiecesOS Quick Menu on macOS* - +PiecesOS Quick Menu overview on macOS The PiecesOS Quick Menu shares the same user interface (UI) as the Quick Menu on Windows. @@ -57,7 +57,7 @@ At the top of the Quick Menu, you can **log in or log out** of your Pieces accou If you log out, PiecesOS will continue running locally with saved configurations but will not sync to the cloud. - +PiecesOS Quick Menu account login and logout options ### Checking for Updates @@ -67,7 +67,7 @@ Directly under your account information, the Quick Menu displays your current Pi * If PiecesOS is up to date, the menu will display a green check mark and show the active version—i.e., 11.0.4. - +PiecesOS Quick Menu update status and version info ## LTM-2.7 Engine @@ -81,7 +81,7 @@ You can toggle the LTM engine **On** or **Off** from the Quick Menu. To do so, click the `Pieces` logo in your taskbar or toolbar, and click `Enable Long-Term Memory Engine` to enable it. - +Toggling LTM engine on or off in the Quick Menu Conversely, you can click the green `On` button to display a drop-down menu that lets you disable the LTM temporarily in minute increments or altogether. @@ -103,7 +103,7 @@ This view displays a list of apps from which LTM is actively gathering data (e.g Clicking on an enabled source opens a window where you can choose to disable it. - +LTM enabled sources with application icons in Quick Menu ## MCP Menu @@ -111,7 +111,7 @@ Pieces is fully integrated with MCP functionality and now ships with an in-house You can find the SSE endpoint URL for creating your own Pieces MCP instances, as well as links to related documentation, in the `Model Context Protocol (MCP) Servers` menu. - +MCP Server options and SSE endpoint in the Quick Menu ## Settings @@ -121,7 +121,7 @@ The `Settings` menu allows you to configure PiecesOS to best suit your workflow. Adjusts memory allocation for PiecesOS to reduce resource consumption while maintaining performance. - +ML processing and memory optimization settings ### Launch on Login @@ -129,15 +129,15 @@ You can enable or disable automatic startup for PiecesOS when your computer boot ### Enabled Apps -View a list of applications that have Pieces plugins and extensions installed. +View a list of applications that have Pieces MCP integrations connected. - +List of enabled Pieces MCP integrations ### Telemetry Sharing -Enable or disable telemetry data collection on an individual application, plugin, or extension basis. +Enable or disable telemetry data collection on an individual application or MCP integration basis. - +Telemetry sharing settings for individual applications ### ML Processing @@ -145,7 +145,7 @@ This menu controls how PiecesOS manages AI model inference. You can use `Blended You can also make changes to the enrichment to level and type to individual applications for more fine-tuned control. - +ML processing mode selection between Blended and Local ### Resources @@ -175,13 +175,13 @@ The `Resources` provides quick access to documentation, support, and community l *** - +PiecesOS Quick Menu resources and links section ## Linux The Pieces Quick Menu on Linux contains several helpful resources and links, such as: -* **Discoverer Integrations:** Opens the Pieces website, where you can find all Pieces browser and IDE extensions and plugins. +* **Discoverer Integrations:** Opens the Pieces website, where you can find all Pieces MCP integrations. * **About:** Launches the About page for Pieces. @@ -193,6 +193,6 @@ The Pieces Quick Menu on Linux contains several helpful resources and links, suc * **Quit:** Quits PiecesOS. To relaunch, open your terminal and type `pieces-os` and press `enter` or find the PiecesOS launcher from your application tray. - +PiecesOS Quick Menu on Linux -As a background resource task, there are currently fewer adjustable actions, but LTM Pieces Drive and Pieces Copilot can still be accessed and utilized within Pieces plugins and extensions on Linux. \ No newline at end of file +As a background resource task, there are currently fewer adjustable actions, but LTM Pieces Drive and Pieces Copilot can still be accessed and utilized within Pieces MCP integrations on Linux. \ No newline at end of file diff --git a/public/content/core-dependencies/pieces-os/troubleshooting.md b/public/content/core-dependencies/pieces-os/troubleshooting.md index 91b28b9..406227b 100644 --- a/public/content/core-dependencies/pieces-os/troubleshooting.md +++ b/public/content/core-dependencies/pieces-os/troubleshooting.md @@ -14,6 +14,10 @@ Find information on troubleshooting common installation and update issues for Pi +### Installation folder and cloud sync (OneDrive, iCloud Drive, etc.) + +If you installed to **OneDrive**, **iCloud Drive**, or another **synced folder**, you may see install failures, crashes, or bad updates. **Uninstall**, then **reinstall** to the **default path** on a local drive. See [Windows](/products/meet-pieces/windows-installation-guide#on-screen-prompts) and [manual installation](/products/core-dependencies/pieces-os/manual-installation#manual-download--installation). + ### Checking System Specifications Navigate between the grouped tabs below to find information on several common installation issues users experience when downloading and installing PiecesOS. @@ -36,7 +40,7 @@ Navigate between the grouped tabs below to find information on several common in * **Intel:** You will see an Intel processor, e.g., `2.6 GHz Intel Core i7` - + Checking macOS CPU architecture via About This Mac @@ -54,7 +58,7 @@ Navigate between the grouped tabs below to find information on several common in The **System** tab will display your processor, number of CPU cores, and memory (RAM), while the **Display** tab will list your GPU, it’s maker (NVIDIA, AMD, Intel, etc.) and the available video memory (VRAM). - + Checking Windows hardware specs using dxdiag @@ -66,11 +70,11 @@ Navigate between the grouped tabs below to find information on several common in To determine your CPU type and find other important information, type `lscpu` in your terminal and press `Enter`. - + Terminal output of lscpu command on Ubuntu **Checking GPU Information** - + Terminal output of lspci showing GPU info on Ubuntu Confirm that your CPU, GPU, and memory resources are sufficient for running PiecesOS and local AI models (if applicable). @@ -82,7 +86,7 @@ Navigate between the grouped tabs below to find information on several common in ### Versions & Updates -Many issues can stem from out-of-date plugins, extensions, or PiecesOS itself. +Many issues can stem from out-of-date MCP integrations or PiecesOS itself. @@ -96,7 +100,7 @@ Many issues can stem from out-of-date plugins, extensions, or PiecesOS itself. 3. Check for and install available updates - + Checking for PiecesOS updates via Quick Menu on macOS @@ -110,7 +114,7 @@ Many issues can stem from out-of-date plugins, extensions, or PiecesOS itself. 3. If an update is available, follow the on-screen prompt to download and install it. - + Checking PiecesOS for updates on Windows taskbar ### Updating PiecesOS (AppInstaller) @@ -130,7 +134,7 @@ Many issues can stem from out-of-date plugins, extensions, or PiecesOS itself. 2. Run `sudo snap refresh` to update PiecesOS if a newer version is available - + Running snap refresh to update PiecesOS on Linux @@ -156,7 +160,7 @@ Having an out-of-date operating system version can cause a range of installation The `macOS` line will report what version of macOS installed, e.g., `Sequoia 15.1.1`. - + Checking macOS version via About This Mac @@ -172,7 +176,7 @@ Having an out-of-date operating system version can cause a range of installation 3. Install any pending updates and restart your computer - + Checking Windows version using winver command @@ -192,7 +196,7 @@ Having an out-of-date operating system version can cause a range of installation This section will will display your Ubuntu version information. - + Checking Ubuntu version in System Settings diff --git a/public/content/desktop.md b/public/content/desktop.md index d430e46..0e29be1 100644 --- a/public/content/desktop.md +++ b/public/content/desktop.md @@ -8,7 +8,7 @@ metaTitle: Pieces Desktop Application metaDescription: Boost productivity with the Pieces Desktop App – AI-powered tools that use workflow context to enhance decision-making with generative AI. --- - +Pieces Desktop App logos and branding > Pieces Desktop App logos and branding @@ -46,7 +46,7 @@ Keep track of your workflow so you can access stored context from yesterday, las [Pieces Timeline](/products/desktop/timeline) provides a sleek UI for interacting with saved data from up to 9 months ago in an easily digestible format, allowing you to view timeline events, workstream summaries, single-click summaries, and conversational searches. - +Pieces Timeline showing workflow events, summaries, and activity graph visualization > Pieces Timeline showing workflow events, summaries, and activity graph visualization @@ -58,7 +58,7 @@ Keep track of your workflow so you can access stored context from yesterday, las Generate instant, contextual summaries from your workflow using preset summary types. With [Single-Click Summaries](/products/desktop/single-click-summaries), you can instantly generate contextual summaries with one click. Choose from summary types like *What's Top of Mind*, *Standup Update*, *Custom Summary*, *Day Recap*, *AI Habits*, and *Discover*—to quickly access insights about your workflow without typing a single prompt. - +Pieces Timeline with Single-Click Summaries generating > Showing Pieces with Timeline open and Single-Click Summaries Generating @@ -70,7 +70,7 @@ Generate instant, contextual summaries from your workflow using preset summary t Use [Conversational Search](/products/desktop/conversational-search) as your main chat interface, where you'll find suggested prompts to help you get started. Query your workflow memories and get AI-powered insights about your past activities. - +Conversational Search interface with chat and suggested prompts > Conversational Search interface showing chat interface and suggested prompts @@ -102,10 +102,10 @@ With the Pieces MCP, you can thread rich workflow context through to [Cursor](/p *Pieces MCP with Cursor* - +Pieces MCP integration with Cursor showing workflow context threading > Pieces MCP integration with Cursor showing workflow context threading *** -If Pieces Desktop isn't what you're looking for, check out [PiecesOS](/products/core-dependencies/pieces-os) to learn about the core engine powering Pieces, or explore [Extensions & Plugins](/products/extensions-plugins) to integrate Pieces into your favorite IDE or editor. +If Pieces Desktop isn't what you're looking for, check out [PiecesOS](/products/core-dependencies/pieces-os) to learn about the core engine powering Pieces, or explore [MCP integrations](/products/mcp/get-started) to connect Pieces to your favorite IDE or editor. diff --git a/public/content/desktop/actions.md b/public/content/desktop/actions.md index eab462a..377f608 100644 --- a/public/content/desktop/actions.md +++ b/public/content/desktop/actions.md @@ -20,7 +20,7 @@ The Pieces Desktop App provides two primary ways to quickly perform *actions* an When you open the **Power Menu**, the actions you see can change based on your current location in the app. - +Power Menu with context-aware Find Action search Here are some examples: @@ -44,7 +44,7 @@ There are plenty of use cases for using the **Power Menu**—here are a couple: For a detailed list of all possible shortcuts and their descriptions, visit the [Keyboard Shortcuts](/products/desktop/actions/keyboard-shortcuts) page for multi-platform shortcut tables and action titles. - +Keyboard Shortcuts reference in Settings ### When to Use Shortcuts diff --git a/public/content/desktop/actions/keyboard-shortcuts.md b/public/content/desktop/actions/keyboard-shortcuts.md index 547ab13..26bed9b 100644 --- a/public/content/desktop/actions/keyboard-shortcuts.md +++ b/public/content/desktop/actions/keyboard-shortcuts.md @@ -12,7 +12,7 @@ metaDescription: Keyboard shortcuts enable you to access parts of Pieces without You can browse the list of keyboard shortcuts below as a reference guide, or you can open the **Keyboard Shortcuts** modal by navigating to **Settings,** and scrolling to **Support** or use `⌘+;` (macOS) or `ctrl+;` (Windows/Linux). - +Keyboard Shortcuts modal listing commands and key bindings ## Use a Piece diff --git a/public/content/desktop/configuration.md b/public/content/desktop/configuration.md index 82f71c8..9c5e7bf 100644 --- a/public/content/desktop/configuration.md +++ b/public/content/desktop/configuration.md @@ -16,7 +16,7 @@ Open Settings from the home view to adjust account and cloud behaviors, check yo Click your profile picture in the top left of the home view. - + Profile menu open with Settings and quick category options @@ -47,7 +47,7 @@ Open Settings from the home view to adjust account and cloud behaviors, check yo Manage your Pieces account, linked third-party services, profile information, personal cloud synchronization, subscriptions, and privacy settings. This ensures your account stays secure and synced with the services you use to authenticate. - +Account settings showing profile, linked accounts, organizations, subscriptions, and privacy > Account settings showing profile information, linked accounts, organizations, subscriptions, personal cloud, and privacy settings @@ -59,7 +59,7 @@ Manage your Pieces account, linked third-party services, profile information, pe Create and manage organizations and teams to collaborate with others, share resources, and maintain consistent settings across your team in Pieces. - +Organizations and Teams section in Account settings > Account settings page showing Organizations & Teams section with organization list and management options @@ -71,7 +71,7 @@ Create and manage organizations and teams to collaborate with others, share reso Manage long-term memory preferences and data. Configure the Long-Term Memory Engine, control which applications Pieces can access, manage system permissions, optimize performance, and clear stored data. - +Long-Term Memory settings with Memory Formation, Performance, and Stored Data > Long-Term Memory settings showing Memory Formation, Performance, and Stored Data sections @@ -83,7 +83,7 @@ Manage long-term memory preferences and data. Configure the Long-Term Memory Eng Manage AI models and model preferences. Configure processing modes, set up local model runtime with Ollama, and control which AI models are available for use in Pieces. - +Models settings with capabilities, local runtime, and model management > Models settings showing Model Capabilities, Local Model Runtime, and Model Management sections @@ -95,7 +95,7 @@ Manage AI models and model preferences. Configure processing modes, set up local Access server URLs and documentation for integrating Pieces Long-Term Memory with Cursor, GitHub Copilot, and other tools that support the Model Context Protocol. The MCP server enables connectivity between Large Language Models (LLMs) and your personal context stored by the Long-Term Memory Engine. - +MCP settings with server URLs and documentation links > MCP settings showing server URLs and documentation options @@ -107,7 +107,7 @@ Access server URLs and documentation for integrating Pieces Long-Term Memory wit Customize the visual appearance of the Pieces Desktop App, including theme mode, accent colors, font settings, and visual density. Adjust these settings to match your preferences and create a comfortable work environment. - +Appearance settings with theming, fonts, and spacing > Appearance settings showing Theming, Fonts, and Spacing sections @@ -119,7 +119,7 @@ Customize the visual appearance of the Pieces Desktop App, including theme mode, Get help, troubleshoot issues, view app information, and contact support. Access support resources, documentation links, version details, and feedback channels to resolve issues and get the most out of Pieces. - +Troubleshooting settings with online resources, contact, and app version info > Troubleshooting settings showing Online Resources, Get In Touch, PiecesOS Information, and Desktop App Information sections diff --git a/public/content/desktop/configuration/account.md b/public/content/desktop/configuration/account.md index df704f0..eaddfe4 100644 --- a/public/content/desktop/configuration/account.md +++ b/public/content/desktop/configuration/account.md @@ -14,7 +14,7 @@ Manage your Pieces account settings, authentication, linked accounts, organizati To access Account settings, click your `User Profile` in the top left, then hover over `Settings` and select `Account`. - +Account settings with profile, linked accounts, organizations, and subscriptions > Account settings showing profile information, linked accounts, organizations, and subscriptions @@ -190,7 +190,7 @@ Remove a linked account from your Pieces account. You can disconnect accounts fr View and manage your organization memberships from the Account settings page. The *Organizations & Teams* section displays all organizations you belong to, along with their subscription types and management options. - +Organizations and Teams section in Account settings > Account settings page showing Organizations & Teams section with organization list and management options diff --git a/public/content/desktop/configuration/appearance.md b/public/content/desktop/configuration/appearance.md index 2e52e91..1f9ee37 100644 --- a/public/content/desktop/configuration/appearance.md +++ b/public/content/desktop/configuration/appearance.md @@ -14,7 +14,7 @@ Customize the visual appearance of the Pieces Desktop App, including theme mode, To access Appearance settings, click your `User Profile` in the top left, then hover over `Settings` and select `Appearance`. - +Appearance settings with Theming, Fonts, and Spacing sections > Appearance settings showing Theming, Fonts, and Spacing sections diff --git a/public/content/desktop/configuration/connected-applications.md b/public/content/desktop/configuration/connected-applications.md index 6902992..c030fa4 100644 --- a/public/content/desktop/configuration/connected-applications.md +++ b/public/content/desktop/configuration/connected-applications.md @@ -14,7 +14,7 @@ Access documentation and get started guides for all available Pieces integration To access Connected Applications settings, click your `User Profile` in the top left, then hover over `Settings` and select `Connected Applications`. - +Connected Applications settings with integration links to documentation > Connected Applications settings showing list of available integrations with links to documentation diff --git a/public/content/desktop/configuration/copilot-chats.md b/public/content/desktop/configuration/copilot-chats.md index 384ecb3..d94c888 100644 --- a/public/content/desktop/configuration/copilot-chats.md +++ b/public/content/desktop/configuration/copilot-chats.md @@ -14,7 +14,7 @@ Customize your Pieces Copilot chat appearance and manage your chat history. Conf To access Copilot Chats settings, click your `User Profile` in the top left, then hover over `Settings` and select `Copilot Chats`. - +Copilot Chats settings with accent color and delete all chats options > Copilot Chats settings showing accent color option and delete all chats option @@ -42,7 +42,7 @@ Change the accent color used in your Pieces Copilot chats. The accent color affe - +Accent color picker grid with selected color marked > Color picker showing grid of 36 colors with selected color marked with Checkmark diff --git a/public/content/desktop/configuration/long-term-memory.md b/public/content/desktop/configuration/long-term-memory.md index 34e399b..da1b8f3 100644 --- a/public/content/desktop/configuration/long-term-memory.md +++ b/public/content/desktop/configuration/long-term-memory.md @@ -14,7 +14,7 @@ Manage long-term memory preferences and data. Configure the Long-Term Memory Eng To access Long-Term Memory settings, click your `User Profile` in the top left, then hover over `Settings` and select `Long-Term Memory`. - +Long-Term Memory settings with Memory Formation, Performance, and Stored Data > Long-Term Memory settings showing Memory Formation, Performance, and Stored Data sections @@ -99,7 +99,7 @@ LTM Audio, also known as Audio Ingestion, enables the Long-Term Memory Engine to - + LTM Audio permission setup flow on macOS > LTM Audio setup on macOS @@ -137,7 +137,7 @@ LTM Audio, also known as Audio Ingestion, enables the Long-Term Memory Engine to - + LTM Audio permission prompt on Windows > LTM Audio setup on Windows diff --git a/public/content/desktop/configuration/mcp.md b/public/content/desktop/configuration/mcp.md index 90d318a..12df6e5 100644 --- a/public/content/desktop/configuration/mcp.md +++ b/public/content/desktop/configuration/mcp.md @@ -14,7 +14,7 @@ Access server URLs and documentation for integrating Pieces Long-Term Memory wit To access MCP settings, click your `User Profile` in the top left, then hover over `Settings` and select `MCP`. - +Model Context Protocol settings showing server URLs and documentation > Model Context Protocol (MCP) settings showing server URLs and View Documentation option diff --git a/public/content/desktop/configuration/models.md b/public/content/desktop/configuration/models.md index f84110d..2e19a8e 100644 --- a/public/content/desktop/configuration/models.md +++ b/public/content/desktop/configuration/models.md @@ -14,7 +14,7 @@ Manage AI models and model preferences. Configure processing modes, set up local To access Models settings, click your `User Profile` in the top left, then hover over `Settings` and select `Models`. - +Models settings with capabilities, local runtime, and model management > Models settings showing Model Capabilities, Local Model Runtime, and Model Management sections @@ -164,7 +164,7 @@ Control which models are available by enabling or disabling them individually or - +Enabling a model with the toggle switch in Model Management > Models settings showing how to enable a model using the toggle switch @@ -186,7 +186,7 @@ Remove local models that you no longer need. This frees up storage space on your - +Deleting a local model from Model Management > Models settings showing how to delete a local model diff --git a/public/content/desktop/configuration/troubleshooting.md b/public/content/desktop/configuration/troubleshooting.md index 980d0e3..6d5d98d 100644 --- a/public/content/desktop/configuration/troubleshooting.md +++ b/public/content/desktop/configuration/troubleshooting.md @@ -14,7 +14,7 @@ Get help, troubleshoot issues, view app information, and contact support. Access To access Troubleshooting settings, click your `User Profile` in the top left, then hover over `Settings` and select `Troubleshooting`. - +Troubleshooting settings overview with resources, support, and app information > Troubleshooting settings showing Online Resources, Get In Touch, PiecesOS Information, and Desktop App Information sections diff --git a/public/content/desktop/configuration/views-layouts.md b/public/content/desktop/configuration/views-layouts.md index 1a80e0d..088df22 100644 --- a/public/content/desktop/configuration/views-layouts.md +++ b/public/content/desktop/configuration/views-layouts.md @@ -14,7 +14,7 @@ Customize confirmation settings, metrics summary display, and saved materials to To access Views & Layouts settings, click your `User Profile` in the top left, then hover over `Settings` and select `Views & Layouts`. - +Views and Layouts settings overview > Views & Layouts settings showing Confirmation Settings, Metrics Summary Settings, and Default Toolbar options @@ -38,7 +38,7 @@ Configure which confirmation menus appear when performing deletions or updates. - +Confirmation Menu Settings popup with Deletions and Updates > *Confirmation Menu Settings* popup showing Deletions and Updates sections with checkboxes @@ -83,7 +83,7 @@ Configure confirmation prompts for shareable link updates. When enabled, Pieces - +Updates section for shareable link confirmation options > Updates section showing Shareable Link update confirmation options @@ -107,7 +107,7 @@ Customize when and how the Metrics Summary displays in Gallery View. Control the - +Metrics Settings popup with Mode and Visibility options > *Metrics Settings* popup showing Mode and Visibility options @@ -181,7 +181,7 @@ Configure the default toolbar that appears for saved materials. Choose between D - +Default Toolbar dropdown with Default, Suggested, and Custom options > Default Toolbar dropdown showing Default, Suggested, and Custom options diff --git a/public/content/desktop/conversational-search.md b/public/content/desktop/conversational-search.md index 9bafd5a..dafe033 100644 --- a/public/content/desktop/conversational-search.md +++ b/public/content/desktop/conversational-search.md @@ -21,7 +21,7 @@ metaDescription: Conversational Search is the ability to talk with your memories You can talk with all your memories, or customize which memories to include by filtering by specific apps and time ranges. Ask specific questions about your past work, and Conversational Search provides contextual answers based on your actual workflow history, powered by [Long-Term Memory (LTM-2.7)](/products/core-dependencies/pieces-os#ltm-27) with access to up to 9 months of captured memories. - +Home view with Conversational Search, suggested prompts, and Start New Chat > Homepage showing Conversational Search section with suggested prompts and Start New Chat button diff --git a/public/content/desktop/conversational-search/chat-with-timeline-events.md b/public/content/desktop/conversational-search/chat-with-timeline-events.md index 554d09c..c480213 100644 --- a/public/content/desktop/conversational-search/chat-with-timeline-events.md +++ b/public/content/desktop/conversational-search/chat-with-timeline-events.md @@ -12,7 +12,7 @@ metaDescription: Start context-specific conversations directly from Timeline Eve Start context-specific chats directly from any Timeline Event. When you start a conversation with a Timeline Event, it opens in Conversational Search with that event's full context pre-loaded and displayed as an information card. Use this when you want to ask questions about a specific past moment, understand what happened during a particular work session, or drill into details of a specific Timeline Event. - +Conversational Search with Timeline Event context card and chat input > Conversational Search view showing a Timeline Event card with pre-loaded context and input field ready for questions @@ -30,7 +30,7 @@ Start a context-specific conversation from any Timeline Event using the `Start R - +Timeline Event detail with Start Related Chat opening Conversational Search > Conversational Search showing memory, Timeline Event, Start Related Chat, and Conversational Search open with Timeline Event card displayed @@ -44,7 +44,7 @@ When Conversational Search opens with a Timeline Event, you'll see an informatio * "Summarize the key outcomes from this work" * "What happened next?" - +Scoped chat with event card, placeholder prompt, and model toolbar > Conversational Search interface showing Timeline Event information card with event details, input field with placeholder text, and bottom toolbar with model selection and filters diff --git a/public/content/desktop/conversational-search/context-integration.md b/public/content/desktop/conversational-search/context-integration.md index b6f57ea..825e287 100644 --- a/public/content/desktop/conversational-search/context-integration.md +++ b/public/content/desktop/conversational-search/context-integration.md @@ -52,7 +52,7 @@ Turn off Long-Term Memory context when you want conversations without historical - +Toggling LTM context for Conversational Search > User profile menu showing LTM-2.7 hover menu with pause and turn off options @@ -98,7 +98,7 @@ Open the Relevant Summaries sidebar to see which Timeline Events were used in a - +Relevant Summaries button showing source Timeline Events > Relevant Summaries sidebar open showing Timeline Events used to generate the response, with sort dropdown visible in the top right diff --git a/public/content/desktop/conversational-search/using-conversational-search.md b/public/content/desktop/conversational-search/using-conversational-search.md index 811f983..2a1dd6c 100644 --- a/public/content/desktop/conversational-search/using-conversational-search.md +++ b/public/content/desktop/conversational-search/using-conversational-search.md @@ -10,7 +10,7 @@ metaDescription: Learn how to talk with your memories, filter searches, switch m ***Conversational Search*** is the ability to talk with your memories. You can have conversations with your captured workflow context—ask specific questions, search through your memories, and filter by apps or time ranges to customize which memories you're talking with. All responses are powered by [Long-Term Memory (LTM-2.7)](/products/core-dependencies/pieces-os#ltm-27). - +Conversational Search interface with suggested prompts, chat input, model selector > Full Conversational Search interface on homepage showing suggested prompts, chat input, model selector, and bottom toolbar @@ -22,7 +22,7 @@ Have conversations with your captured workflow context. Ask specific questions a Suggested prompts appear as clickable buttons based on your recent workflow. Click any prompt to instantly start that conversation. Responses include Related Timeline Events cards showing which memories were used as sources. - +Clicking suggested prompt showing response with Related Timeline Events cards > Clicking a suggested prompt, showing the complete flow from click to response with Related Timeline Events cards @@ -51,7 +51,7 @@ Type your own questions to have conversations with your memories about specific * "What did Sarah and I discuss about the API redesign in Teams?" * "Show me the code changes I made related to WebSocket connections" - +Start New Chat button and input field with example question typed > Start New Chat button and input field with example question typed @@ -81,7 +81,7 @@ Limit searches to memories from specific applications. Use this when you want an - +Sources filter modal with app checkboxes, Chrome and VS Code selected > Sources filter modal showing list of apps with checkboxes, with Chrome and VS Code selected @@ -103,7 +103,7 @@ Focus searches on specific time periods. Use this when you need information from - +Time Ranges modal showing preset options and calendar view > Time Ranges modal showing preset options and calendar view @@ -127,7 +127,7 @@ All response actions are available in the *toolbar* below each response: * **Convert to Timeline Event:** Click the `paper/document icon` to save important responses—they'll appear in the *memories sidebar* for later reference * **Use as Context:** Click the `three-dot menu` (`⋮`) and select "Use as Context" to add the response as context for follow-up questions - +Response toolbar with Copy, Export, Regenerate, and Convert buttons > Response toolbar showing Copy, Export, Regenerate, Convert to Timeline Event, and More menu buttons labeled @@ -135,7 +135,7 @@ All response actions are available in the *toolbar* below each response: Cards appear below responses showing which source Timeline Events were used to generate the answer. Click any card to view the full Timeline Event details and verify where information came from. - +Response with Related Timeline Events cards showing memory titles and timestamps > Response with Related Timeline Events cards below showing memory titles and timestamps @@ -157,7 +157,7 @@ Switch between cloud and local models based on your needs. Use cloud models (Cla - +Model selector dropdown with recent, suggested, and all models options > Model selector dropdown diff --git a/public/content/desktop/copilot.md b/public/content/desktop/copilot.md index 42afb75..f15eb88 100644 --- a/public/content/desktop/copilot.md +++ b/public/content/desktop/copilot.md @@ -8,7 +8,7 @@ metaTitle: Introduction to Pieces Copilot | Pieces Docs metaDescription: Download the Pieces Desktop App and access OS-specific installation guides for Windows, macOS, and Linux to get started quickly --- - +Pieces Copilot introduction banner *** @@ -48,7 +48,7 @@ We’ll walk you through the main Copilot Chat window and touch on all of the ma You’ll learn how to interact with Pieces Copilot, utilize flexible *Suggested Prompts* when starting new chats, enable or disable Long-Term Memory context, add individual items to the chat, and discover other productivity-centric *Quick Actions.* - +Pieces Copilot main chat with suggested prompts and quick actions ### Context & Project Integration @@ -58,7 +58,7 @@ By integrating local folders, files, and your saved code snippets, you can signi In this section, we'll cover context and project management—adding items from Pieces Drive or your device as chat context, offering real-world examples to reduce context switching, and showing how to adjust the AI's understanding of your environment or workflow. - +Adding a folder as context in Pieces Copilot chat ### Configuring Pieces Copilot @@ -66,7 +66,7 @@ Pieces Copilot offers flexibility in choosing the AI model (cloud-based or local Choose from over 40 cloud-hosted and local models (including those served via Ollama and other providers), adjust your runtime settings, customize the appearance of your Copilot Chat view, enable or disable LTM context for new chats, and more. - +Asking Pieces Copilot a question in the chat ### Pieces Copilot in Multiple Environments @@ -80,7 +80,7 @@ We’ll go over cross-platform consistency with context, history, and usage sync *Pieces Copilot in JetBrains IDEs* - +Pieces Copilot in JetBrains IDEs *** diff --git a/public/content/desktop/copilot/configuration.md b/public/content/desktop/copilot/configuration.md index 9a9dc04..6246ad3 100644 --- a/public/content/desktop/copilot/configuration.md +++ b/public/content/desktop/copilot/configuration.md @@ -22,7 +22,7 @@ At the bottom left of the Pieces Copilot view is the active model. By default, t Clicking this button opens the **Manage Copilot LLM Runtime** modal, where you can enter your own API key or [select local and cloud-hosted LLMs served through Pieces.](/products/core-dependencies/pieces-os#local-vs-cloud-models) - +Manage Copilot LLM Runtime modal listing cloud and local models Some cloud models are available to Pieces Pro users only (for example: OpenAI GPT-5.2 Pro/GPT-5.2, Anthropic Claude 4.5 Opus, Google Gemini 3 Pro Preview). To unlock these premium models, see [Pieces Pro](/paid-plans). @@ -44,7 +44,7 @@ You can read this documentation containing [all local and cloud-hosted LLMs avai In case you need a fresh start or want to clear the current context, the interface includes options (accessible via the **Chat Options** menu) to reset the conversation. - +Resetting a Pieces Copilot conversation from Chat Options This is particularly useful when you want to switch focus or change the conversation pipeline. @@ -52,7 +52,7 @@ This is particularly useful when you want to switch focus or change the conversa To browse and download local models, click the **Active Model** button and hover over **All Models**, then scroll down to find available local models. - +Scrolling the All Models list to browse and download local models Local models are downloaded on-demand through PiecesOS. Simply select a local model to download and use it. @@ -70,10 +70,10 @@ Within the same modal area, a `Settings Gear` icon gives you access to personali From here, you can choose a chat accent color to customize the look and feel of your Copilot interface, and enable or disable the option to enable LTM by default when starting a new chat. - +Copilot chat appearance settings with accent color and LTM default toggle When enabling Long-Term Memory Context by default, every new chat automatically incorporates your saved long-term memory context, ensuring that your conversations are always informed by your previous work. You can also use the keyboard shortcut `cmd+shift+t` (macOS) or `ctrl+shift+t` (Windows/Linux) to toggle the *Dark/Bright* theme for the Pieces Desktop App. - \ No newline at end of file +Pieces Copilot chat view after theme customization \ No newline at end of file diff --git a/public/content/desktop/copilot/integration.md b/public/content/desktop/copilot/integration.md index fd6cd91..7930c0c 100644 --- a/public/content/desktop/copilot/integration.md +++ b/public/content/desktop/copilot/integration.md @@ -22,7 +22,7 @@ Integrating context ensures Pieces Copilot isn’t answering in a vacuum. By including Long-Term Memory data and project-specific resources, you can improve the accuracy of generative AI responses, reduce context-switching, work more effectively. - +Pieces Copilot response with LTM Workstream Activity context cards ### Related Workstream Activities @@ -30,7 +30,7 @@ Pieces Copilot will draw on memories and workflow context captured by the LTM en The Timeline cards will display under the response with several cards linking to past timeline events that contain the context used to create that response. - +Timeline context cards under a Copilot response linking to past events Clicking one of the surfaced context cards will take you to that specific Roll-Up in **Timeline**. @@ -44,7 +44,7 @@ When turned on, your long-term memory data—captured by PiecesOS from your prev This means that even if you start a fresh conversation, Pieces Copilot has access to important context from earlier sessions. - +Toggling LTM context on in the Pieces Copilot view ### Adding Folders @@ -56,7 +56,7 @@ To do so, click `Add Folders` to open your Finder (macOS) or File Explorer (Wind Select the directories that you want the Pieces Copilot to use as context. This is especially useful when working on large projects where entire folders contain valuable code references. - +Adding folders as context in Manage Copilot Context ### Adding Files @@ -64,7 +64,7 @@ Similarly, clicking the `Files` button opens the same modal so you can select in Click `Add Files` to select specific code files. - +Adding individual files as Copilot context These files are then parsed by Pieces Copilot to provide precise answers related to your code. @@ -74,7 +74,7 @@ If you need to reference external code on a website—like on Stack Overflow—c This opens a modal where you can enter a website URL. - +Adding a website URL as Copilot context Websites with code snippets or technical documentation can then be used as contextual material for your Pieces Copilot queries. @@ -88,6 +88,6 @@ Clicking the `Saved Materials` button opens up an interface that displays a clic Choose the relevant saved material that you’d like to include in your current conversation. - +Selecting saved materials from Pieces Drive as Copilot context This ensures that the Pieces Copilot is aware of your pre-curated, AI-enriched materials and can reference them in its responses. diff --git a/public/content/desktop/copilot/interaction.md b/public/content/desktop/copilot/interaction.md index 17f1962..1f528ff 100644 --- a/public/content/desktop/copilot/interaction.md +++ b/public/content/desktop/copilot/interaction.md @@ -12,7 +12,7 @@ metaDescription: Introduction to Pieces Copilot – your AI assistant for techni When opening the Pieces Desktop App after installation, you are first presented with a default view—the Pieces Copilot. - +Pieces Copilot main chat interface with input field and sidebar This view is the central hub from which you can start new chats, access previous chats, and configure Long-Term Memory, models, and context to suit the task at hand. @@ -34,7 +34,7 @@ Directly above the chat input field, a *Set Context* area provides four buttons: * `Saved Materials`**:** Lets you pick items previously saved in Pieces Drive. - +Adding snippet context to Copilot chat via Set Context buttons These buttons help you easily inject context into your chat so Pieces Copilot can deliver more accurate and relevant responses. @@ -60,7 +60,7 @@ This is your primary area for entering queries or pasting code, and is flanked b * To the *right,* you’ll find actions to insert code blocks into the chat or extract code from screenshots. - +Quick action buttons and tools in the Copilot input field ### Left-Side Quick-Action Button @@ -106,7 +106,7 @@ At the top right corner of the active chat window, a vertical ellipsis (three st When Pieces Copilot generates a reply, a toolbar appears with helpful buttons, icons, and cards to manage or reuse that output. - +Response toolbar with copy, export, regenerate, and other action options ### Response Toolbar Actions @@ -124,7 +124,7 @@ There are several actions you can take under each generated Pieces Copilot respo 6. `More Options (⋮)`: The three-dot menu (`⋮`) reveals additional actions. You can select `Use as Context` to add that specific response as context for follow-up prompts, or `Delete Message` to remove the message from the current conversation. - +More options menu showing use as context and delete message actions If LTM Context is enabled, you may also see related context cards surface beneath the response. These link to timeline events that informed the generation. @@ -146,7 +146,7 @@ When clicked, it presents you with 3 options: *** - +Chat pipeline options dropdown showing multipurpose, code comprehension, and code generation You can select one of these chat pipelines as the default pipeline when creating new chats. @@ -160,7 +160,7 @@ This allows you to quickly revisit previous interactions by clicking on a chat e An icon at the top of the sidebar lets you collapse or expand this panel as needed—called **Focus Mode**—so you can focus solely on your current conversation if desired. - +Sidebar showing chat history with dates and expanding focus mode toggle ## Searching Previous Chats @@ -170,7 +170,7 @@ This opens a centered modal showing your recent chats. You can scroll this list, and each item displays a percentage on the right that represents how relevant that chat likely is to your current workflow or how frequently you return to it. - +Find chats search field showing recent chats with relevance percentages ### Running a Search @@ -178,7 +178,7 @@ Type your query into the search field and press `enter` (Windows/Linux) or `retu If a chat is an exact match for your query, you’ll see an `EXACT MATCH` label on the right instead of a percentage. - +Chat search results with highlighted matching terms and exact match labels Pressing enter/return is **required** to run the search from the modal. @@ -212,7 +212,7 @@ Using this feature, simply ask Pieces Copilot *"Can you perform a deep study on - Deep Study runs on a dedicated cloud LLM managed by Pieces (currently a Google model, subject to change). - Changing your selected model via the standard LLM Runtime modal does not affect Deep Study. Your per-chat model choice applies to normal responses, but Deep Study always uses its dedicated runtime. - +Deep Study progress interface showing thinking state and agent intermediate steps Deep Study requires that you enable the Long-Term Memory Engine. diff --git a/public/content/desktop/copilot/multiple-environments.md b/public/content/desktop/copilot/multiple-environments.md index 0273279..8bce59d 100644 --- a/public/content/desktop/copilot/multiple-environments.md +++ b/public/content/desktop/copilot/multiple-environments.md @@ -55,11 +55,11 @@ The Copilot experience supports *cross-threading.* This means that your chat history and contextual data can be shared between the Desktop App and other environments. - +Cross-threaded Copilot chat shared between Desktop App and IDE Whether you start a conversation in the Desktop App and later continue it in an IDE, your context and settings persist—making for a fluid, uninterrupted workflow. - +Continuing a Copilot conversation across environments ## The Pieces User Experience @@ -73,7 +73,7 @@ In platforms such as JetBrains, Visual Studio Code, and the Pieces Web Extension *Pieces Web Extension* - +Pieces Copilot applet in the Web Extension *** @@ -87,6 +87,6 @@ Although the visual presentation differs, all core features remain available, so *Pieces for Sublime Text Plugin* - +Pieces Copilot interface in Sublime Text *** diff --git a/public/content/desktop/download.md b/public/content/desktop/download.md index 9161c4b..160cea1 100644 --- a/public/content/desktop/download.md +++ b/public/content/desktop/download.md @@ -18,6 +18,10 @@ Select the appropriate download file for your platform (macOS/Windows) or follow macOS users will be prompted to select the proper download file based on their device’s architecture—ARM or Intel. + + **Don't install** to **OneDrive**, **iCloud Drive**, or other **synced** folders—use a **local path** (the default is best). Details: [Windows](/products/meet-pieces/windows-installation-guide#on-screen-prompts), [manual install](/products/core-dependencies/pieces-os/manual-installation#manual-download--installation). + + ## Downloads Find the download files for the Pieces Desktop App for your macOS or Windows device below. diff --git a/public/content/desktop/drive/enrichment-and-metadata.md b/public/content/desktop/drive/enrichment-and-metadata.md index 735677a..10d067c 100644 --- a/public/content/desktop/drive/enrichment-and-metadata.md +++ b/public/content/desktop/drive/enrichment-and-metadata.md @@ -28,7 +28,7 @@ Located on the left sidebar, the **Saved Materials List** displays each of your Click any item to load it in the main detail pane. This is where you’ll see the code or text, along with a wealth of automatically generated context (tags, annotations, etc.). - +Pieces Drive gallery view of saved materials ### Renaming and Reclassifying @@ -38,7 +38,7 @@ In the detail view, locate the three-dot **Quick Menu** to reveal actions for cu * `Reclassify`: If Pieces incorrectly detects the code’s language or you’d prefer to classify it differently, you can manually select a new language (e.g., reclassifying JavaScript as TypeScript). - +Reclassify saved material language or type ### Managing Tags @@ -72,7 +72,7 @@ If something isn’t automatically detected, you can still mark something as *se * **Manual Entry**: You can also mark something as sensitive if it’s not automatically detected. This adds an extra layer of privacy for your team or organization. - +Marking sensitive strings in a saved material ### Anchors & Related People @@ -100,4 +100,4 @@ From within the main detail view of a snippet, the **Quick Menu** (often represe 5. `Delete`: Permanently remove the snippet if it’s no longer needed. - \ No newline at end of file +Managing annotations on a saved snippet \ No newline at end of file diff --git a/public/content/desktop/drive/save-and-organize.md b/public/content/desktop/drive/save-and-organize.md index e96d1c9..4c10a97 100644 --- a/public/content/desktop/drive/save-and-organize.md +++ b/public/content/desktop/drive/save-and-organize.md @@ -28,7 +28,7 @@ From this list, you can scroll down to see previous saved materials, or click th * `Language`**:** Groups saved materials by language—Python, JavaScript, Kotlin, etc. - +Sort and filter controls in Pieces Drive ### Adding New Materials @@ -36,7 +36,7 @@ The primary way to add materials to Pieces Drive is through the `Add Materials` Clicking it opens a modal that presents several distinct options for different workflows and preferences. - +Adding a new code snippet in Pieces Drive ### Paste Code from Clipboard diff --git a/public/content/desktop/drive/search-and-filter.md b/public/content/desktop/drive/search-and-filter.md index 50338db..d171da5 100644 --- a/public/content/desktop/drive/search-and-filter.md +++ b/public/content/desktop/drive/search-and-filter.md @@ -20,7 +20,7 @@ At the very top of the Pieces Drive view is the **Search Bar**, labeled *Find Ma This is your starting point for quick lookups. - +Search field in Pieces Drive ### Natural Language Queries @@ -36,7 +36,7 @@ After you type your query, results populate in the Saved Materials List on the l Each matching snippet’s auto-generated title and a quick preview appear—just click any snippet to open it in the main detail pane. - +Quick search filters in Pieces Drive Searching “local storage React” can bring up multiple snippets involving React’s local storage usage, even if the phrase “local storage” doesn’t appear verbatim in the snippet title. @@ -79,7 +79,7 @@ These advanced filters let you refine your search using specific criteria and st Pieces lets you filter using *language*, *tags* and specific *natural language phrases* so that you see only what you need to see—this is particularly useful if you have similar-sounding snippets across multiple languages. - +Advanced search filters in Pieces Drive There are a few different use cases for searching with these methods: diff --git a/public/content/desktop/drive/sharing.md b/public/content/desktop/drive/sharing.md index 53df698..21567e3 100644 --- a/public/content/desktop/drive/sharing.md +++ b/public/content/desktop/drive/sharing.md @@ -18,7 +18,7 @@ One of the most convenient ways to collaborate or showcase work is by sending a Pieces Drive makes this process dirt-simple using *shareable links*, which allow others to view your snippet and its related metadata in a consistent, Pieces-branded web interface—even if they don’t have Pieces installed.  - +Shareable link preview for a saved snippet These links preserve the snippet’s code, syntax highlighting, tags, annotations, and other contextual data—this way, recipients see not just lines of text, but the snippet’s *entire backstory and classification.* @@ -34,7 +34,7 @@ Find and click the **three-dot Quick Menu** (usually in the top-right corner of Then, choose `Generate Shareable Link` or `Shareable Link`—if it's your first time creating a link for that snippet, Pieces will make a new unique URL. - +Generating a shareable link from the snippet quick menu If you’ve already generated a link for this material before, it exists in the cloud—so you can just copy the shareable link to your clipboard. @@ -46,7 +46,7 @@ You can toggle a different shareable link modal that provides you with the previ If you want to see how the snippet appears, simply paste the link into a web browser. - +Shared snippet opened in the browser with metadata You’ll find a code view, syntax highlighting, any relevant tags, annotations, and a snippet description—just like in Pieces Drive. @@ -94,7 +94,7 @@ This will give you access to the shareable link in an input field, the option to 3. `Revoke Link`**:** Similar to *deleting a material,* this button essentially ‘deletes’ the shared link, taking the saved material off of the cloud so that it cannot be accessed outside of your Pieces Drive. - +Shareable Link section in snippet quick menu ## Use Cases & Workflows diff --git a/public/content/desktop/drive/transforming-code.md b/public/content/desktop/drive/transforming-code.md index 8be2407..9d6860b 100644 --- a/public/content/desktop/drive/transforming-code.md +++ b/public/content/desktop/drive/transforming-code.md @@ -32,7 +32,7 @@ There are two ways to access the code transformation feature within the Pieces D By clicking the white `‘+’ icon` in the bottom left of the Pieces Drive view—also known as the *Add Materials* button—you can click `Duplicate Current`, which accesses the currently-viewed saved material and provides several different options for transformation. - +Duplicate saved material action in Pieces Drive ### via Quick Menu diff --git a/public/content/desktop/navigation.md b/public/content/desktop/navigation.md index fa93c02..cc16f92 100644 --- a/public/content/desktop/navigation.md +++ b/public/content/desktop/navigation.md @@ -18,7 +18,7 @@ There are two ways to open the **Power Menu**: Click the `Home Icon` to the left of the *Search Bar* to open up the **Power Menu.** - + Opening the Power Menu from the Home icon @@ -54,7 +54,7 @@ From this menu, you can either click or scroll through some of the available opt These actions, some of which are view-specific—like refreshing a selected Conversational Search conversation—are useful ways to navigate throughout the Pieces Desktop App while maintaining speed and efficiency in your workflow. - +Find Action search in the Power Menu Included at the very end of the scrollable **Find Actions** list are links to other Pieces plugins and extensions, as well as social outlets (Pieces YouTube, [Pieces Discord](https://discord.com/invite/getpieces), etc.) and two additional links for reporting issues or contacting support. @@ -70,7 +70,7 @@ This view contains several different buckets of configurable options: [Account]( You can toggle Focus Mode by clicking the `Focus Mode` button located in the upper left of the Conversational Search or Pieces Drive view, near the sidebar. - +Toggling Focus Mode to hide or show the sidebar When activated, it closes the sidebar, giving you an expanded view of your current Conversational Search conversation. diff --git a/public/content/desktop/navigation/global-search.md b/public/content/desktop/navigation/global-search.md index dc12ef0..080a1e5 100644 --- a/public/content/desktop/navigation/global-search.md +++ b/public/content/desktop/navigation/global-search.md @@ -34,7 +34,7 @@ When **Global Search** first opens, you’ll see: * A ‘Powered by NCS’ indicator and an `i` icon at the bottom, which explains more about NCS when hovered over. - +Global Search overlay for saved materials ### Suggested Searches @@ -42,7 +42,7 @@ Below the search bar, you’ll find a list of *Suggested Searches* based on your To use this feature, either click a *Suggested Search* to immediately run that query, or click the `Refresh` icon to load a new set of suggestions. - +Suggested searches in Global Search ### Performing a Search @@ -50,7 +50,7 @@ To perform a search, type your query into the *Find Materials* field, then press Pieces will perform the search and display your results in the main view, sorted by how relevant they are to your query. - +Typing a query and viewing Global Search results ## Search Results @@ -58,7 +58,7 @@ Once you run a search, **Global Search** populates the main area with matching s Results are split into two sections, showing the list of located code snippets, materials, and other related context. - +Global Search results list with matching snippets ### Material List diff --git a/public/content/desktop/navigation/settings.md b/public/content/desktop/navigation/settings.md index e77885c..2cf8eb0 100644 --- a/public/content/desktop/navigation/settings.md +++ b/public/content/desktop/navigation/settings.md @@ -20,7 +20,7 @@ To access settings, press `⌘+,` (macOS) or `ctrl+,` (Windows/Linux). You can also open the **Power Menu**, type ‘settings’ in the search field, and select `Go To Settings` from the dropdown menu. - +Settings window with category sidebar ## Understanding the Settings Layout @@ -40,7 +40,7 @@ In this section, you can integrate external services with Pieces and adjust your This area displays your email address and any linked accounts. - +Accounts and Cloud Integrations modal If you’re interested in testing upcoming features, the **Early Access Program** lets you join beta releases and stay ahead of the curve. @@ -50,7 +50,7 @@ The Personal Cloud settings are now part of the [Account](/products/desktop/conf You'll see a status for your cloud connection (including the last sync time), plus options to set or modify your personal domain. - +Personal Cloud connect and disconnect controls There's also a `Backup & Restore Data` feature to preserve or retrieve your snippets from the cloud whenever needed. @@ -84,7 +84,7 @@ The [Models](/products/desktop/configuration/models) settings allow you to confi * `Model Management`: Enable or disable specific AI models from different providers (OpenAI, Anthropic, Google, Microsoft, Meta, IBM, etc.). - +Processing mode selection for ML in Settings ### Views & Layouts @@ -102,7 +102,7 @@ You’ll also find options for `Confirmation Settings` (for specific actions), t * `Default Toolbar`: Assign a default toolbar to new snippets. - +Changing Workstream Activity view layout ### Appearance @@ -112,7 +112,7 @@ Switch between light or dark mode, select an accent color for UI highlights, adj These controls help you create a comfortable coding environment for extended sessions. - +Accent color picker in Appearance settings ### Troubleshooting diff --git a/public/content/desktop/navigation/updates.md b/public/content/desktop/navigation/updates.md index ff5c149..4fdbb4c 100644 --- a/public/content/desktop/navigation/updates.md +++ b/public/content/desktop/navigation/updates.md @@ -18,7 +18,7 @@ You can check for new updates, preview future enhancements, and even share feedb You can open this page through the **Power Menu** by clicking the home icon next to the search bar in the Pieces Desktop App, then selecting `Updates & Upcoming` from the dropdown. - +Updates and Upcoming in the Power Menu Alternatively, press `shift+w` (macOS/Windows/Linux) on your keyboard to jump there instantly. @@ -30,7 +30,7 @@ At the top, you’ll find **Upcoming Features**, which highlight planned feature Below that, you’ll see **Previous Releases**, which outlines all new additions, fixes, and improvements that have already been rolled out. - +Release notes on the Updates and Upcoming page ### Upcoming Features diff --git a/public/content/desktop/onboarding.md b/public/content/desktop/onboarding.md index ac3f85e..dac6973 100644 --- a/public/content/desktop/onboarding.md +++ b/public/content/desktop/onboarding.md @@ -24,7 +24,7 @@ When you first launch the Pieces Desktop App, you'll be prompted to sign in with - +Pieces Desktop sign-in page with GitHub, Google, and Microsoft > Login page showing sign-in options including GitHub, Google, and other authentication providers @@ -44,7 +44,7 @@ After signing in, configure your initial preferences including theme mode and da - +Initial preferences with theme, telemetry toggle, and Get Started > Theme selection screen showing Light and Dark theme options, anonymous crash data toggle, and Get Started button @@ -58,7 +58,7 @@ The homepage displays the *Single-Click Summaries* section with six cards: `What When you first arrive at the homepage, you'll see the LTM welcome screen that explains Long-Term Memory and its benefits. This screen introduces you to how Pieces captures and uses your workflow context to provide personalized AI assistance. - +LTM welcome screen explaining Long-Term Memory > LTM welcome screen explaining Long-Term Memory and its benefits @@ -66,7 +66,7 @@ When you first arrive at the homepage, you'll see the LTM welcome screen that ex After clicking `Got It` on the LTM welcome screen, you'll see the initial memory formation interface. This screen shows the progress of memory formation and introduces you to Single-Click Summaries that will become available once memories are captured. - +Initial memory formation progress and locked Single-Click Summary cards > Initial memory formation screen showing progress tracker, memory formation status, and Single-Click Summary cards @@ -90,7 +90,7 @@ Continue with your normal workflow for 10-15 minutes while LTM-2.7 captures work Once you've successfully captured 30 memories, the six *Single-Click Summaries* cards become clickable and unlock. You can now generate summaries like `Standup Update`, `Day Recap`, `What's Top of Mind`, and more. Each card provides one-click access to contextual summaries based on your captured workflow data, giving you instant insights into your productivity and work patterns. - +Pieces Timeline with unlocked summaries and workflow events > Pieces Timeline showing unlocked Single-Click Summary cards and workflow events @@ -102,7 +102,7 @@ Once you've successfully captured 30 memories, the six *Single-Click Summaries* Conversational Search lets you ask questions about your workflow and get context-aware responses powered by LTM-2.7. You can visit sites like Stack Overflow, read code explanations, and later query Conversational Search about what you read. By enabling LTM, you can use Conversational Search as an AI assistant trained on your personal workflow data, making it uniquely helpful for your specific work patterns and projects. - +Conversational Search model selector dropdown > Conversational Search interface showing model selection dropdown and available models @@ -114,7 +114,7 @@ Conversational Search lets you ask questions about your workflow and get context Access Conversational Search directly from the homepage to ask questions about your workflow, with LTM providing context from your captured memories. You can switch between cloud-hosted and local models using the model selector in the chat interface. - +Typing a question into Conversational Search > Typing a prompt into Conversational Search input field diff --git a/public/content/desktop/single-click-summaries.md b/public/content/desktop/single-click-summaries.md index 70a1d3a..bb6623a 100644 --- a/public/content/desktop/single-click-summaries.md +++ b/public/content/desktop/single-click-summaries.md @@ -49,7 +49,7 @@ Track your summaries as they generate in the Pieces Timeline. When you generate - +Timeline with queued Single-Click Summaries for the current day > Pieces Timeline showing current day expanded with queued summaries visible, including "What's Top of Mind" showing "Queued (#3)", "Day Recap" showing "Queued (#2)", and "AI Habits" showing "Next in queue" @@ -88,7 +88,7 @@ Access your completed summaries and view the full results. When a summary finish - +Completed summary with insights, related activities, and document links > Completed summary view showing full results with insights, related activities, and links to relevant documents @@ -119,7 +119,7 @@ Schedule single-click summaries to run automatically at a time you choose. As lo 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 summary modal with frequency, day, and time options > Schedule modal showing repeat frequency (Daily/Weekly), day selection, time options, and schedule confirmation message @@ -278,7 +278,7 @@ Generate summaries tailored to specific time periods and topics that matter to y 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. - +Discover popup listing summary types and Request a Summary > Discover popup showing available summary options including Request a Summary @@ -304,7 +304,7 @@ Suggest new summary types to help shape future Single-Click Summary options. Fro - +Request a Summary form with name, description, and submit > Request a Summary popup with Artifact Name and Description fields, and Submit Request button diff --git a/public/content/desktop/timeline.md b/public/content/desktop/timeline.md index 47fce3c..9f69f74 100644 --- a/public/content/desktop/timeline.md +++ b/public/content/desktop/timeline.md @@ -37,7 +37,7 @@ Access Pieces Timeline from the main view to see all your workflow events and su - +Show Timeline button to open Timeline view > Main view showing `Show Timeline` button in top left, with Pieces Timeline open displaying chronological events @@ -51,7 +51,7 @@ Pieces Timeline displays three main types of events, all organized chronological * **Conversational Searches** - [Chat conversations you have with your memories](/products/desktop/conversational-search). Each conversation appears as an event in Pieces Timeline, allowing you to revisit past conversations and their context. - +Searching timeline events and activities > Pieces Timeline showing different event types: conversational search event, standup update summary, and timeline events with app icons @@ -77,7 +77,7 @@ When you generate single-click summaries, they appear under the current day in P - +Queued summaries in Timeline > Pieces Timeline showing current day expanded with queued summaries visible, including "What's Top of Mind" showing "Queued (#3)", "Day Recap" showing "Queued (#2)", and "AI Habits" showing "Next in queue" @@ -104,7 +104,7 @@ Click any event in Pieces Timeline to view its full content in the main view pan - +Timeline summaries and day sections in Timeline > Event selected in Pieces Timeline (highlighted) with its full content displayed in the main view panel on the right @@ -153,7 +153,7 @@ Quickly navigate to a specific event's position in the Timeline sidebar when vie - +Jump to summary in Timeline list > Pieces Timeline showing day groups (Today expanded, Yesterday collapsed) with event counts, and `Jump to Summary in List` button visible in header diff --git a/public/content/desktop/timeline/conversational-chat.md b/public/content/desktop/timeline/conversational-chat.md index d3a3a4c..eb6a33e 100644 --- a/public/content/desktop/timeline/conversational-chat.md +++ b/public/content/desktop/timeline/conversational-chat.md @@ -14,7 +14,7 @@ metaDescription: Ask questions about your workflow with context-aware assistance Unlike generic AI, responses reference your specific work. Related Roll-Ups cards below responses reveal which memories were used. - +Conversational Chat with suggested prompts and Start New Chat > Conversational Chat section showing suggested prompts: "Explain Conversational Chat", "Summarize my memories", "Document onboarding changes", and "Start New Chat" button @@ -30,7 +30,7 @@ Prompts update dynamically (e.g., "Summarize my memories", "Document onboarding Click the `Start New Chat` button (blue, bottom-right). Type naturally: "What did I work on yesterday?" or "Find that Slack conversation about API changes." Press Enter to send. - +Chat interface opening after a suggested prompt or Start New Chat > Clicking a suggested prompt or Start New Chat, showing the chat interface opening @@ -48,7 +48,7 @@ Below each response, "Related Workstream Activities" cards appear showing which Each card is clickable and takes you to full LTM Roll-Up details, providing transparency into where information came from. - +Response with Related Workstream Activities cards linking to roll-ups > Chat response with 2-3 Related Roll-Up cards below, showing user clicking a card to view full roll-up @@ -69,7 +69,7 @@ Click any model name to switch. Use the "All Models" button to see the complete * **Time Ranges**—Filter memories by time period. * **Activate DeepStudy**—Enhanced research mode for comprehensive analysis. - +Model selector with Recent and Suggested models and Sources, Time Ranges, DeepStudy > Model selector dropdown showing Recent and Suggested sections with available models, plus bottom toolbar with Sources, Time Ranges, and Activate DeepStudy buttons diff --git a/public/content/desktop/timeline/event-actions.md b/public/content/desktop/timeline/event-actions.md index a44622e..f87cedd 100644 --- a/public/content/desktop/timeline/event-actions.md +++ b/public/content/desktop/timeline/event-actions.md @@ -14,7 +14,7 @@ All events in Pieces Timeline—including conversational searches, Timeline Even Understanding which actions are available helps you manage your Timeline effectively and customize events to fit your workflow needs. - +Three-dot menu on a timeline event with full summary open > Event content view showing three-dots menu icon in the header with menu options visible @@ -34,7 +34,7 @@ Open the action menu for any event to see available options based on the event t - +Favorited timeline event in the list > Three-dots menu open showing available actions for a conversational search event @@ -58,7 +58,7 @@ Mark important events as favorites to quickly find them later. - +Generate title control in event overview > Event with star icon indicating it's favorited, and three-dots menu showing Favorite option @@ -104,7 +104,7 @@ Remove events from your Timeline. Deletion is permanent and cannot be undone. - +Delete timeline event confirmation dialog > Delete confirmation popup showing event title with warning message and Delete/Cancel buttons @@ -128,7 +128,7 @@ After favoriting events, use the favorites filter to view only your favorited ev - +Filter timeline by favorites > Timeline filtered to show only favorited events, all displaying star icons diff --git a/public/content/desktop/timeline/filtering-events.md b/public/content/desktop/timeline/filtering-events.md index 7442bd8..2a7493e 100644 --- a/public/content/desktop/timeline/filtering-events.md +++ b/public/content/desktop/timeline/filtering-events.md @@ -14,7 +14,7 @@ Filter your Pieces Timeline to focus on specific event types, sources, or applic Use the `Filter List` button to access all filtering options, or hover over summaries to filter by specific applications that contributed to those summaries. - +Timeline filter options panel > Pieces Timeline with Filter List menu open showing filter options for event types, work summaries, and sources @@ -34,7 +34,7 @@ Open the Filter List menu to access all filtering options for your Timeline even - +Filter List button hovered in Timeline > Filter List button in Timeline header with menu open showing filter categories @@ -82,7 +82,7 @@ Show only Timeline Events—workflow moments captured by LTM-2.7, including auto - +Work summaries filtered in Timeline > Filter List menu with Work Summaries expanded showing individual summary type options @@ -129,7 +129,7 @@ Filter Timeline events by the applications or sources that captured them. - +Source filters in Timeline filter dropdown > Filter List menu with Sources expanded showing list of applications with checkboxes @@ -152,7 +152,7 @@ When viewing summaries in Timeline, you can filter by specific applications that - +Selecting Chrome as a filter source in Timeline > Hovering over a summary showing interactive application icons (Chrome, Cursor, etc.) that can be clicked to filter @@ -196,7 +196,7 @@ Reset your Timeline view to show all events without any filters applied. - +Clear all filters control in Timeline > Filter List menu with `X` icon visible to close/clear filters diff --git a/public/content/desktop/timeline/ltm-rollups.md b/public/content/desktop/timeline/ltm-rollups.md index 1d99968..e66d86a 100644 --- a/public/content/desktop/timeline/ltm-rollups.md +++ b/public/content/desktop/timeline/ltm-rollups.md @@ -16,7 +16,7 @@ LTM Roll-Ups are detailed summaries of your workflow periods, automatically gene Roll-ups help you understand what happened during specific workflow periods. They capture the context of your work—what you did, why you made certain decisions, and what still needs attention—making it easy to reference past work and understand your workflow patterns. - +Full LTM roll-up in the main panel with all sections > Complete roll-up displayed in the main panel showing all sections @@ -35,7 +35,7 @@ Each roll-up includes: Roll-ups created through Model Context Protocol (MCP) integrations display a "Formed with MCP" indicator. - +Roll-up sections labeled Core Tasks, Key Decisions, Documents, Follow-ups > Roll-up sections with annotations showing Core Tasks, Key Decisions, Documents, and Follow-Up Actions @@ -59,7 +59,7 @@ Click an activity to view its full roll-up details: - +Roll-up with matching activity highlighted in Timeline Activities sidebar > Roll-up displayed with the corresponding activity highlighted in the Timeline Activities sidebar @@ -75,7 +75,7 @@ From the toolbar, you can: * **More menu**—Copy or Delete * **macOS Share**—Share to AirDrop, Mail, Messages, etc. - +Roll-up toolbar with Copilot, Export, Edit, More, and Share actions > Toolbar with all action buttons labeled @@ -99,7 +99,7 @@ Modify roll-up content using the built-in markdown editor: - +Markdown editor for a roll-up with formatting toolbar > Markdown editor interface showing formatting toolbar and editable content @@ -122,7 +122,7 @@ Configure which applications LTM captures from: - +LTM Access Control modal with per-app source toggles > LTM Access Control modal showing toggle switches for different application sources diff --git a/public/content/desktop/timeline/timeline-events.md b/public/content/desktop/timeline/timeline-events.md index d65fca8..f501db2 100644 --- a/public/content/desktop/timeline/timeline-events.md +++ b/public/content/desktop/timeline/timeline-events.md @@ -14,7 +14,7 @@ Timeline Events is the chronological sidebar that displays all activities and co Click the `Show Timeline` button in the top-left corner of the main view to open or close Pieces Timeline. - +Timeline with Events sidebar, Show Timeline, and grouped activities > Full screenshot of Timeline with Timeline Events sidebar open on the left, showing the "Show Timeline" button highlighted, multiple date groups (Today, Yesterday, Last Saturday), and several activity items with timestamps and icons @@ -31,7 +31,7 @@ Each memory item displays: * **App Icons:** Small icons showing which applications were involved (Chrome, VS Code, Slack, etc.). * **Count Badge:** Number on the right indicating how many events or items are in that memory. - +Current day dropdown in Timeline Events > Showing current day dropdown in Timeline @@ -90,7 +90,7 @@ Use the search bar to find activities by keyword or topic: - +Search filtering Timeline Events in real time > Search/filter functionality showing typing a search query in the search bar at the top of Timeline Events sidebar, with the activity list filtering in real-time to display only matching results @@ -117,7 +117,7 @@ Click an activity to view its complete roll-up details: - +Selected event in sidebar with roll-up detail in main panel > Screenshot showing an activity item selected in the Timeline Events sidebar (highlighted) and the corresponding detailed roll-up displayed in the main panel to the right diff --git a/public/content/desktop/timeline/your-memories.md b/public/content/desktop/timeline/your-memories.md index de4e2d4..436d65c 100644 --- a/public/content/desktop/timeline/your-memories.md +++ b/public/content/desktop/timeline/your-memories.md @@ -16,7 +16,7 @@ Timeline Activities is the chronological sidebar that displays all activities an Click the `Show Timeline` button in the top-left corner of the main view to open or close Pieces Timeline. - +Timeline with Activities sidebar, Show Timeline button, and date groups > Full screenshot of Timeline with Timeline Activities sidebar open on the left, showing the "Show Timeline" button highlighted, multiple date groups (Today, Yesterday, Last Saturday), and several activity items with timestamps and icons @@ -33,7 +33,7 @@ Each memory item displays: * **App Icons:** Small icons showing which applications were involved (Chrome, VS Code, Slack, etc.). * **Count Badge:** Number on the right indicating how many events or items are in that memory. - +Memory items with title, timestamp, emoji, app icons, and count badge > Close-up screenshot of 2-3 individual memory items showing all the components clearly labeled: title, timestamp, emoji indicator, app icons, and count badge @@ -87,7 +87,7 @@ Use the search bar to find activities by keyword or topic. - +Search bar filtering Timeline Activities in real time > Search/filter functionality showing typing a search query in the search bar at the top of Timeline Activities sidebar, with the activity list filtering in real-time to display only matching results @@ -115,7 +115,7 @@ Click an activity to view its complete roll-up details. - +Selected activity in sidebar with full roll-up in main panel > Split screenshot showing an activity item selected in the Timeline Activities sidebar (highlighted) and the corresponding detailed roll-up displayed in the main panel to the right diff --git a/public/content/desktop/troubleshooting/cross-platform.md b/public/content/desktop/troubleshooting/cross-platform.md index 07d5229..982e431 100644 --- a/public/content/desktop/troubleshooting/cross-platform.md +++ b/public/content/desktop/troubleshooting/cross-platform.md @@ -9,7 +9,7 @@ metaDescription: Learn the troubleshooting steps to take if the Pieces Desktop A ogImage: "https://storage.googleapis.com/hashnode_product_documentation_assets/og_images/desktop/troubleshooting_cross_platform.png" --- - +Cross-platform troubleshooting guide banner *** diff --git a/public/content/desktop/troubleshooting/linux.md b/public/content/desktop/troubleshooting/linux.md index 56f7d93..e50c1f1 100644 --- a/public/content/desktop/troubleshooting/linux.md +++ b/public/content/desktop/troubleshooting/linux.md @@ -9,7 +9,7 @@ metaDescription: Learn about what troubleshooting steps to take if the Pieces De ogImage: "https://storage.googleapis.com/hashnode_product_documentation_assets/og_images/desktop/troubleshooting_linux.png" --- - +Linux troubleshooting guide banner ## Installation & Updating Fixes @@ -41,7 +41,7 @@ To update the Pieces Desktop App on Linux: Run `sudo snap refresh pieces-for-developers pieces-os` to update both. Use `sudo snap refresh` to update all snap packages. - + Running snap refresh to update Pieces Desktop App on Linux @@ -67,8 +67,8 @@ If installation or UI issues persist, consider the following: * **Switch Between X11 and Wayland:** Some applications may work better on one display protocol than the other. Try switching to X11 for compatibility or Wayland for newer features. You can usually select this at the login screen. - - The LTM-2.7 Engine is designed to work with the X11 Window Manager. Other Window Managers, such as Wayland, are *not compatible.* This means that long-term memory functionality with certain Linux Virtual Machines (VMs) is not possible at this time. + + **Supported setup:** **Ubuntu** with **X11**. **Wayland** usually needs follow-up from `pieces-os.doctor`. Other distros are **best-effort**. If capture or LTM fails, try an **X11 session**, re-run `pieces-os.doctor`, or use a **supported Ubuntu** install—**VMs** are the most variable. * **Update your GPU Drivers:** Ensure they are up to date. For NVIDIA, check for proprietary driver updates. AMD and Intel users should verify that their open-source drivers are up to date. @@ -85,13 +85,13 @@ Verify your system's hardware configuration and ensure it meets the recommended To determine your CPU type and find other important information, type `lscpu` in your terminal and press `Enter`. - +Terminal output of lscpu on Ubuntu ### Checking GPU Information To determine your GPU type and find other important information, `lspci | grep -i vga` in your terminal and press `Enter`. - +Terminal output of lspci showing GPU on Ubuntu Confirm that your CPU, GPU, and memory resources are sufficient for running PiecesOS and local AI models, if applicable. @@ -117,7 +117,7 @@ To check what version of Ubuntu you’re running: This section will display your Ubuntu version information. - +Checking Ubuntu version in System Settings About ### Consulting Online Resources diff --git a/public/content/desktop/troubleshooting/macos.md b/public/content/desktop/troubleshooting/macos.md index cc42cdf..7704264 100644 --- a/public/content/desktop/troubleshooting/macos.md +++ b/public/content/desktop/troubleshooting/macos.md @@ -9,7 +9,7 @@ metaDescription: Learn about what troubleshooting steps to take if the Pieces De ogImage: "https://storage.googleapis.com/hashnode_product_documentation_assets/og_images/desktop/macos_troubleshooting.png" --- - +macOS troubleshooting guide banner *** @@ -55,9 +55,9 @@ Our `.pkg` files install both PiecesOS and the Pieces Desktop App in a single gu ## Versions & Updates -Many issues can stem from out-of-date plugins, extensions, PiecesOS, or the desktop app itself. +Many issues can stem from out-of-date MCP integrations, PiecesOS, or the desktop app itself. - +Profile menu with Check for Updates for Desktop App and PiecesOS ### Updating the Pieces Desktop App @@ -108,7 +108,7 @@ To determine your Apple device’s version of macOS: Under your device name (i.e. MacBook Air), look for the last line on the list, titled **macOS** - + About This Mac showing macOS version and chip diff --git a/public/content/desktop/troubleshooting/windows.md b/public/content/desktop/troubleshooting/windows.md index 141cd0f..e87bb9e 100644 --- a/public/content/desktop/troubleshooting/windows.md +++ b/public/content/desktop/troubleshooting/windows.md @@ -9,7 +9,7 @@ metaDescription: Learn about what troubleshooting steps to take if the Pieces De ogImage: "https://storage.googleapis.com/hashnode_product_documentation_assets/og_images/desktop/troubleshooting_windows.png" --- - +Windows troubleshooting guide banner *** @@ -47,7 +47,7 @@ If you’re experiencing difficulties installing the Pieces Desktop App, you can ## Versions & Updates -Many issues can stem from out-of-date plugins, extensions, or the Desktop App itself. +Many issues can stem from out-of-date MCP integrations or the Desktop App itself. ### Updating the Pieces Desktop App @@ -75,7 +75,7 @@ Updating the Pieces Desktop App on Windows (and macOS) can be done directly with - +Checking for Pieces Desktop App updates on Windows You can also select `Check for PiecesOS Updates` from the same menu as an alternative to doing so from the PiecesOS system window in your taskbar. @@ -177,7 +177,7 @@ To check your device specifications on Windows: The **System** tab displays your processor, the number of CPU cores, and memory (RAM), while the **Display** tab lists your GPU, its manufacturer (e.g., NVIDIA, AMD, Intel), and the available video memory (VRAM). - +Opening dxdiag to view hardware specs on Windows ### Checking Windows Version diff --git a/public/content/enterprise/features.md b/public/content/enterprise/features.md index 09d0916..ca3463f 100644 --- a/public/content/enterprise/features.md +++ b/public/content/enterprise/features.md @@ -12,7 +12,7 @@ metaDescription: Enterprise features—admin controls, security, compliance, and 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 with admin dashboard and management tools > Organization Home page showing admin dashboard, management tools, and resource links diff --git a/public/content/enterprise/onboarding.md b/public/content/enterprise/onboarding.md index a5ede16..f9378bf 100644 --- a/public/content/enterprise/onboarding.md +++ b/public/content/enterprise/onboarding.md @@ -95,7 +95,7 @@ If you've received an invitation to join a Pieces organization, follow these ste 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 with Setup section and download links > Organization Home page showing Setup section with download links and sign-in instructions diff --git a/public/content/extensions-plugins/jetbrains.md b/public/content/extensions-plugins/jetbrains.md index f6aa4b8..1035431 100644 --- a/public/content/extensions-plugins/jetbrains.md +++ b/public/content/extensions-plugins/jetbrains.md @@ -12,6 +12,10 @@ metaDescription: The Pieces for JetBrains Plugin enhances your development exper *** + + **This plugin has been sunset** and is no longer supported. Pieces integrations now use the **Model Context Protocol (MCP)**. See the [State of Plugins](/products/extensions-plugins/state-of-plugins) page and [get started with MCP](/products/mcp/get-started). + + ## Pieces for JetBrains Plugin The Pieces for JetBrains Plugin enhances your development experience by seamlessly integrating the best features from the Pieces suite directly into JetBrains IDEs, making your favorite tools readily accessible within your workspace. diff --git a/public/content/extensions-plugins/jupyterlab.md b/public/content/extensions-plugins/jupyterlab.md index 5e8d24c..af4b8e6 100644 --- a/public/content/extensions-plugins/jupyterlab.md +++ b/public/content/extensions-plugins/jupyterlab.md @@ -13,6 +13,10 @@ ogImage: "https://storage.googleapis.com/hashnode_product_documentation_assets/o *** + + **This plugin has been sunset** and is no longer supported. Pieces integrations now use the **Model Context Protocol (MCP)**. See the [State of Plugins](/products/extensions-plugins/state-of-plugins) page and [get started with MCP](/products/mcp/get-started). + + V2 Documentation for the Pieces JupyterLabs Extension is under construction. diff --git a/public/content/extensions-plugins/neovim-plugin.md b/public/content/extensions-plugins/neovim-plugin.md index 481f042..a9dbe0e 100644 --- a/public/content/extensions-plugins/neovim-plugin.md +++ b/public/content/extensions-plugins/neovim-plugin.md @@ -11,6 +11,10 @@ ogImage: "https://storage.googleapis.com/hashnode_product_documentation_assets/o + + **This plugin has been sunset** and is no longer supported. Pieces integrations now use the **Model Context Protocol (MCP)**. See the [State of Plugins](/products/extensions-plugins/state-of-plugins) page and [get started with MCP](/products/mcp/get-started). + + V2 Documentation for the Pieces Neovim Plugin is under construction 🚧 ... ### Sign in Required diff --git a/public/content/extensions-plugins/state-of-plugins.md b/public/content/extensions-plugins/state-of-plugins.md new file mode 100644 index 0000000..b11b916 --- /dev/null +++ b/public/content/extensions-plugins/state-of-plugins.md @@ -0,0 +1,54 @@ +--- +title: State of Plugins +path: /extensions-plugins/state-of-plugins +visibility: PUBLIC +status: PUBLISHED +description: Pieces IDE plugins and extensions have been sunset. All integration support is moving to the Model Context Protocol (MCP). Learn what changed and where to go next. +metaTitle: Pieces Plugins — Sunset Notice | Pieces Docs +metaDescription: Pieces is sunsetting individual IDE plugins in favor of standardized MCP integrations. Find out what this means and how to migrate. +--- + +## Pieces Plugins Have Been Sunset + +Pieces is **no longer developing or supporting** individual IDE plugins and extensions. Most existing plugins have **stopped working** and will not receive further updates. + +All integration support is moving to the **[Model Context Protocol (MCP)](/products/mcp/get-started)** — an open standard that lets any MCP-compatible tool connect to PiecesOS and your Long-Term Memory without a custom plugin. + + + If you are currently using a Pieces plugin, it may already be non-functional. **Switch to the MCP integration** for your editor or tool as soon as possible. + + +## Why MCP? + +- **One standard, many tools.** MCP is supported across Cursor, VS Code, JetBrains, Claude, ChatGPT, and [many more](/products/mcp/get-started). +- **No plugin maintenance.** You no longer need to install, update, or troubleshoot a separate plugin per editor. +- **Broader reach.** Any tool that speaks MCP can access Pieces Long-Term Memory, Pieces Drive, and the full Pieces toolset — today and in the future. + +## What Should I Do? + + + + Remove the Pieces extension from VS Code, JetBrains, Sublime Text, Neovim, JupyterLab, Visual Studio, or whichever editor you were using. + + + Follow the [MCP Getting Started guide](/products/mcp/get-started) to connect PiecesOS to your editor via MCP. + + + We have dedicated setup guides for [Cursor](/products/mcp/cursor), [VS Code](/products/mcp/vs-code), [GitHub Copilot](/products/mcp/github-copilot), [JetBrains](/products/mcp/jetbrains-ides), [Claude Desktop](/products/mcp/claude-desktop), and [more](/products/mcp/get-started). + + + +## Legacy Plugin Pages + +The plugin docs below are kept for reference but describe **unsupported, non-functional** software. Do not rely on them for new setups. + +- [VS Code Extension](/products/extensions-plugins/visual-studio-code) +- [JetBrains Plugin](/products/extensions-plugins/jetbrains) +- [Visual Studio Extension](/products/extensions-plugins/visual-studio) +- [JupyterLab Extension](/products/extensions-plugins/jupyterlab) +- [Sublime Text Plugin](/products/extensions-plugins/sublime) +- [Neovim Plugin](/products/extensions-plugins/neovim-plugin) + +*** + +Questions? Visit our [support page](/products/support) or [get started with MCP](/products/mcp/get-started). diff --git a/public/content/extensions-plugins/sublime.md b/public/content/extensions-plugins/sublime.md index 5d282fc..3addbf4 100644 --- a/public/content/extensions-plugins/sublime.md +++ b/public/content/extensions-plugins/sublime.md @@ -13,6 +13,10 @@ ogImage: "https://storage.googleapis.com/hashnode_product_documentation_assets/o *** + + **This plugin has been sunset** and is no longer supported. Pieces integrations now use the **Model Context Protocol (MCP)**. See the [State of Plugins](/products/extensions-plugins/state-of-plugins) page and [get started with MCP](/products/mcp/get-started). + + ## 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. diff --git a/public/content/extensions-plugins/visual-studio-code.md b/public/content/extensions-plugins/visual-studio-code.md index eb8fbc3..a799d31 100644 --- a/public/content/extensions-plugins/visual-studio-code.md +++ b/public/content/extensions-plugins/visual-studio-code.md @@ -13,6 +13,10 @@ ogImage: "https://storage.googleapis.com/hashnode_product_documentation_assets/o *** + + **This plugin has been sunset** and is no longer supported. Pieces integrations now use the **Model Context Protocol (MCP)**. See the [State of Plugins](/products/extensions-plugins/state-of-plugins) page and [get started with MCP](/products/mcp/get-started). + + ## Pieces for Visual Studio Code The Pieces for VS Code Extension is a versatile tool that integrates seamlessly with the VS Code editor and IDEs based on VS Code, such as Cursor. diff --git a/public/content/extensions-plugins/visual-studio.md b/public/content/extensions-plugins/visual-studio.md index 8d90d30..4d8e923 100644 --- a/public/content/extensions-plugins/visual-studio.md +++ b/public/content/extensions-plugins/visual-studio.md @@ -12,6 +12,10 @@ metaDescription: Chat with Pieces Copilot inside Visual Studio for AI-driven cod *** + + **This plugin has been sunset** and is no longer supported. Pieces integrations now use the **Model Context Protocol (MCP)**. See the [State of Plugins](/products/extensions-plugins/state-of-plugins) page and [get started with MCP](/products/mcp/get-started). + + ## Pieces for Visual Studio Extension The Pieces for Visual Studio Extension is a powerful and versatile tool that integrates seamlessly with the Visual Studio IDE, enhancing productivity and enabling efficient code management. diff --git a/public/content/large-language-models.md b/public/content/large-language-models.md index 1f0b884..ea44eeb 100644 --- a/public/content/large-language-models.md +++ b/public/content/large-language-models.md @@ -9,7 +9,7 @@ metaDescription: Explore the available cloud-based and local LLMs supported by P ogImage: "https://storage.googleapis.com/hashnode_product_documentation_assets/og_images/pieces_more/compatible-llms.png" --- - +Compatible large language models supported by Pieces @@ -19,7 +19,7 @@ Pieces utilizes cloud-hosted LLMs from providers like OpenAI, Anthropic, and Goo ## Cloud-Only LLMs | Providers -[Browse the list of cloud-hosted AI models available for use](/products/large-language-models/cloud-models) with the Pieces Desktop App and several of our plugins and extensions. +[Browse the list of cloud-hosted AI models available for use](/products/large-language-models/cloud-models) with the Pieces Desktop App and several of our MCP integrations. *** diff --git a/public/content/large-language-models/cloud-models.md b/public/content/large-language-models/cloud-models.md index 4382544..9832d46 100644 --- a/public/content/large-language-models/cloud-models.md +++ b/public/content/large-language-models/cloud-models.md @@ -5,7 +5,7 @@ visibility: PUBLIC status: PUBLISHED ogImage: "https://storage.googleapis.com/hashnode_product_documentation_assets/og_images/desktop/pfd.png" metaTitle: Exploring Cloud-Based AI Models Supported by Pieces | Pieces Docs -metaDescription: Find information of cloud LLMs available for use that are supported by PiecesOS, the Pieces Desktop App, and other Pieces plugins and extensions. +metaDescription: Find information of cloud LLMs available for use that are supported by PiecesOS, the Pieces Desktop App, and other Pieces MCP integrations. description: Utilize cloud-hosted large language models (LLMs) from providers like OpenAI, Anthropic, and Google. --- diff --git a/public/content/large-language-models/local-models.md b/public/content/large-language-models/local-models.md index bf92f09..97f91f1 100644 --- a/public/content/large-language-models/local-models.md +++ b/public/content/large-language-models/local-models.md @@ -5,7 +5,7 @@ visibility: PUBLIC status: PUBLISHED description: Utilize local large language models (LLMs) from providers like Google, IBM, Meta, Microsoft, and more. metaTitle: Exploring Local AI Models Supported by Pieces | Pieces Docs -metaDescription: Find information of local LLMs available that are currently supported by PiecesOS, the Pieces Desktop App, and other Pieces plugins and extensions. +metaDescription: Find information of local LLMs available that are currently supported by PiecesOS, the Pieces Desktop App, and other Pieces MCP integrations. ogImage: "https://storage.googleapis.com/hashnode_product_documentation_assets/og_images/desktop/pfd.png" --- diff --git a/public/content/mcp/amazon-q-developer.md b/public/content/mcp/amazon-q-developer.md index 4d4152b..0533def 100644 --- a/public/content/mcp/amazon-q-developer.md +++ b/public/content/mcp/amazon-q-developer.md @@ -8,7 +8,7 @@ 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. --- - +Pieces MCP integration with Amazon Q Developer *** diff --git a/public/content/mcp/chatgpt-developer-mode.md b/public/content/mcp/chatgpt-developer-mode.md index b388972..e897640 100644 --- a/public/content/mcp/chatgpt-developer-mode.md +++ b/public/content/mcp/chatgpt-developer-mode.md @@ -8,7 +8,7 @@ metaTitle: Integrate Pieces Model Context Protocol (MCP) with ChatGPT Developer 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. --- - +Pieces MCP integration with ChatGPT Developer Mode *** diff --git a/public/content/mcp/claude-code.md b/public/content/mcp/claude-code.md index bba2857..15004e7 100644 --- a/public/content/mcp/claude-code.md +++ b/public/content/mcp/claude-code.md @@ -8,7 +8,7 @@ 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. --- - +Pieces MCP integration with Claude Code *** diff --git a/public/content/mcp/claude-cowork.md b/public/content/mcp/claude-cowork.md index 9264d15..7382fd3 100644 --- a/public/content/mcp/claude-cowork.md +++ b/public/content/mcp/claude-cowork.md @@ -8,7 +8,7 @@ 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. --- - +Pieces MCP integration with Claude Cowork *** @@ -124,21 +124,36 @@ Once connected, start a Cowork session and Pieces LTM tools are available alongs ## 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"* + + + Open Claude Desktop and start a Cowork session (look for the folder/file access UI). + + + Ask: *"What Pieces tools are available?"* + + + For example: *"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. + + + Ensure you have a Pro, Max, Team, or Enterprise plan. + + + Restart Claude Desktop after config changes. + + + Confirm the Pieces server is configured in Claude Desktop—Cowork shares Desktop's config. + + + Windows support was added February 10, 2026—update Claude Desktop. + + *** diff --git a/public/content/mcp/claude-desktop.md b/public/content/mcp/claude-desktop.md index 96be707..7b272d7 100644 --- a/public/content/mcp/claude-desktop.md +++ b/public/content/mcp/claude-desktop.md @@ -9,7 +9,7 @@ metaDescription: Discover different ways to configure the Pieces MCP to provide ogImage: "https://storage.googleapis.com/hashnode_product_documentation_assets/og_images/MCP/claude_desktop_mcp.jpg" --- - +Pieces MCP for Claude Desktop banner *** @@ -61,7 +61,7 @@ This method involves editing Claude Desktop’s MCP configuration file to point With this method, the Claude MCP config points to the Pieces CLI executable and runs `pieces mcp start` whenever Claude starts. This is different from using the CLI to configure Claude directly (Method 2). - +Claude Desktop manual MCP configuration process @@ -146,7 +146,7 @@ This method involves editing Claude Desktop’s MCP configuration file to point This method uses the Pieces CLI to automatically set up and configure Pieces MCP for Claude Desktop. - +Pieces CLI automatic MCP setup command @@ -171,7 +171,7 @@ This method uses the Pieces CLI to automatically set up and configure Pieces MCP Once the command completes, restart Claude Desktop and confirm that the Pieces MCP server is connected. - + Successful Pieces MCP setup in Claude Desktop @@ -216,12 +216,12 @@ Once integrated, you can utilize Pieces LTM directly in Claude Desktop or Claude 2. **Prompt with Context**\ Ask Claude questions about prior work or files (e.g., *"What was I doing for work yesterday?"*). - +Claude asking what user was working on 3. **Verify MCP Tools Are Active**\ If configured correctly, Claude will automatically use the `ask_pieces_ltm` tool to pull relevant context. - +Claude Desktop using Pieces MCP tool output ## Troubleshooting diff --git a/public/content/mcp/cline.md b/public/content/mcp/cline.md index 991f14f..db7307f 100644 --- a/public/content/mcp/cline.md +++ b/public/content/mcp/cline.md @@ -8,7 +8,7 @@ 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. --- - +Pieces MCP integration with Cline *** diff --git a/public/content/mcp/continue-dev.md b/public/content/mcp/continue-dev.md index fa28901..8664b77 100644 --- a/public/content/mcp/continue-dev.md +++ b/public/content/mcp/continue-dev.md @@ -8,7 +8,7 @@ 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. --- - +Pieces MCP integration with Continue.dev *** diff --git a/public/content/mcp/cursor.md b/public/content/mcp/cursor.md index 7e52ff2..eb56a73 100644 --- a/public/content/mcp/cursor.md +++ b/public/content/mcp/cursor.md @@ -9,7 +9,7 @@ metaDescription: Read documentation on integrating Pieces Model Context Protocol ogImage: "https://storage.googleapis.com/hashnode_product_documentation_assets/og_images/MCP/cursor_mcp.png" --- - +Pieces MCP integration with Cursor IDE *** @@ -65,11 +65,11 @@ To find the current MCP endpoint with the active instance of PiecesOS (including There, you can click once to copy the MCP endpoint, which includes the active PiecesOS port number. - +PiecesOS Quick Menu showing MCP servers section You can also do this in the Pieces Desktop App by opening the **Settings** view and clicking **Model Context Protocol (MCP).** - +Pieces Desktop App Model Context Protocol settings ## Setting Up Cursor @@ -111,7 +111,7 @@ To set up the Pieces MCP, you can edit the `.json` settings configuration file f Navigate to **Cursor Settings**, then to the `MCP` section. - + Cursor Settings MCP section before configuration @@ -133,7 +133,7 @@ To set up the Pieces MCP, you can edit the `.json` settings configuration file f Make sure to refresh the MCP server window by clicking the **refresh icon** and ensure that there is a *green dot* indicating that the server is running and functioning without errors. - + Cursor MCP server running with green status indicator @@ -157,7 +157,7 @@ Once integrated, you can utilize [Pieces LTM](/products/core-dependencies/pieces From this point, you can begin prompting. If PiecesOS was previously installed, try testing out the Pieces MCP integration with a prompt like, “What was I doing for work yesterday?” and click `Use Tool` when prompted. - + Cursor Agent using Pieces MCP tool demonstration @@ -173,7 +173,7 @@ To do this, open up **Cursor Settings,** click `Rules`, then add new *User Rules Here’s an example of a straightforward set of rules tailored to a specific use case and work flow: - +Cursor custom rules configuration for Pieces MCP ## Troubleshooting diff --git a/public/content/mcp/get-started.md b/public/content/mcp/get-started.md index 5a3dc83..4c7c365 100644 --- a/public/content/mcp/get-started.md +++ b/public/content/mcp/get-started.md @@ -9,7 +9,7 @@ metaDescription: Learn how Pieces Model Context Protocol (MCP) provides relevant ogImage: "https://storage.googleapis.com/hashnode_product_documentation_assets/og_images/MCP/mcp.png" --- - +Pieces Model Context Protocol overview banner *** @@ -27,13 +27,13 @@ This is extremely useful—because it means somebody using the Cursor agentic ch ## How Pieces Integrates with MCP -The core of the Pieces ecosystem is [PiecesOS](/products/core-dependencies/pieces-os), which powers the Pieces Desktop App, browser extensions, and IDE plugins. +The core of the Pieces ecosystem is [PiecesOS](/products/core-dependencies/pieces-os), which powers the Pieces Desktop App and [MCP integrations](/products/mcp/get-started) across your editors and tools. At its heart is the advanced [Long-Term Memory Engine (LTM-2.7)](/products/core-dependencies/pieces-os#ltm-27), which captures, enriches, and locally stores valuable contextual information from your daily workflow, such as code snippets, browser history, notes, and application data. Pieces leverages the MCP to connect your favorite development tools and AI applications—like Cursor and GitHub Copilot—directly to PiecesOS, enabling smooth, context-rich interactions [entirely on your device.](/products/privacy-security-your-data#data-storage--control) - +Pieces MCP architecture diagram showing data flow ### Required Dependency @@ -93,7 +93,7 @@ By connecting directly to [PiecesOS](/products/core-dependencies/pieces-os), you *Pieces MCP —> Cursor* - +Cursor example chat showing Pieces MCP in use *** @@ -137,7 +137,7 @@ Let’s take a look at the Pieces + MCP flow as you’d experience it in a famil *Pieces MCP —> GitHub Copilot* - +Visual Studio example chat with Pieces MCP *** diff --git a/public/content/mcp/github-copilot.md b/public/content/mcp/github-copilot.md index e0f7113..ca50060 100644 --- a/public/content/mcp/github-copilot.md +++ b/public/content/mcp/github-copilot.md @@ -9,7 +9,7 @@ metaDescription: Discover how to integrate Pieces Model Context Protocol (MCP) w ogImage: "https://storage.googleapis.com/hashnode_product_documentation_assets/og_images/MCP/github_mcp.png" --- - +Pieces MCP integration with GitHub Copilot *** @@ -61,11 +61,11 @@ To find the current SSE endpoint with the active instance of POS (including the There, you can copy the SSE endpoint with one click, which includes the active PiecesOS port number. - +PiecesOS Quick Menu with MCP servers section You can also do this in the Pieces Desktop App by opening the **Settings** view and clicking **Model Context Protocol (MCP).** - +Pieces Desktop MCP configuration view ## Setting Up GitHub Copilot @@ -87,7 +87,7 @@ Adding the Pieces MCP in the built-in MCP menu is the easiest method to setting In the Command Palette, type **MCP: Add Server** and select the command when it appears. - + VS Code command palette showing MCP add server @@ -161,7 +161,7 @@ You can manually add the MCP to your MCP settings `.JSON` by following the steps Save the configuration. - + VS Code MCP settings configuration Your GitHub Copilot chat, as long as it’s in Agent mode, will now see PiecesOS as an MCP. @@ -181,7 +181,7 @@ Once integrated, you can utilize Pieces LTM directly in Visual Studio Code. Enter your prompt, and click the **send** icon or press `return` (macOS) or `enter` (Windows/Linux) to send your query to the Copilot. - + GitHub Copilot chat using Pieces MCP demonstration Do not add the `ask_pieces_ltm` tool as *context* to the conversation. If you are running the chat in *Agent* mode—which is required for the Pieces MCP integration to operate successfully—it will automatically utilize this tool. diff --git a/public/content/mcp/google-gemini-cli.md b/public/content/mcp/google-gemini-cli.md index 257df30..e38ec43 100644 --- a/public/content/mcp/google-gemini-cli.md +++ b/public/content/mcp/google-gemini-cli.md @@ -8,7 +8,7 @@ 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. --- - +Pieces MCP integration with Google Gemini CLI *** diff --git a/public/content/mcp/goose.md b/public/content/mcp/goose.md index 706a0b3..95e3882 100644 --- a/public/content/mcp/goose.md +++ b/public/content/mcp/goose.md @@ -9,7 +9,7 @@ metaDescription: Discover how to integrate Pieces Model Context Protocol (MCP) w ogImage: "https://storage.googleapis.com/hashnode_product_documentation_assets/og_images/MCP/goose_mcp.png" --- - +Pieces MCP integration with Goose *** @@ -63,11 +63,11 @@ To find the up-to-date SSE endpoint with the active instance of POS (including t There, you can copy the SSE endpoint with one click, which includes the active PiecesOS port number. - +PiecesOS Quick Menu MCP servers section You can also find this in the Pieces Desktop App by opening the [Settings](/products/desktop/configuration) view and clicking **Model Context Protocol (MCP)**. - +Pieces Desktop app MCP settings ## Setting Up Goose with Pieces MCP @@ -85,7 +85,7 @@ Make sure you have the latest version of Goose installed to ensure compatibility Setting up the Pieces MCP through the Goose Command Line Interface is straightforward. - +Goose configure command for setting up MCP @@ -177,7 +177,7 @@ Once the integration is set up, you can start using Pieces Long-Term Memory thro Here’s a response using that exact same prompt inside of Goose using the Pieces MCP integration: - + Example Goose conversation demonstrating Pieces MCP @@ -189,7 +189,7 @@ Once the integration is set up, you can start using Pieces Long-Term Memory thro To remove the Pieces MCP for Goose, you can follow the same process you otherwise would for removing any Goose extension. - +Goose configure menu for removing MCP servers diff --git a/public/content/mcp/jetbrains-ides.md b/public/content/mcp/jetbrains-ides.md index e1d0eea..04142ba 100644 --- a/public/content/mcp/jetbrains-ides.md +++ b/public/content/mcp/jetbrains-ides.md @@ -8,7 +8,7 @@ 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. --- - +Pieces MCP integration with JetBrains IDEs *** diff --git a/public/content/mcp/ngrok-setup.md b/public/content/mcp/ngrok-setup.md index ede2688..a74fa9a 100644 --- a/public/content/mcp/ngrok-setup.md +++ b/public/content/mcp/ngrok-setup.md @@ -100,28 +100,48 @@ 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 | +| **Streamable HTTP (MCP)** | `/model_context_protocol/2025-03-26/mcp` | ChatGPT, Claude Cowork Connectors UI, OpenClaw (MCPorter + `mcp-remote`) | +| **SSE** | `/model_context_protocol/2024-11-05/sse` | MCP Bridge and other clients that require the legacy SSE endpoint | -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. +Example: if ngrok shows `https://abc123.ngrok-free.app`, use `https://abc123.ngrok-free.app/model_context_protocol/2025-03-26/mcp` for ChatGPT, Claude Cowork, or OpenClaw, 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. + + + Open [chatgpt.com](https://chatgpt.com) → **Settings** → **Connectors**. + + + Click `Create` and add a new connector. + + + Set **MCP Server URL** to: `https://YOUR_NGROK_URL.ngrok-free.app/model_context_protocol/2025-03-26/mcp` + + + 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. + + + Open Claude Desktop → **Settings** → **Connectors**. + + + Click `Add custom connector`. + + + Enter: `https://YOUR_NGROK_URL.ngrok-free.app/model_context_protocol/2025-03-26/mcp` + + + Save and restart Claude Desktop. + + See [Claude Cowork integration](/products/mcp/claude-cowork) for full setup. @@ -135,7 +155,7 @@ Install `mcp-remote` globally (`npm install -g mcp-remote@0.1.38`), then edit `~ "pieces": { "command": "mcp-remote", "args": [ - "https://YOUR_NGROK_URL.ngrok-free.app/model_context_protocol/2024-11-05/sse" + "https://YOUR_NGROK_URL.ngrok-free.app/model_context_protocol/2025-03-26/mcp" ] } } @@ -154,15 +174,23 @@ The tunnel is active only while `ngrok http 39300` is running. Start ngrok when ### 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. + + + Ensure PiecesOS is running and listening on the port. Test locally: `curl http://localhost:39300/.well-known/version` + + + Use the port from the PiecesOS Quick Menu or **Settings** → **Model Context Protocol (MCP)**. It may not be 39300. + + + 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. + + + 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. + + + Restart PiecesOS and ngrok. Ensure no firewall is blocking the port. + + ### Security diff --git a/public/content/mcp/openai-codex-cli.md b/public/content/mcp/openai-codex-cli.md index 4a6f44c..f4840f0 100644 --- a/public/content/mcp/openai-codex-cli.md +++ b/public/content/mcp/openai-codex-cli.md @@ -8,7 +8,7 @@ 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+. --- - +Pieces MCP integration with OpenAI Codex CLI *** diff --git a/public/content/mcp/openclaw.md b/public/content/mcp/openclaw.md index 9abedee..9e6a6a3 100644 --- a/public/content/mcp/openclaw.md +++ b/public/content/mcp/openclaw.md @@ -8,7 +8,7 @@ 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. --- - +Pieces MCP integration with OpenClaw *** @@ -26,7 +26,11 @@ With Pieces MCP connected, OpenClaw gains access to your Long-Term Memory. It ca - Clone and configure OpenClaw following the [OpenClaw setup guide](https://github.com/clawdbot). + Clone and configure OpenClaw following the [setup instructions in the OpenClaw getting started](https://docs.openclaw.ai/start/getting-started). + + + + Install the [Pieces Long-Term Memory (MCP) skill](https://clawhub.ai/jackrosspieces/pieces-mcp) on ClawHub. It is the full agent-facing guide for OpenClaw: MCP-only URLs, tunnels when PiecesOS runs on another machine, `mcporter.json`, `mcp-remote`, gateway restart, and troubleshooting. @@ -42,7 +46,9 @@ Follow the instructions below for a detailed guide on setting up and configuring ## Setting Up OpenClaw -OpenClaw executes MCP tools via **MCPorter**, its built-in MCP management layer. Edit `~/.openclaw/workspace/config/mcporter.json`: +OpenClaw executes MCP tools via **MCPorter**, its built-in MCP management layer. Edit `~/.openclaw/workspace/config/mcporter.json`. + +The [official Pieces MCP skill for OpenClaw](https://clawhub.ai/jackrosspieces/pieces-mcp) documents **MCP-only** integration: point `mcp-remote` at the **`/mcp`** endpoint (`/model_context_protocol/2025-03-26/mcp`), not the legacy **`/sse`** path. That matches how OpenClaw and MCPorter expect to bridge Pieces. Install `mcp-remote` globally with a pinned version for security: @@ -52,9 +58,9 @@ 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) +### Local setup (MCP with mcp-remote — recommended) -When OpenClaw and PiecesOS run on the same machine, use the localhost URL with the mcp-remote bridge: +When OpenClaw and PiecesOS run on the same machine, use the localhost MCP URL with the mcp-remote bridge: ```json { @@ -62,16 +68,16 @@ When OpenClaw and PiecesOS run on the same machine, use the localhost URL with t "pieces": { "command": "mcp-remote", "args": [ - "http://localhost:39300/model_context_protocol/2024-11-05/sse" + "http://localhost:39300/model_context_protocol/2025-03-26/mcp" ] } } } ``` -### Remote Setup (ngrok) +### Remote setup (ngrok or other HTTPS tunnel) -When OpenClaw needs to reach PiecesOS on a different machine: +When OpenClaw runs on a different machine than PiecesOS, expose PiecesOS (port 39300) with a tunnel and use the **same MCP path** on your tunnel base URL: ```json { @@ -79,14 +85,14 @@ When OpenClaw needs to reach PiecesOS on a different machine: "pieces": { "command": "mcp-remote", "args": [ - "https://YOUR_NGROK_URL.ngrok-free.app/model_context_protocol/2024-11-05/sse" + "https://YOUR_NGROK_URL.ngrok-free.app/model_context_protocol/2025-03-26/mcp" ] } } } ``` -See [Tunneling](/products/mcp/ngrok-setup) for tunnel setup. +See [Tunneling](/products/mcp/ngrok-setup) for tunnel setup. For step-by-step tunnel checks, `curl` validation, and gateway restarts, follow the [ClawHub skill](https://clawhub.ai/jackrosspieces/pieces-mcp). ## Example Use Cases @@ -100,10 +106,17 @@ Once Pieces MCP is connected to OpenClaw, you can automate workflows like: ## 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`. + + + Launch or connect to your OpenClaw instance as you normally do. + + + Ask via your connected messaging platform: *"What Pieces tools do you have?"* Pieces LTM tools should appear in the list. + + + Try: *"What did I work on yesterday?"*—OpenClaw should call `ask_pieces_ltm`. + + ## Security Note @@ -115,21 +128,29 @@ OpenClaw can run with `permissionMode: 'bypassPermissions'` to execute tools aut ## Updating -Edit `~/.openclaw/workspace/config/mcporter.json`, update the URL, and restart OpenClaw. +Edit `~/.openclaw/workspace/config/mcporter.json`, update the URL, then restart the OpenClaw gateway (for example `openclaw gateway restart` from `~/.openclaw/workspace`, as in the [official skill](https://clawhub.ai/jackrosspieces/pieces-mcp)). ## 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. + + + Ensure [PiecesOS is actively running](/products/core-dependencies/pieces-os/troubleshooting) on your system. + + + If the config is missing, create `~/.openclaw/workspace/config/` manually. + + + Run `npm install -g mcp-remote@0.1.38` and ensure the global npm bin directory is in your `PATH`. + + + After editing MCPorter config, restart the gateway (`openclaw gateway restart` per the [ClawHub skill](https://clawhub.ai/jackrosspieces/pieces-mcp)) so OpenClaw picks up the Pieces MCP server. + + + If you use ngrok or another tunnel, restart the tunnel when the URL changes and update the URL in MCPorter config. See [ngrok Setup](/products/mcp/ngrok-setup) for details. + + *** diff --git a/public/content/mcp/raycast.md b/public/content/mcp/raycast.md index fae6586..d6d6e53 100644 --- a/public/content/mcp/raycast.md +++ b/public/content/mcp/raycast.md @@ -8,7 +8,7 @@ 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. --- - +Pieces MCP integration with Raycast *** diff --git a/public/content/mcp/rovo-dev-cli.md b/public/content/mcp/rovo-dev-cli.md index ca15dd4..6ebd2ac 100644 --- a/public/content/mcp/rovo-dev-cli.md +++ b/public/content/mcp/rovo-dev-cli.md @@ -8,7 +8,7 @@ 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. --- - +Pieces MCP integration with Rovo Dev CLI *** diff --git a/public/content/mcp/vs-code.md b/public/content/mcp/vs-code.md index 861af28..5e90dae 100644 --- a/public/content/mcp/vs-code.md +++ b/public/content/mcp/vs-code.md @@ -8,7 +8,7 @@ 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. --- - +Pieces MCP integration with Visual Studio Code *** diff --git a/public/content/mcp/windsurf.md b/public/content/mcp/windsurf.md index 3a4c245..ca20588 100644 --- a/public/content/mcp/windsurf.md +++ b/public/content/mcp/windsurf.md @@ -8,7 +8,7 @@ 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. --- - +Pieces MCP integration with Windsurf *** diff --git a/public/content/mcp/zed.md b/public/content/mcp/zed.md index ef18d51..ec04398 100644 --- a/public/content/mcp/zed.md +++ b/public/content/mcp/zed.md @@ -8,7 +8,7 @@ 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. --- - +Pieces MCP integration with Zed editor *** diff --git a/public/content/meet-pieces.md b/public/content/meet-pieces.md index e7c3d35..97d1567 100644 --- a/public/content/meet-pieces.md +++ b/public/content/meet-pieces.md @@ -3,13 +3,13 @@ title: Getting to Know Pieces path: /meet-pieces visibility: PUBLIC status: PUBLISHED -description: Pieces is an AI-enabled productivity tool designed to increase developer efficiency through personalized workflow assistance across the entire toolchain, featuring a dedicated desktop application, plugins for Sublime and Obsidian, and MCP integrations with Cursor, GitHub Copilot, and more. +description: Pieces is an AI-enabled productivity tool designed to increase developer efficiency through personalized workflow assistance across the entire toolchain, featuring a dedicated desktop application and MCP integrations with Cursor, GitHub Copilot, and more. metaTitle: Pieces Documentation metaDescription: Get started on Windows, macOS, Linux. Troubleshoot, configure, and make the most of Pieces–documentation for new users, developers, and admins for all Pieces OS. ogImage: "https://storage.googleapis.com/hashnode_product_documentation_assets/og_images/meet_pieces/meet_pieces.png" --- - +Getting to Know Pieces banner ## Introducing Pieces @@ -154,9 +154,9 @@ Let Pieces do the heavy lifting and preserve your engineering creativity and ing ### How do I Use Pieces? -PiecesOS serves as the foundational layer of the entire Pieces Suite, much like Docker does for containerized applications—it powers the Pieces Desktop App along with all our browser and IDE extensions and plugins. +PiecesOS serves as the foundational layer of the entire Pieces Suite, much like Docker does for containerized applications—it powers the Pieces Desktop App along with [MCP integrations](/products/mcp/get-started) in your editors and tools. -By installing PiecesOS, you enable the full functionality of the desktop app and our extensions, just like how Docker manages various containers. +By installing PiecesOS, you enable the full functionality of the desktop app and those integrations, just like how Docker manages various containers. @@ -196,16 +196,6 @@ By installing PiecesOS, you enable the full functionality of the desktop app and **Connect AI tools** — [Cursor](/products/mcp/cursor), [GitHub Copilot](/products/mcp/github-copilot), [Goose](/products/mcp/goose), and [Claude Desktop](/products/mcp/claude-desktop) - - - - **IDE & editor integrations** — [Sublime Text](/products/extensions-plugins/sublime) and [Obsidian](/products/obsidian). Connect via [MCP](/products/mcp/get-started) for Cursor, GitHub Copilot, and more. - - - - **Capture from the web** — Save content, research, and context from any website - - diff --git a/public/content/meet-pieces/fundamentals.md b/public/content/meet-pieces/fundamentals.md index d1d8ba6..d6de5d3 100644 --- a/public/content/meet-pieces/fundamentals.md +++ b/public/content/meet-pieces/fundamentals.md @@ -13,7 +13,7 @@ ogImage: "https://storage.googleapis.com/hashnode_product_documentation_assets/o Pieces helps you work smarter with **\[1] Long-Term Memory Engine (LTM-2.7)**, an "artificial memory" that remembers your workflow and saves context for later. - +Long-Term Memory Engine LTM-2.7 header Next, **\[2] Conversational Search** helps with everyday tasks like answering questions, creating content, and getting help—with as much or as little context as you need. @@ -27,7 +27,7 @@ The Long-Term Memory Engine (LTM-2.7) captures what you're working on, so you ca *Conversational Search with LTM-2.7 Context* - +Conversational Search with LTM-2.7 context *** @@ -55,7 +55,7 @@ Conversational Search uses Large Language Models (LLMs) to help answer questions *Conversational Search for Content Generation* - +Conversational Search generating code content *** @@ -75,7 +75,7 @@ Timeline is your central workspace in the Pieces Desktop App. It shows summaries *Timeline Interface* - +Pieces Timeline interface *** diff --git a/public/content/meet-pieces/linux-installation-guide.md b/public/content/meet-pieces/linux-installation-guide.md index 9796aeb..2e38cb2 100644 --- a/public/content/meet-pieces/linux-installation-guide.md +++ b/public/content/meet-pieces/linux-installation-guide.md @@ -9,7 +9,7 @@ metaDescription: Get started with Pieces on Linux – install, configure, troubl ogImage: "https://storage.googleapis.com/hashnode_product_documentation_assets/og_images/meet_pieces/meet_pieces_linux_install.png" --- - +Pieces for Linux installation guide banner *** @@ -27,10 +27,10 @@ There are several requirements that your Linux device must meet to download and * **Minimum OS Type:** PiecesOS has been tested and developed primarily for Ubuntu 22+ or later-based distributions, so make sure your system is updated to at least Ubuntu 22+ or later. -* **X11 Window Manager:** Virtual Linux machines or dedicated instances of Linux, even PiecesOS-compatible Ubuntu 22+ distributions, **must utilize X11** as the proprietary Window Manager. +* **Display server (X11 or Wayland):** Pieces is primarily **supported** on **Ubuntu** using **X11**. **Wayland** support requires manual steps—run `pieces-os.doctor` after install and follow its output. Other configurations and distros *may* work but are generally *unsupported*. If **Long-Term Memory** or screen-related features misbehave—especially in **some VMs**—try logging in with an **X11 session** or see [Linux troubleshooting](/products/meet-pieces/troubleshooting/linux). - To determine which display manager your Linux device is using, go to **Settings,** then **System,** and **System Details** to see if you are using an X11 or a non-LLVM compatible manager. + Check your session with `echo $XDG_SESSION_TYPE` (`wayland` or `x11`). On **Wayland**, use `pieces-os.doctor` to wire up interfaces; labels in **Settings → System** vary by distro. @@ -75,7 +75,7 @@ The Pieces Desktop App automatically downloads and installs new updates. You can also manually check for updates to PiecesOS and the Pieces Desktop App by hovering over your username in the top left, then hovering over `Update` and selecting either `Check for Desktop App Updates` or `Check for PiecesOS Updates`. - +Checking for PiecesOS updates in the Pieces Desktop App on Linux ## Uninstalling @@ -99,7 +99,7 @@ You can uninstall PiecesOS and the Pieces Desktop App using `snap` commands dire - +Uninstalling Pieces from the Linux terminal ## Additional Resources diff --git a/public/content/meet-pieces/macos-installation-guide.md b/public/content/meet-pieces/macos-installation-guide.md index c1a3334..1156097 100644 --- a/public/content/meet-pieces/macos-installation-guide.md +++ b/public/content/meet-pieces/macos-installation-guide.md @@ -58,6 +58,10 @@ Once you've downloaded the correct `.dmg` file, it's time to install the Pieces + + Put Pieces in **Applications** or another **local** folder—not **iCloud Drive** or other synced locations. + + ### System Requirements There are (2) requirements for installing Pieces on your macOS device: @@ -155,7 +159,7 @@ The Pieces Desktop App automatically downloads and installs new updates. You can also manually check for updates to PiecesOS and the Pieces Desktop App by hovering over your username in the top left, then hovering over `Update` and selecting either `Check for Desktop App Updates` or `Check for PiecesOS Updates`. - +Checking for updates via the profile dropdown on macOS ### Uninstalling @@ -163,7 +167,7 @@ On your macOS device, navigate to **Finder,** then select **Applications.** Scroll or search until you find both `Pieces` and `PiecesOS.` Right-click on these two applications and select `Move to Trash`. - +Uninstalling Pieces from macOS Applications folder ## Additional Resources diff --git a/public/content/meet-pieces/sign-into-pieces.md b/public/content/meet-pieces/sign-into-pieces.md index 96c570b..8d684b1 100644 --- a/public/content/meet-pieces/sign-into-pieces.md +++ b/public/content/meet-pieces/sign-into-pieces.md @@ -12,7 +12,7 @@ metaDescription: Learn how to sign in to Pieces Desktop App. Step-by-step guide Whether you're new to Pieces or have used it for years, you'll need to sign in to use Pieces—anonymous usage is no longer available. We've upgraded our sign-in system with more sign-in options, better security, and the ability to combine accounts easily. Your existing account works exactly the same; just sign in like you normally would. - +Pieces sign-in screen > The Pieces sign-in screen @@ -38,7 +38,7 @@ When you open Pieces, you'll see a sign-in screen. Both new and existing users f - +Sign-in screen displayed when opening Pieces > The sign-in screen you'll see when opening Pieces @@ -46,7 +46,7 @@ When you open Pieces, you'll see a sign-in screen. Both new and existing users f If the sign-in prompt doesn't appear automatically, you can access it from your system tray or menu bar: - +Prompt to sign in when not authenticated > If you're not signed in, you'll see a prompt to sign in @@ -59,7 +59,7 @@ If the sign-in prompt doesn't appear automatically, you can access it from your Click `Sign In` when the Pieces app opens. - + Pieces menu bar dropdown with Sign In option > Pieces menu bar dropdown showing Sign In option @@ -199,7 +199,7 @@ After signing in, your browser might not automatically switch back to Pieces. Th If you keep getting signed out, check that your computer's date and time are set correctly. Authentication relies on accurate time settings to keep your account secure. - +Troubleshooting flowchart for sign-in issues > Troubleshooting flowchart for sign-in issues diff --git a/public/content/meet-pieces/troubleshooting/cross-platform.md b/public/content/meet-pieces/troubleshooting/cross-platform.md index 807a823..4be8ad5 100644 --- a/public/content/meet-pieces/troubleshooting/cross-platform.md +++ b/public/content/meet-pieces/troubleshooting/cross-platform.md @@ -9,7 +9,7 @@ metaDescription: Learn about what troubleshooting steps to take if PiecesOS or t ogImage: "https://storage.googleapis.com/hashnode_product_documentation_assets/og_images/meet_pieces/meet_pieces_troubleshooting_cross_platform.png" --- - +Cross-platform troubleshooting banner *** @@ -21,7 +21,7 @@ Find links to detailed sections on specific troubleshooting steps as well as inf ## Versions & Updates -Many issues can stem from out-of-date plugins, extensions, the Pieces Desktop App, or PiecesOS itself. +Many issues can stem from out-of-date MCP integrations, the Pieces Desktop App, or PiecesOS itself. ### Updating PiecesOS @@ -71,7 +71,7 @@ To restart and check for updates to PiecesOS: 3. Check for and install available updates -4. Verify that the Pieces Desktop Application and the plugin or extension you are attempting to use is up-to-date +4. Verify that the Pieces Desktop Application and the MCP integration you are attempting to use is up-to-date ## Common Installation Issues diff --git a/public/content/meet-pieces/troubleshooting/linux.md b/public/content/meet-pieces/troubleshooting/linux.md index e0dac93..f024e5b 100644 --- a/public/content/meet-pieces/troubleshooting/linux.md +++ b/public/content/meet-pieces/troubleshooting/linux.md @@ -9,7 +9,7 @@ metaDescription: Learn about what troubleshooting steps to take if PiecesOS or t ogImage: "https://storage.googleapis.com/hashnode_product_documentation_assets/og_images/meet_pieces/meet_pieces_troubleshooting_linux.png" --- - +Linux troubleshooting banner *** @@ -35,7 +35,7 @@ To update PiecesOS on Linux: 2. Run `sudo snap refresh` to update PiecesOS if a newer version is available - +Running snap refresh to update PiecesOS on Linux ### Updating the Pieces Desktop App @@ -45,7 +45,7 @@ Similar to PiecesOS, you can update the Pieces Desktop App by: 2. Running `sudo snap refresh` to apply any available updates - +Running snap refresh to update Pieces Desktop App on Linux ## Common Installation Issues @@ -71,8 +71,8 @@ If installation or UI issues persist, consider the following: Restart after changing your graphics engine to ensure Pieces doesn't hit any snags on startup. - - The LTM-2.7 Engine is designed to work with the X11 Window Manager. Other Window Managers, such as Wayland, are *not compatible.* This means that long-term memory functionality with certain Linux Virtual Machines (VMs) is not possible at this time. + + **Supported setup:** **Ubuntu** with **X11**. **Wayland** usually needs follow-up from `pieces-os.doctor`. Other distros are **best-effort**. If capture or LTM fails, try an **X11 session**, re-run `pieces-os.doctor`, or use a **supported Ubuntu** install—**VMs** are the most variable. * **Update your GPU Drivers:** Ensure they are up to date. For NVIDIA, check for proprietary driver updates. AMD and Intel users should verify that their open-source drivers are up to date. @@ -89,13 +89,13 @@ You can verify your system’s hardware configuration and ensure it meets recomm To determine your CPU type and find other important information, type `lscpu` in your terminal and press `Enter`. - +Terminal output of lscpu command on Ubuntu ### Checking GPU Information To determine your GPU type and find other important information, `lspci | grep -i vga` in your terminal and press `Enter`. - +Terminal output of lspci showing GPU info on Ubuntu Confirm that your CPU, GPU, and memory resources are sufficient for running PiecesOS and local AI models (if applicable). @@ -115,7 +115,7 @@ To check what version of Ubuntu you’re running: This section will will display your Ubuntu version information. - +Checking Ubuntu version in System Settings ### Consulting Online Resources diff --git a/public/content/meet-pieces/troubleshooting/macos.md b/public/content/meet-pieces/troubleshooting/macos.md index 4eb58e2..98ea2af 100644 --- a/public/content/meet-pieces/troubleshooting/macos.md +++ b/public/content/meet-pieces/troubleshooting/macos.md @@ -9,7 +9,7 @@ metaDescription: Learn about what troubleshooting steps to take if PiecesOS or t ogImage: "https://storage.googleapis.com/hashnode_product_documentation_assets/og_images/meet_pieces/meet_pieces_troubleshooting_macOS.png" --- - +macOS troubleshooting banner *** @@ -52,7 +52,7 @@ A singular brew command, `brew install—- cask pieces`, automatically manages i ## Versions & Updates -Many issues can stem from out-of-date plugins, extensions, the desktop app, or PiecesOS. +Many issues can stem from out-of-date MCP integrations, the desktop app, or PiecesOS. ### Updating PiecesOS @@ -65,7 +65,7 @@ Many issues can stem from out-of-date plugins, extensions, the desktop app, or P - +PiecesOS Quick Menu showing check for updates option ### Updating the Pieces Desktop App @@ -97,7 +97,7 @@ Updating the Pieces Desktop App on macOS can be done directly from the app: - +Pieces Desktop App update dropdown menu on macOS ## Common Installation Issues @@ -117,7 +117,7 @@ To determine your Apple device’s version of macOS: The `macOS` line will report what version of macOS installed, e.g., `Sequoia 15.1.1`. - +Checking macOS version via About This Mac ### Checking CPU Type diff --git a/public/content/meet-pieces/troubleshooting/windows.md b/public/content/meet-pieces/troubleshooting/windows.md index 8c090fb..e1ad4ff 100644 --- a/public/content/meet-pieces/troubleshooting/windows.md +++ b/public/content/meet-pieces/troubleshooting/windows.md @@ -63,7 +63,7 @@ Once this is finished, you can now launch the Pieces Desktop App by pressing the ## Versions & Updates -Many issues can stem from out-of-date plugins, extensions, the desktop app, or PiecesOS itself. +Many issues can stem from out-of-date MCP integrations, the desktop app, or PiecesOS itself. ### Updating PiecesOS @@ -79,7 +79,7 @@ Many issues can stem from out-of-date plugins, extensions, the desktop app, or P - +Checking PiecesOS for updates on Windows taskbar For standalone .EXE installations, updates are checked daily or upon application launch, prompting you to install or delay as needed. @@ -113,7 +113,7 @@ Updating the Pieces Desktop App on Windows can be done directly from the app: - +Checking Pieces Desktop App for updates on Windows ## Issues Launching PiecesOS @@ -191,7 +191,7 @@ To check your device specifications on Windows: The **System** tab displays your processor, the number of CPU cores, and memory (RAM), while the **Display** tab lists your GPU, its manufacturer (NVIDIA, AMD, Intel, etc.), and the available video memory (VRAM). - +Checking hardware specs using dxdiag on Windows [Read documentation on the minimum recommended hardware specifications across all OS platforms.](/products/meet-pieces/troubleshooting/cross-platform#hardware-recommendations) @@ -207,7 +207,7 @@ To check what version of Windows you’re running: A new window will open called **About Windows**, which will display your current Windows version. - +Checking Windows version using winver command If this doesn't work, you're likely using a Windows version older than Windows 10. diff --git a/public/content/meet-pieces/windows-installation-guide.md b/public/content/meet-pieces/windows-installation-guide.md index b6534e0..3e0f1eb 100644 --- a/public/content/meet-pieces/windows-installation-guide.md +++ b/public/content/meet-pieces/windows-installation-guide.md @@ -9,7 +9,7 @@ metaDescription: Get started with Pieces on Windows – install, configure, trou ogImage: "https://storage.googleapis.com/hashnode_product_documentation_assets/og_images/meet_pieces/meet_pieces_windows_install.png" --- - +Pieces for Windows installation guide banner *** @@ -114,9 +114,13 @@ WinGet will allow you to easily install Pieces without having to leave the termi There are a series of on-screen prompts to navigate through when installing the Pieces Desktop App and PiecesOS, through either the `.exe` or `.appinstaller` desktop installation methods. + + **Don't install** Pieces or PiecesOS to **OneDrive** or other **cloud-synced** folders (Dropbox, Google Drive, etc.)—sync can interfere with installs and updates. Use the **default path** on a local drive. + + 1. **User Account Control (UAC):** If prompted by Windows’ User Account Control, click `Yes` to allow the installer to make changes. -2. **Install Location:** Choose where to install Pieces (default location is recommended) and click `Install`. +2. **Install Location:** Pick a **local** folder (see the warning above—avoid synced locations). The default path is recommended. Click `Install`. 3. **Select Additional Tasks:** Check `Create a desktop shortcut` or `Automatically start Pieces` if preferred. @@ -140,7 +144,7 @@ The Pieces Desktop App **automatically downloads and installs new updates.** You can also manually check for updates to PiecesOS and the Pieces Desktop App by hovering over your username in the top left, then hovering over `Update` and selecting either `Check for Desktop App Updates` or `Check for PiecesOS Updates`. - +Checking for updates in the Pieces Desktop App on Windows ### Uninstalling @@ -148,7 +152,7 @@ Open **Settings,** then find **Apps** and search `Pieces.` Two applications will appear after you enter the search query—**Pieces Desktop** and **PiecesOS.** Click the three dots to the right of the application title, and click `Uninstall`. - +Uninstalling Pieces and PiecesOS from Windows Settings ## Additional Resources diff --git a/public/content/organizations-and-teams.md b/public/content/organizations-and-teams.md index ad6c5d1..b6b83bf 100644 --- a/public/content/organizations-and-teams.md +++ b/public/content/organizations-and-teams.md @@ -20,7 +20,7 @@ metaDescription: Learn how to create organizations, invite members, manage setti 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 > Account settings page showing Organizations & Teams section with Create organization button @@ -32,7 +32,7 @@ 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 Home page showing management tools, setup instructions, and resource links > Organization Home page showing management tools, setup instructions, and resource links @@ -44,7 +44,7 @@ As an organization owner or admin, you can manage members, configure settings, c 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 Home page from a member's perspective showing available features > Organization Home page from a member's perspective showing available features @@ -56,7 +56,7 @@ As a member of an organization, you can collaborate with your team, view shared Resolve common issues when working with organizations, including authentication problems, workspace loading issues, and access problems. - +Troubleshooting guide showing common issues and solutions > Troubleshooting guide showing common issues and solutions diff --git a/public/content/organizations-and-teams/billing.md b/public/content/organizations-and-teams/billing.md index 6169bdf..12ea9fa 100644 --- a/public/content/organizations-and-teams/billing.md +++ b/public/content/organizations-and-teams/billing.md @@ -12,7 +12,7 @@ metaDescription: Guide to managing organization subscriptions, seat counts, bill 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 information, seats, and billing contact > Billing tab showing subscription information, seats, and billing contact @@ -78,7 +78,7 @@ Update the number of seats in your subscription to accommodate more or fewer tea 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 Contact section with fields for name, email, phone, and address > Billing Contact section with fields for name, email, phone, and address 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 4e894e8..4fc0b78 100644 --- a/public/content/organizations-and-teams/creating-and-joining-organizations.md +++ b/public/content/organizations-and-teams/creating-and-joining-organizations.md @@ -12,7 +12,7 @@ metaDescription: Step-by-step guide to creating organizations and accepting invi Create a new organization to start collaborating with your team, or accept an invitation to join an existing organization. Organizations allow you to share resources, manage team-wide settings, and collaborate effectively. - +Modal showing the walkthrough of creating an organization > Modal showing the walkthrough of creating an organization @@ -20,7 +20,7 @@ Create a new organization to start collaborating with your team, or accept an in Set up a new organization to start collaborating with your team. The creation process includes selecting a subscription plan and configuring initial settings. - +Account settings showing Organizations & Teams section with Create organization button @@ -70,7 +70,7 @@ Set up a new organization to start collaborating with your team. The creation pr Accept an invitation to join an existing organization and start collaborating with your team. - +Email invitation from organization with details and acceptance link diff --git a/public/content/organizations-and-teams/inviting-members.md b/public/content/organizations-and-teams/inviting-members.md index 9229785..8b548bd 100644 --- a/public/content/organizations-and-teams/inviting-members.md +++ b/public/content/organizations-and-teams/inviting-members.md @@ -12,7 +12,7 @@ metaDescription: Step-by-step guide to inviting members to your organization, in 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 with email input, role selection, and CSV upload > Invite members modal showing email input, role selection, and CSV upload option @@ -31,7 +31,7 @@ Add team members by sending invitations. You can invite one at a time, add multi Before inviting members, understand the different roles available and what each role can do within your organization. - +Member roles overview with Owner, Admin, Write, and Read descriptions > Member roles overview showing Owner, Admin, Write, and Read role descriptions @@ -139,7 +139,7 @@ Before inviting members, check your current seat usage: - +Members tab showing seat usage with current and total seats > 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 df1ab69..93cd20f 100644 --- a/public/content/organizations-and-teams/managing-members.md +++ b/public/content/organizations-and-teams/managing-members.md @@ -12,7 +12,7 @@ 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 with seat usage, current members, and pending invites > Members tab showing seat usage, current members list, and pending invites @@ -61,7 +61,7 @@ Track invitations that have been sent but not yet accepted by members. Update member roles and remove members from your organization. - +Changing member roles in the organization members list ### Managing Member Roles @@ -107,7 +107,7 @@ Remove members from your organization when they no longer need access. Seats are tied to your subscription and determine how many active members your organization can have. - +Seat usage card showing current and total seats available > Seat usage card showing current usage and total seats available diff --git a/public/content/organizations-and-teams/managing-organizations.md b/public/content/organizations-and-teams/managing-organizations.md index 50f13f5..f8bbbd2 100644 --- a/public/content/organizations-and-teams/managing-organizations.md +++ b/public/content/organizations-and-teams/managing-organizations.md @@ -21,7 +21,7 @@ metaDescription: Comprehensive guide to managing organizations, members, billing Access your organization's Home page to get set up, navigate to management tools, and find helpful resources for your team. - +Organization Home page with setup instructions and management links > Organization Home page showing setup instructions, management links, and resource cards @@ -33,7 +33,7 @@ Access your organization's Home page to get set up, navigate to management tools Add team members to your organization by sending invitations. You can invite members individually, add multiple members at once, or bulk upload via CSV. - +Invite members modal with email input and role selection > Invite members modal showing email input, role selection, and CSV upload option @@ -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 with seat usage, members list, and pending invites > Members tab showing seat usage, current members list, and pending invites @@ -57,7 +57,7 @@ View and manage all organization members, track seat usage, handle pending invit Manage your organization's subscription, update seat counts, view billing information, and configure billing addresses. - +Billing tab with subscription details, seat count, and billing address > Billing tab showing subscription details, seat count, and billing address options @@ -69,7 +69,7 @@ Manage your organization's subscription, update seat counts, view billing inform 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). - +Models section with general settings and API keys configuration > Models section showing general settings and API keys configuration @@ -81,7 +81,7 @@ The Models section is the organization management area for AI configuration. It 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 with Memory Formation toggles and Default Models > Long Term Memory section showing Memory Formation toggles and Default Models @@ -93,7 +93,7 @@ Configure context capture settings, application sources, denied websites, and de 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 with General and Features tabs > Settings page showing tabs for General and Features diff --git a/public/content/organizations-and-teams/member-permissions.md b/public/content/organizations-and-teams/member-permissions.md index 0a12a77..c261948 100644 --- a/public/content/organizations-and-teams/member-permissions.md +++ b/public/content/organizations-and-teams/member-permissions.md @@ -16,7 +16,7 @@ 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 with seat usage and member list showing role indicators > Members tab showing seat usage and member list with role indicators diff --git a/public/content/organizations-and-teams/organization-member-guide.md b/public/content/organizations-and-teams/organization-member-guide.md index 0ffd642..2d42803 100644 --- a/public/content/organizations-and-teams/organization-member-guide.md +++ b/public/content/organizations-and-teams/organization-member-guide.md @@ -17,7 +17,7 @@ As a member of an organization, you can collaborate with your team, view shared 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 Home page from a member's perspective > Organization Home page from a member's perspective showing available features @@ -29,7 +29,7 @@ Access your organization's Home page to get set up with Pieces and collaborate w Learn about the different member roles and what each role can and cannot do within an organization. - +Member permissions overview showing role differences and access levels > Member permissions overview showing role differences and access levels diff --git a/public/content/organizations-and-teams/organization-overview.md b/public/content/organizations-and-teams/organization-overview.md index 0b566c2..5f4d5ad 100644 --- a/public/content/organizations-and-teams/organization-overview.md +++ b/public/content/organizations-and-teams/organization-overview.md @@ -12,7 +12,7 @@ metaDescription: Guide to using the organization Home page, accessing setup reso 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 Home page with Setup, Manage, and Resources sections > Organization Home page with Setup, Manage, and Resources sections diff --git a/public/content/organizations-and-teams/organization-settings.md b/public/content/organizations-and-teams/organization-settings.md index 102b8e3..4843e23 100644 --- a/public/content/organizations-and-teams/organization-settings.md +++ b/public/content/organizations-and-teams/organization-settings.md @@ -32,7 +32,7 @@ metaDescription: Learn how to configure organization settings and control featur Configure basic organization information, contact details, and address. Update your organization's identity and how Pieces reaches you for billing and support. - +General settings tab with organization name, contact info, and address > General settings tab showing organization name, contact info, and address fields @@ -44,7 +44,7 @@ Configure basic organization information, contact details, and address. Update y Toggle organization-wide features that sync to team members' Pieces Desktop and PiecesOS. Control external cloud, analytics, and reporting features. - +Features settings tab with External Cloud and Analytics toggles > Features settings tab showing External Cloud and Analytics toggles diff --git a/public/content/organizations-and-teams/settings-api-keys.md b/public/content/organizations-and-teams/settings-api-keys.md index b6aacf5..25cebff 100644 --- a/public/content/organizations-and-teams/settings-api-keys.md +++ b/public/content/organizations-and-teams/settings-api-keys.md @@ -12,7 +12,7 @@ metaDescription: Learn how to configure API keys for OpenAI, Anthropic, and GCP 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 tab with OpenAI, Anthropic, and GCP configuration sections > API Keys tab showing OpenAI, Anthropic, and GCP configuration sections @@ -38,7 +38,7 @@ The API Keys tab is one of two tabs within the *Models* section—the organizati Set up API credentials for model providers. Each provider has its own configuration section: OpenAI, Anthropic (Claude), and GCP Configuration. - +Adding a new API key in the configuration form ### Configuring OpenAI @@ -115,7 +115,7 @@ Set up GCP API keys and Vertex AI service accounts for your organization. View, edit, and remove existing API key configurations. - +Edit API Key form with name, key, and optional fields > Edit API Key form showing name, API key, and optional fields diff --git a/public/content/organizations-and-teams/settings-features.md b/public/content/organizations-and-teams/settings-features.md index 560a438..bf866fb 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 with feature toggles and processing options > Features settings tab showing various feature toggles and processing options diff --git a/public/content/organizations-and-teams/settings-general.md b/public/content/organizations-and-teams/settings-general.md index 088a25c..8eb61aa 100644 --- a/public/content/organizations-and-teams/settings-general.md +++ b/public/content/organizations-and-teams/settings-general.md @@ -12,7 +12,7 @@ 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 with organization name, contact info, and domains > General settings tab showing organization name, contact info, domains, and danger zone @@ -100,7 +100,7 @@ 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. - +Organization deletion confirmation in the Danger Zone section 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. diff --git a/public/content/organizations-and-teams/settings-ltm-sources.md b/public/content/organizations-and-teams/settings-ltm-sources.md index 5332651..07dea70 100644 --- a/public/content/organizations-and-teams/settings-ltm-sources.md +++ b/public/content/organizations-and-teams/settings-ltm-sources.md @@ -12,7 +12,7 @@ metaDescription: Learn how to configure LTM context capture, application sources 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. - +Long Term Memory settings with Memory Formation toggles and Default Models > Long Term Memory section showing Memory Formation toggles and Default Models @@ -61,7 +61,7 @@ The *General* tab has three toggles that control how Pieces captures context. Tu 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 with model assignments > Default Models section on the LTM General tab showing model assignment options @@ -81,7 +81,7 @@ Default models are used for memory event processing, auto-generated summaries, a 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 with names, bundle IDs, and toggle switches > Available applications list showing application names, bundle IDs, and toggle switches diff --git a/public/content/organizations-and-teams/settings-ltm-websites.md b/public/content/organizations-and-teams/settings-ltm-websites.md index 9279007..ccd4183 100644 --- a/public/content/organizations-and-teams/settings-ltm-websites.md +++ b/public/content/organizations-and-teams/settings-ltm-websites.md @@ -12,7 +12,7 @@ metaDescription: Learn how to enable LTM website management and block specific w 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. - +Blocked websites list with add input and CSV upload > Blocked websites list with add input and CSV upload @@ -24,7 +24,7 @@ The LTM Websites settings allow you to configure which websites are blocked from 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 > Enabling Organization managed denied websites in the General tab diff --git a/public/content/organizations-and-teams/settings-models.md b/public/content/organizations-and-teams/settings-models.md index 372989f..955c770 100644 --- a/public/content/organizations-and-teams/settings-models.md +++ b/public/content/organizations-and-teams/settings-models.md @@ -12,7 +12,7 @@ metaDescription: Learn how to manage model access, processing mode, and API keys 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 with provider sections, model lists, and toggles > Models page showing provider sections (Google, OpenAI) with model lists and toggles @@ -55,7 +55,7 @@ By default, all models from enabled providers are available. To control which pr 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. - +Provider sections with on/off toggles for Google, OpenAI, and others > Provider sections with on/off toggles for Google, OpenAI, and other providers diff --git a/public/content/organizations-and-teams/troubleshooting.md b/public/content/organizations-and-teams/troubleshooting.md index 2038645..472174b 100644 --- a/public/content/organizations-and-teams/troubleshooting.md +++ b/public/content/organizations-and-teams/troubleshooting.md @@ -12,7 +12,7 @@ metaDescription: Find solutions to common organization access issues and authent If you encounter issues when creating, accessing, or managing organizations, use this guide to resolve common problems. - +Organizations and Teams troubleshooting guide > Troubleshooting guide showing common issues and solutions diff --git a/public/content/paid-plans.md b/public/content/paid-plans.md index f6a3c5a..b0f6b68 100644 --- a/public/content/paid-plans.md +++ b/public/content/paid-plans.md @@ -9,7 +9,7 @@ metaDescription: Upgrade to Pieces Pro to access top-tier AI models from Claude, ogImage: "https://storage.googleapis.com/hashnode_product_documentation_assets/og_images/pieces_more/paid_plans.png" --- - +Pieces Pro premium plan banner ## About Pieces Pro @@ -130,7 +130,7 @@ For details on which models are available on each plan, see [Models](/products/d Unlimited access to *premium LLMs, infinite long-term memory,* and *priority support* are a combination that empowers your team to code smarter, faster, and with greater confidence. - +Upgrade to Pieces Pro prompt in the Desktop App ### Premium AI Models @@ -191,7 +191,7 @@ Use the built-in controls in Pieces Desktop or PiecesOS to activate your Pro sub Below the account section, there’s a new section called `Unlock Pieces Pro`. - + Unlock Pieces Pro section in PiecesOS Quick Menu @@ -211,7 +211,7 @@ Proceed through the purchase form to enter your contact and payment information. Provide your email address, country, and ZIP/postal code. - + Pieces Pro checkout contact information form You may opt in to receive product updates and offers. @@ -237,7 +237,7 @@ Proceed through the purchase form to enter your contact and payment information. Click `Pay Now` to finalize your subscription. - + Thank you page after completing Pieces Pro purchase @@ -267,7 +267,7 @@ Change or add your credit card directly in the *Payment methods* tab. Click `Account` from the settings hover menu to view your account settings, including your subscription. - + Account settings showing subscription management options @@ -285,7 +285,7 @@ Change or add your credit card directly in the *Payment methods* tab. Click `Update payment method` to confirm and store the updated payment information to be *used on the next billing cycle*. - + Update payment method form for Pieces Pro subscription @@ -313,7 +313,7 @@ Click `Cancel subscription` in the *Subscription* tab. You’ll be redirected to Click `Cancel subscription` to end your plan immediately or click `Back` to return without canceling. - + Cancel subscription confirmation dialog @@ -341,7 +341,7 @@ Browse your billing history in the *Payments* tab. Click `any entry` to view a c On the *Payments* tab, you’ll see all of your active and past invoices — click on any one to access the details and edit any information within the invoice. - + Invoices and billing history in the Payments tab @@ -376,11 +376,11 @@ Once you've confirmed both, try the upgrade process again. ### Live Support with Pieces -We aim to make your experience with PiecesOS, the Pieces Desktop App, and our IDE or browser integrations as smooth as possible by engaging with users to improve our products, and you can book a call with our developers for assistance via our support calendar. +We aim to make your experience with PiecesOS, the Pieces Desktop App, and our MCP integrations as smooth as possible by engaging with users to improve our products, and you can book a call with our developers for assistance via our support calendar. ### Open a GitHub Issue**​** -You can open GitHub issues for PiecesOS, the Pieces Desktop App, or any other Pieces plugin or extension by opening an issue in our GitHub repository. +You can open GitHub issues for PiecesOS, the Pieces Desktop App, or any other Pieces MCP integration by opening an issue in our GitHub repository. If you would prefer not to use GitHub, you can still leave feedback or report a bug here. diff --git a/public/content/privacy-security-your-data.md b/public/content/privacy-security-your-data.md index 7c5c16a..c89160e 100644 --- a/public/content/privacy-security-your-data.md +++ b/public/content/privacy-security-your-data.md @@ -9,7 +9,7 @@ metaDescription: Understand how Pieces handles privacy, security, and data prote ogImage: "https://storage.googleapis.com/hashnode_product_documentation_assets/og_images/pieces_more/privacy_security_your_data.png" --- - +Pieces privacy and security banner ## Private and Secure @@ -24,7 +24,7 @@ Designed for complete user control, all cloud features are opt-in only, telemetr 🛡️ *We are SOC 2 Certified & Enterprise-Ready!* - +SOC 2 compliance certification badge *** diff --git a/public/content/quick-guides/copilot-with-context.md b/public/content/quick-guides/copilot-with-context.md index 6d541b2..9c51efa 100644 --- a/public/content/quick-guides/copilot-with-context.md +++ b/public/content/quick-guides/copilot-with-context.md @@ -51,7 +51,7 @@ The first step is to review the issue by letting Pieces capture it, and then ask Pieces will respond with a summary of the issue: - +Pieces Copilot summarizing a GitHub issue using LTM context ### Clone the Project @@ -83,13 +83,13 @@ Adding the project as context to your Pieces Copilot Chat will look a little dif Select the `scifi_store` folder in the repository you cloned in the previous step. - + Selecting the scifi_store folder as Copilot context From the **Explorer**, right-click on the pane itself (not on a file or folder), and select `Pieces`, then click `Pieces: Add to Copilot Context`. - + Adding a folder to Copilot context in VS Code @@ -113,7 +113,7 @@ Now that Pieces has the issue from the Long-Term Memory and the project folder a Review these code changes along with the original codebase. - + Pieces Copilot reasoning over the project and GitHub issue @@ -147,6 +147,6 @@ This was done in 2 stages to illustrate the information from the Pieces Long-Ter The Pieces Copilot will now reason over your project, as well as the GitHub issue, and give you suggestions on how to implement it. - + Pieces Copilot implementing an issue with a single prompt \ No newline at end of file diff --git a/public/content/quick-guides/ltm-prompting/workstream-activity.md b/public/content/quick-guides/ltm-prompting/workstream-activity.md index 9a4e491..70eda97 100644 --- a/public/content/quick-guides/ltm-prompting/workstream-activity.md +++ b/public/content/quick-guides/ltm-prompting/workstream-activity.md @@ -30,7 +30,7 @@ If your project has a unique name, or other identifier that is easy to query for Once you have this, you can either open it all in a Pieces Copilot chat and have the LLM create a detailed summary report to share with someone else, or you can export and share the activities directly, either as markdown files, or as raw text. - +Filtering Workstream Activities by project keyword ## Create a Summary To Document a Process @@ -40,7 +40,7 @@ The problem with this approach is that it misses important context, such as link By using Pieces, you can go through a process by checking documents, chats, emails, and code—then, you can create a new Workstream Activity for the time you spent. - +LTM roll-up summary for documenting a process This summary can be shared with your colleagues and will include text details like links to the documents you read, information about people involved in the conversations, links to code, and more. @@ -50,6 +50,6 @@ Pieces can help you create a summary of completed work based on details like tic You can do this by going through your ticket system and reviewing all the tickets you worked on the previous day. - +Generating a standup-style summary from Workstream Activities Then, create a new Workstream Activity for the time you spent reviewing, which will include deep links to the tickets. You can use this raw content for your daily standup or ask the Pieces Copilot to summarize it in a more suitable format. \ No newline at end of file diff --git a/public/content/quick-guides/overview.md b/public/content/quick-guides/overview.md index 29c3b7f..d245f2f 100644 --- a/public/content/quick-guides/overview.md +++ b/public/content/quick-guides/overview.md @@ -9,7 +9,7 @@ metaDescription: Explore quick guides to get started with Pieces. Learn prompts, ogImage: "https://storage.googleapis.com/hashnode_product_documentation_assets/og_images/quick_guides/quick_guides.png" --- - +Pieces Quick Guides overview banner *** diff --git a/public/content/raycast.md b/public/content/raycast.md index 473dba5..f74b7ea 100644 --- a/public/content/raycast.md +++ b/public/content/raycast.md @@ -8,7 +8,7 @@ metaTitle: Using Pieces for Raycast | Pieces Docs metaDescription: Understand the benefits and importance of using the Pieces Raycast Extension, and get started with Quickstart and Commands. --- - +Pieces for Raycast Extension banner @@ -83,7 +83,7 @@ PiecesOS will automatically open in your toolbar and pop up a *Notification pref To do this, open the PiecesOS Quick Menu and click `Enable Long-Term Memory Engine`. - +Enabling Long-Term Memory Engine in PiecesOS Quick Menu ## Install the Pieces for Raycast Extension @@ -131,7 +131,7 @@ Quickly search across all of your saved code snippets using Raycast’s minimal This command surfaces results enriched with metadata such as title, language, tags, and source (e.g., clipboard, browser, editor). It’s a fast way to rediscover useful context you’ve captured in the past, without digging through files, emails, or browser tabs. - +Searching saved code snippets in Raycast Use this feature when: @@ -147,7 +147,7 @@ This command displays a timeline of your clipboard history—enriched with metad You can scroll through recently copied content and selectively save high-value items as persistent snippets. Each saved snippet includes its origin, content type, and timestamp, helping you retain the most relevant fragments of your workday. - +Saving clipboard history to Pieces via Raycast ### Save Clipboard to Pieces @@ -155,7 +155,7 @@ You can quickly save the current content in your clipboard to Pieces. This command is perfect for moments when you quickly copy a block of code, a command, or a snippet of text and want to ensure its preservation. - +Saving current clipboard content to Pieces via Raycast ### Save Browser History to Pieces @@ -163,7 +163,7 @@ This command allows you to surface code snippets that you recently interacted wi Pieces identifies these snippets in your browser activity and gives you the option to save them with proper enrichment and metadata. - +Saving browser history snippets to Pieces via Raycast ### Save Finder Selection @@ -171,7 +171,7 @@ Select one or more files in macOS Finder and save them to Pieces with a single c Files are stored as artifacts in your Pieces Library and enriched with metadata like filename, extension, and path. - +Saving Finder file selection to Pieces via Raycast ### Save Selection in Any App @@ -179,7 +179,7 @@ Highlight any text in the currently active (frontmost) application—like VS Cod This command enables frictionless, cross-app snippet capture without copy/paste. - +Saving text selection from any app to Pieces via Raycast ## Account Access @@ -197,13 +197,13 @@ This command securely authenticates your Pieces account from within Raycast, ena Once signed in, your saved snippets are backed up and available wherever Pieces is installed. - +Signing in to Pieces account from Raycast ### Sign out of Pieces Log out of your Pieces account from Raycast. - +Signing out of Pieces account from Raycast This is useful for switching accounts, temporarily disabling cloud syncing, or handing off a machine to another developer. diff --git a/public/content/support.md b/public/content/support.md index 354e45b..5673623 100644 --- a/public/content/support.md +++ b/public/content/support.md @@ -9,7 +9,7 @@ metaTitle: Pieces Support metaDescription: Reach out to our engineers, open support tickets, and read discussions on our GitHub page for support with Pieces software. --- - +Pieces support banner *** @@ -25,13 +25,13 @@ We've got you covered if you’re experiencing an issue or have feedback for the ## Live Support with Pieces -We want to ensure that your experience with PiecesOS, the Pieces Desktop App, and any of our IDE or browser integrations is as smooth and seamless as possible—and part of that is speaking with as many users as possible so we can continue iterating and improving on Pieces products. +We want to ensure that your experience with PiecesOS, the Pieces Desktop App, and any of our MCP integrations is as smooth and seamless as possible—and part of that is speaking with as many users as possible so we can continue iterating and improving on Pieces products. If you need help getting everything up and running, feel free to book a call with our Founders & Engineering Leaders via our support calendar. ## Open a GitHub Issue**​** -You can open GitHub issues for PiecesOS, the Pieces Desktop App, or any other Pieces plugin or extension by opening an issue in our GitHub repository. +You can open GitHub issues for PiecesOS, the Pieces Desktop App, or any other Pieces MCP integration by opening an issue in our GitHub repository. If you would prefer not to use GitHub, you can still leave feedback or report a bug here. @@ -65,7 +65,7 @@ At any time, you can find your up-to-date log files in the following locations, **Note:** If you don’t see the `Library` folder or certain files, press `⌘+shift+.` (period) to show hidden files in Finder. - + Locating Pieces log files on macOS @@ -93,7 +93,7 @@ At any time, you can find your up-to-date log files in the following locations, * Check **Hidden items**. - + Locating Pieces log files on Windows @@ -113,7 +113,7 @@ At any time, you can find your up-to-date log files in the following locations, 3. Open `production` → `Support` to view the logs. If the folder doesn’t appear, ensure hidden files are visible. In most file managers, press `ctrl+h` to toggle hidden files on/off. - + Locating Pieces log files on Linux diff --git a/public/content/web-extension.md b/public/content/web-extension.md index 913d591..51cb349 100644 --- a/public/content/web-extension.md +++ b/public/content/web-extension.md @@ -8,7 +8,7 @@ metaTitle: Using the Pieces Web Extension | Pieces Docs metaDescription: Use the Pieces Web Extension to quickly capture, save, and manage code snippets from any webpage, enhancing your development workflow. --- - +Pieces Web Extension banner *** @@ -50,7 +50,7 @@ Pieces Copilot provides you with the ability to initiate context-rich generative You can also add websites, files, and other materials as context to your conversations. - +Right-click context menu with Pieces Copilot options ### Material Management with Pieces Drive @@ -60,7 +60,7 @@ These features help developers store their favorite code or websites in a person You can quickly review past work, find related authors and links with the extra details saved with each piece, and more. - +Saved snippet context menu in the Web Extension ## Using Pieces Copilot @@ -74,7 +74,7 @@ This is the backbone of the Pieces Copilot experience—the **Ask Copilot** feat When you save material to your personal repository, Pieces automatically enriches the snippet with AI-generated tags, titles, related authors, links, descriptions, and more. - +Hover menu showing Ask Pieces and Save Selection options Save materials by right-clicking a selection and choosing the `Save Selection` `to Pieces` option from the pop-up window. @@ -90,7 +90,7 @@ At the top of the Pieces Drive, you can [search](/products/web-extension/drive/s Once you've found the material you want, clicking on it will open it, giving you [options to manage it](/products/web-extension/drive/edit-update). Pieces will also provide options to [share and copy.](/products/web-extension/drive/sharing) - +Editing and managing a saved snippet in the Web Extension ***