diff --git a/public/content/_deprecated/desktop/organizations-and-teams.md b/public/content/_deprecated/desktop/organizations-and-teams.md new file mode 100644 index 0000000..b77141d --- /dev/null +++ b/public/content/_deprecated/desktop/organizations-and-teams.md @@ -0,0 +1,72 @@ +--- +title: Organizations & Teams +path: /desktop/organizations-and-teams +visibility: PUBLIC +status: PUBLISHED +description: Create and manage organizations and teams to collaborate with others, share resources, and maintain consistent settings across your team in Pieces. +metaTitle: Organizations & Teams in Pieces Desktop | Pieces Docs +metaDescription: Learn how to create organizations, invite team members, manage team settings, and collaborate effectively with your team. +_deprecated: true +_deprecated_note: Not in nav. Use /products/organizations-and-teams (Getting Started) instead. +--- + + + + + +*** + +## Creating and Joining Organizations + +Create a new organization to start collaborating with your team, or accept an invitation to join an existing organization. As an organization owner, you'll have full control over team settings, member access, and shared resources. + + + +> Account settings page showing Organizations & Teams section with Create organization button + + + Learn how to create a new organization, accept invitations, and get started with team collaboration. + + +## Managing Organizations + +As an organization owner or admin, you can manage members, configure settings, control billing, and oversee all aspects of your organization. Access powerful admin features to maintain team-wide consistency and control. + + + +> Organization overview page showing updates, members, teams, billing, and settings options + + + Explore organization management features including member management, billing, teams, and settings configuration. + + +## Organization Member Guide + +As a member of an organization, you can collaborate with your team, post updates, view shared content, and participate in team activities. Understand what you can do and how your role affects your access and permissions. + + + +> Organization overview page from a member's perspective showing available features and limitations + + + Learn about member features, permissions, and how to effectively collaborate within your organization. + + +## Troubleshooting + +Resolve common issues when working with organizations, including authentication problems, workspace loading issues, and access problems. + + + +> Troubleshooting guide showing common issues and solutions + + + Find solutions to common organization access issues and authentication problems. + + +*** + +If Organizations & Teams isn't what you're looking for, check out [Account Settings](/products/desktop/configuration/account) to manage your personal account, or explore [Connected Applications](/products/desktop/configuration/connected-applications) to integrate third-party services with your organization. diff --git a/public/content/_deprecated/desktop/organizations-and-teams/managing-organizations.md b/public/content/_deprecated/desktop/organizations-and-teams/managing-organizations.md new file mode 100644 index 0000000..d23ce27 --- /dev/null +++ b/public/content/_deprecated/desktop/organizations-and-teams/managing-organizations.md @@ -0,0 +1,96 @@ +--- +title: Managing Organizations +path: /desktop/organizations-and-teams/managing-organizations +visibility: PUBLIC +status: PUBLISHED +description: Learn to manage your organization as an owner or admin, including member management, billing, teams, and settings. +metaTitle: Managing Organizations | Pieces Docs +metaDescription: Comprehensive guide to managing organizations, members, teams, billing, and settings in Pieces. +_deprecated: true +_deprecated_note: Not in nav. Use /products/organizations-and-teams/managing-organizations (Getting Started) instead. +--- + + + + + +*** + +## Organization Overview + +Access your organization dashboard to view updates, post content, invite members, and navigate to different sections of your organization. + + + +> Organization overview page showing recent updates, post update button, and sidebar navigation + + + Learn how to navigate your organization dashboard, post updates, and interact with team content. + + +## Inviting Members + +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 showing email input, role selection, and CSV upload option + + + Discover how to invite team members, assign roles, and use bulk invitation methods. + + +## Managing Members + +View and manage all organization members, track seat usage, handle pending invitations, and update member roles and permissions. + + + +> Members tab showing seat usage, current members list, and pending invites + + + Learn how to manage member roles, view seat usage, and handle member-related tasks. + + +## Managing Teams + +Create and manage teams within your organization to organize members into smaller groups. Teams can post updates and collaborate on specific projects. + + + +> Teams dropdown showing team list and create team option + + + Explore how to create teams, manage team members, and organize your organization into smaller groups. + + +## Billing + +Manage your organization's subscription, update seat counts, view billing information, and configure billing addresses. + + + +> Billing tab showing subscription details, seat count, and billing address options + + + Learn how to manage subscriptions, update seats, and configure billing information. + + +## Organization Settings + +Configure organization-wide settings that sync to team members' Pieces Desktop and PiecesOS installations. Control features, API keys, models, and LTM sources for your entire organization. + + + +> Settings page showing tabs for General, Teams, Features, API Keys, Models, LTM Sources, and LTM Websites + + + Discover how to configure organization settings, manage feature toggles, and control team-wide configurations. + + +*** + +Now that you understand organization management, learn about [Account Settings](/products/desktop/configuration/account) to manage your personal account, or explore how to [create and join organizations](/products/organizations-and-teams/creating-and-joining-organizations). diff --git a/public/content/_deprecated/desktop/organizations-and-teams/organization-member-guide.md b/public/content/_deprecated/desktop/organizations-and-teams/organization-member-guide.md new file mode 100644 index 0000000..4a7f48d --- /dev/null +++ b/public/content/_deprecated/desktop/organizations-and-teams/organization-member-guide.md @@ -0,0 +1,43 @@ +--- +title: Organization Member Guide +path: /desktop/organizations-and-teams/organization-member-guide +visibility: PUBLIC +status: PUBLISHED +description: Guide for Read and Write members on how to collaborate within organizations and understand member permissions. +metaTitle: Organization Member Guide | Pieces Docs +metaDescription: Learn about member features, permissions, and how to effectively collaborate within your organization. +_deprecated: true +_deprecated_note: Not in nav. Use /products/organizations-and-teams/organization-member-guide (Getting Started) instead. +--- + +## Organization Member Guide + +As a member of an organization, you can collaborate with your team, post updates, view shared content, and participate in team activities. This guide explains what you can do as a member and how your role affects your access and permissions. + +## Organization Overview + +Access your organization dashboard to view updates, post content, and interact with your team. Members can participate in team collaboration while having limited administrative access. + + + +> Organization overview page from a member's perspective showing available features + + + Learn how to navigate your organization dashboard, post updates, and interact with team content as a member. + + +## Understanding Member Permissions + +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 + + + Understand member roles, permissions, and how they affect what you can do in your organization. + + +*** + +If Organization Member Guide isn't what you're looking for, check out [Managing Organizations](/products/organizations-and-teams/managing-organizations) to learn about admin features, or explore [Account Settings](/products/desktop/configuration/account) to manage your personal account. diff --git a/public/content/cli/configuration.md b/public/content/cli/configuration.md index 5f5d14c..82cf30e 100644 --- a/public/content/cli/configuration.md +++ b/public/content/cli/configuration.md @@ -5,17 +5,21 @@ visibility: PUBLIC status: PUBLISHED --- +*** + ## Settings and Models -Learn how to configure the Pieces CLI—changing both LLMs and the code editor. +Configure the Pieces CLI by changing both language models and the code editor. +> Available models and settings configuration interface + ## Supported LLMs -We continually update and configure our plugins and extensions to ensure compatibility with the latest large language models (LLMs). +The Pieces CLI supports 26 cloud-based language models that you can switch between. -The Pieces CLI currently supports 26 cloud-based models. +We continually update and configure our plugins and extensions to ensure compatibility with the latest large language models (LLMs). | Supported LLMs | Supported LLMs | | ----------------------------- | ---------------- | @@ -37,44 +41,64 @@ The Pieces CLI currently supports 26 cloud-based models. ## Settings Overview -Below is a breakdown of each adjustable setting (preferences, behaviors, views, etc.) you can find in the Pieces CLI, broken down by section +A breakdown of each adjustable setting you can configure in the Pieces CLI, organized by section. + +### List Applications + +View all registered applications and verify which integrations are available. + +Run `list apps` to see every application you've registered. This prints a table of app names and IDs so you can verify which integrations are available. -**List Applications** +### List Models -To see every application you’ve registered, run `list apps`. This prints a table of app names and IDs so you can verify which integrations are available. +Display all language models configured for the `ask` command. -**List Models** +Use `list models` to display all language models you've configured for the `ask` command. The output shows each model's name and index, and which is currently active. -Use `list models` to display all AI models you’ve configured for the `ask` command. The output shows each model’s name and index, and which is currently active. +### View Configuration -**View Configuration** +Print your current IDE selection for code editing. Run `config` to print your current IDE selection for code editing. -**Edit Configuration** +### Edit Configuration + +Open your config file in your preferred editor to adjust settings. Execute `config --editor ` to open your config file in the editor of your choice. Simply adjust values (for example, change `timeout: 10` to `timeout: 20`) and save—your changes take effect immediately. -**Login** +### Login + +Authenticate with your Pieces Cloud account to sync materials and access private resources. -Authenticate with your Pieces Cloud account by running `login`. You’ll be prompted for credentials in a web browser; once you’re logged in, you can sync materials and access private resources in your [Pieces Drive](/products/cli/drive). +Run `login` to authenticate with your Pieces Cloud account. You'll be prompted for credentials in a web browser; once you're logged in, you can sync materials and access private resources in your [Pieces Drive](/products/cli/drive). -**Logout** +### Logout + +Clear your saved credentials and end your session. Use `logout` to clear your saved credentials and end your session. This is useful when switching accounts or working on a shared machine. -**Contribute** +### Contribute + +Start a contribution workflow to submit improvements to the CLI. -Kick off a contribution workflow with `contribute`. You’ll be guided through describing your changes, and a pull-request template will open in your browser so you can submit improvements to the CLI. +Kick off a contribution workflow with `contribute`. You'll be guided through describing your changes, and a pull-request template will open in your browser so you can submit improvements to the CLI. -**Install PiecesOS** +### Install PiecesOS + +Download and set up PiecesOS, which provides background services and a graphical dashboard. Run `install` to download and set up the [PiecesOS](/products/core-dependencies/pieces-os), which provides background services, like Pieces Drive, and a graphical dashboard for non-CLI related tasks. -**Open PiecesOS** +### Open PiecesOS + +Launch the desktop app or helper Applet. -Use `open` to launch the desktop app or helper Applet. If it isn’t already running, this command starts the service and brings up the GUI. +Use `open` to launch the desktop app or helper Applet. If it isn't already running, this command starts the service and brings up the GUI. *** +## Next Steps + For additional support resources, check out our [troubleshooting guide.](/products/cli/troubleshooting) diff --git a/public/content/core-dependencies.md b/public/content/core-dependencies.md index 066baca..e045aa0 100644 --- a/public/content/core-dependencies.md +++ b/public/content/core-dependencies.md @@ -3,9 +3,9 @@ title: Core Dependencies path: /core-dependencies visibility: PUBLIC status: PUBLISHED -description: Learn about PiecesOS and Ollama, the two core dependencies that power the Pieces Desktop App and the entire Pieces suite of plugins and extensions. +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. metaTitle: Pieces Core Dependencies -metaDescription: Learn about PiecesOS and Ollama, the two core dependencies that power the Pieces Desktop App and the entire Pieces suite of plugins and extensions. +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. --- @@ -14,23 +14,31 @@ metaDescription: Learn about PiecesOS and Ollama, the two core dependencies that ## What Are Core Dependencies? -Pieces products, including the [Pieces Desktop Application](/products/desktop), utilize *two core dependencies* to provide a local, secure, and efficient experience—[PiecesOS](/products/core-dependencies/pieces-os) and [Ollama](/products/core-dependencies/ollama)**.** +Pieces products, including the [Pieces Desktop Application](/products/desktop), are built on [PiecesOS](/products/core-dependencies/pieces-os), which provides a local, secure, and efficient experience with built-in AI capabilities. -## What Are They? +## What Is PiecesOS? -To run any Pieces software, you will need **\[1] PiecesOS,** the backbone of the Pieces Suite. This lightweight application runs in the background of your device. +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) -Running local LLMs requires downloading and installing the **\[2] Ollama** wrapper to power on-device AI capabilities, such as querying Pieces Copilot or the local inference required by the LTM-2.7 Engine. +**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. -1. **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. +## Local Models -2. **Ollama**: A specialized wrapper that enables local AI inference, allowing Pieces Copilot and other features to leverage machine learning models *directly on your device.* +Pieces includes built-in local models that run directly through PiecesOS—no external dependencies required. -## What Do They Do? +These models power: +- **Long-Term Memory (LTM-2.7)** workflow processing +- **Code enrichment** and analysis +- **Pieces Copilot** with on-device LLMs +- **Secret detection** and security scanning -These dependencies—**PiecesOS and Ollama**—are lightweight services and engines that handle everything from local model management and context storage to advanced local inference for AI-assisted workflows. +All local processing happens entirely on your device through PiecesOS, ensuring privacy and offline functionality. + +## What Does PiecesOS Do? + +PiecesOS is a lightweight service that handles everything from local model management and context storage to advanced local inference for AI-assisted workflows. @@ -40,13 +48,13 @@ PiecesOS is **required** for all Pieces products, including: * 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. -## Why Do We Need Them? +## Why Do We Need PiecesOS? -Pieces is designed with **speed and efficiency** in mind, so PiecesOS acts as the end-all between different Pieces products to minimize client-side overhead and additional code while also being secure and highly configurable. +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. -Our focus on **security and flexibility** is why we’ve introduced the Ollama wrapper for local large language models—users can switch entirely to on-device generative AI, and by offloading most operations locally, the user experience benefits from: +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: * **Instant AI-powered assistance** without cloud latency. @@ -56,15 +64,14 @@ Our focus on **security and flexibility** is why we’ve introduced the Ollama w * **Lightweight, background operation**, consuming minimal system resources. -However, you don't have to install Ollama if you don't want to use it. +Local models are built into PiecesOS automatically, providing on-device AI capabilities without any additional setup or installation. -You can install it if you want to use local models, which is especially useful in enterprise settings where strong device security is important. +This is especially useful in enterprise settings where strong device security is important. *** -| **Dependency** | **Purpose** | **Required?** | -| -------------- | --------------------------------------------------------------------- | ------------------------------------------------- | -| *PiecesOS* | Manages memory, developer material storage, and plugin communication. | Yes — this is required for all Pieces products. | -| *Ollama* | Enables locally powered generative AI queries and model execution. | No — but this is required for local AI inference. | +| **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. | *** diff --git a/public/content/core-dependencies/local-models.md b/public/content/core-dependencies/local-models.md new file mode 100644 index 0000000..468a4ca --- /dev/null +++ b/public/content/core-dependencies/local-models.md @@ -0,0 +1,111 @@ +--- +title: Understanding Local Models +path: /core-dependencies/local-models +visibility: PUBLIC +status: PUBLISHED +description: Learn about local models, an optional capability that enables fully on-device generative AI for Conversational Search. +metaTitle: Local Models | Pieces Core Dependencies +metaDescription: Learn about local models, an optional capability that enables fully on-device generative AI for Conversational Search. +ogImage: "https://storage.googleapis.com/hashnode_product_documentation_assets/og_images/core_dependencies/ollama.png" +--- + +## What Are Local Models? + +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. + + + +Unlike cloud models—which require an internet connection—local models run entirely on your device, providing complete privacy and offline functionality. + + + Local models for Conversational Search are *separate* from the in-house LoRA models that PiecesOS uses for processing data with the LTM-2.7 Engine. Those built-in models are always available and require no additional downloads. + + +## Why Use Local Models? + +PiecesOS provides local AI processing directly through its built-in infrastructure, making it faster, more stable, and easier to use. + +Local models can be downloaded on-demand and ensure compatibility with [Pieces supported LLMs](/products/core-dependencies/local-models/supported-models), allowing new local models to be integrated soon after they are released. + +Additionally, many developers and organizations prefer local LLMs over cloud-hosted models for reasons such as: + +* **Stronger data security**, as it keeps proprietary code and sensitive queries 100% local. + +* **Faster response times** with no network delays during generative AI processing and local inference. + +* **Offline accessibility** for use even when no internet connection is present. + +* **Enterprise compliance** so all AI queries remain within company-managed environments. + +### How It Works + +Local models are integrated with PiecesOS to enable local model inference and generative AI capabilities. + +Here's how local models work with PiecesOS: + +* **Serve on-device LLMs**, reducing cloud dependency and enhancing privacy. + +* **Download on-demand**, so you only install the models you need for your workflow. + +* **Support a curated set of models**, all optimized for performance with efficient quantization. + +* **Ensure compatibility** with PiecesOS through automatic version management. + + + Since local models are several GBs in size, they are **not downloaded by default**. You can download them through the Conversational Search model selector when you need them. + + +### Using Local vs Cloud Models + +PiecesOS supports both cloud-based and local AI models for Conversational Search. + +Users who prefer on-device AI for speed, privacy, or offline access can download local models directly through PiecesOS. + +Supported cloud providers and example models include: + +- OpenAI: GPT-5.2 Pro, GPT-5.2, GPT-5.1, GPT-5 Thinking, GPT-5, GPT-5 Fast, o4 Mini, o3 Pro, o3 Mini, o3, o1, GPT-4.1, GPT-4o, GPT-4o Mini +- Anthropic: Claude 4.5 Opus, Claude 4.5 Sonnet, Claude 4.5 Haiku, Claude 4 Sonnet, Claude 3.7 Sonnet, Claude 3.5 Sonnet, Claude 3.5 Haiku +- Google: Gemini 3 Pro Preview, Gemini 3 Flash Preview, Gemini 2.5 Pro, Gemini 2.5 Flash, Gemini 2.5 Flash Lite, Gemini 2 Flash Lite + +[See the full Cloud Models list →](/products/large-language-models/cloud-models) + +*** + +| **Feature** | **Cloud AI (Default)** | **Local AI** | +| ------------------------ | ----------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ | +| **Processing Location** | Cloud-based (requires internet) | On-device (runs locally) | +| **Performance** | Dependent on internet speed | Potentially faster response times (no network latency) | +| **Data Privacy** | Data only sent to cloud if included as context in a Conversational Search chat—governed by provider privacy policies | 100% local (no data transmission from local device) | +| **Model Availability** | Uses several cloud-hosted models | Download models on-demand through PiecesOS | +| **Storage Requirements** | Minimal outside of the PiecesOS installation | Several GBs (model storage) | +| **Offline Support** | No | Yes | + +## Required Specifications + +Local models use more system resources than cloud-based AI. To run local LLMs smoothly, your device should meet the following minimum specifications. These guidelines are based on Ollama documentation and experience-tested public sources such as [LocalLLM.in's VRAM requirements guide](https://localllm.in/blog/ollama-vram-requirements-for-local-llms). + +### Minimum System Requirements + +| **Component** | **Minimum** | +| -------------------- | --------------------------------------------------------------------------- | +| **Operating System** | macOS 11.0 (Big Sur) or later, Windows 10 or later, or Ubuntu 18.04 or later | +| **RAM** | 8GB for 3B models; 16GB for 7B models; 32GB for 13B models | +| **CPU** | Modern CPU with at least 4 cores (8 cores recommended for 13B models) | +| **GPU (optional)** | 6GB+ VRAM recommended for faster inference | +| **Storage** | At least 12GB free for Ollama and base models; more for larger models | + +### VRAM Guidelines by Model Size + +If you use a dedicated GPU, the amount of VRAM you need depends on the model size and quantization. The following are general guidelines for running models at Q4_K_M quantization: + +| **VRAM** | **Typical model size** | +| ------------ | ----------------------------------------------- | +| **3–4 GB** | 3–4B parameter models (e.g., 4k context) | +| **6–8 GB** | 7–9B models (e.g., Llama 3.1 8B, Qwen3 8B) | +| **10–12 GB** | 12–14B models (e.g., Gemma 3 12B, Qwen3 14B) | +| **16–24 GB** | 22–35B models (e.g., Gemma 3 27B, Qwen3 32B) | +| **48 GB+** | 70B+ models (e.g., Llama 3.3 70B, Qwen2.5 72B) | + +Total VRAM usage includes model weights, KV cache (which grows with context length), and system overhead. For more precise requirements for a specific model, refer to [LocalLLM.in's Ollama VRAM requirements guide](https://localllm.in/blog/ollama-vram-requirements-for-local-llms). + +*** diff --git a/public/content/core-dependencies/local-models/download.md b/public/content/core-dependencies/local-models/download.md new file mode 100644 index 0000000..f70b8f7 --- /dev/null +++ b/public/content/core-dependencies/local-models/download.md @@ -0,0 +1,131 @@ +--- +title: Download Local Models +path: /core-dependencies/local-models/download +visibility: PUBLIC +status: PUBLISHED +description: Learn how to download and manage local models for on-device AI inference with Conversational Search. +metaTitle: Download Local Models | Pieces Docs +metaDescription: Learn how to download and manage local models for on-device AI inference with Conversational Search. +--- + +## Downloading Local Models + +Local models are an *optional* feature that enables local AI inference for Conversational Search and other AI-powered features in Pieces. + +If you prefer to run LLMs on-device instead of using cloud-based AI, you can download local models directly through PiecesOS. + +This guide will walk you through the download and verification process for local models across Windows, macOS, and Linux. + +## Downloading Through Conversational Search + +The easiest way to download and manage local models is directly from Conversational Search: + + + + Navigate to Conversational Search in the Pieces Desktop App. + + + + Click your active model button (e.g., `Gemini 3 Pro Preview`) in the bottom toolbar of the Conversational Search interface. + + + + > Clicking the active model button in Conversational Search to open the model dropdown + + + + Click `Manage Models` from the dropdown menu that appears. + + + + Scroll through the list of available models. You'll see all models organized by provider (OpenAI, Anthropic, Google, etc.), including both cloud and local models. + + + + 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 showing toggle switches to enable or disable models + + + + For local models you want but don't already have, click the `Download` button on the model card. Once the download completes, you can enable the model using its toggle switch. + + + +## Downloading Through IDE Plugins + +You can also download local models through any Pieces plugin or extension: + +1. Open Conversational Search in your IDE plugin. + +2. Click the **Active Model** or **Change Model** button. + +3. Click `Manage Models` to access the full model management interface. + +4. Browse the list of local models, download the ones you want, and enable them using the toggle switches. + + + Local models downloaded through any Pieces product are automatically available in all other Pieces products through PiecesOS. + + +## Managing Downloaded Models + +### Delete Local Models + +To free up storage space, you can delete downloaded local models directly from the model management interface: + + + + Navigate to Conversational Search in the Pieces Desktop App. + + + + Click your active model button (e.g., `Gemini 3 Pro Preview`) in the bottom toolbar of the Conversational Search interface. + + + + Click `Manage Models` from the dropdown menu that appears. + + + + Scroll or search through the list of available models to find the downloaded local model you want to delete. Downloaded models will have a trash icon visible on their model card. + + + + 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. + + + + > Model management interface showing a downloaded model with trash icon visible for deletion + + + +### Storage Requirements + +Local models typically require: + +* **Small models (2-4 GB)**: Suitable for quick queries and basic code generation +* **Medium models (4-6 GB)**: Balanced performance for most use cases +* **Large models (6-8+ GB)**: Best performance for complex queries and deep context + + + Ensure you have sufficient storage space before downloading large models. Each model is stored only once and shared across all Pieces products. + + +## Verify Local Model Integration + +Once downloaded, ensure PiecesOS can use your local models: + +1. Open the **Pieces Quick Menu** from your system tray or menu bar. + +2. Navigate to **ML Processing**. + +3. Downloaded models will appear under **Local AI Models**. + +If a model doesn't appear, try restarting PiecesOS through the Quick Menu. + +## Next Steps + +You can read documentation about what [local LLMs are currently available](/products/core-dependencies/local-models/supported-models) and supported by PiecesOS, or learn more about [using local vs cloud models](/products/core-dependencies/local-models#using-local-vs-cloud-models). diff --git a/public/content/core-dependencies/local-models/supported-models.md b/public/content/core-dependencies/local-models/supported-models.md new file mode 100644 index 0000000..3395f36 --- /dev/null +++ b/public/content/core-dependencies/local-models/supported-models.md @@ -0,0 +1,11 @@ +--- +title: Pieces-Compatible Local LLMs +path: /core-dependencies/local-models/supported-models +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. +--- + + diff --git a/public/content/core-dependencies/ollama.md b/public/content/core-dependencies/ollama.md index 21f57d4..062c2bd 100644 --- a/public/content/core-dependencies/ollama.md +++ b/public/content/core-dependencies/ollama.md @@ -1,7 +1,7 @@ --- title: Understanding Ollama path: /core-dependencies/ollama -visibility: PUBLIC +visibility: PRIVATE status: PUBLISHED description: Read about Ollama, an optional dependency which enables fully on-device generative AI capabilities between Pieces Drive and the Pieces Copilot. metaTitle: Ollama | Pieces Core Dependancies @@ -63,9 +63,9 @@ However, users who prefer on-device AI for speed, privacy, or offline access can Supported cloud providers and example models include: -- OpenAI: GPT-5, GPT-5 Mini, GPT-5 Nano, o4 Mini, o3 Pro, o3 Mini, o3, o1, GPT-4.1 -- Anthropic: Claude 4.1 Opus, Claude 4 Opus, Claude 4 Sonnet -- Google: Gemini 2.5 Pro, Gemini 2.5 Flash, Gemini 2.5-Flash-Lite +- OpenAI: GPT-5.2 Pro, GPT-5.2, GPT-5.1, GPT-5 Thinking, GPT-5, GPT-5 Fast, o4 Mini, o3 Pro, o3 Mini, o3, o1, GPT-4.1, GPT-4o, GPT-4o Mini +- Anthropic: Claude 4.5 Opus, Claude 4.5 Sonnet, Claude 4.5 Haiku, Claude 4 Sonnet, Claude 3.7 Sonnet, Claude 3.5 Sonnet, Claude 3.5 Haiku +- Google: Gemini 3 Pro Preview, Gemini 3 Flash Preview, Gemini 2.5 Pro, Gemini 2.5 Flash, Gemini 2.5 Flash Lite, Gemini 2 Flash Lite [See the full Cloud Models list →](/products/large-language-models/cloud-models) diff --git a/public/content/core-dependencies/ollama/manual-installation.md b/public/content/core-dependencies/ollama/manual-installation.md index 1ab3955..a887871 100644 --- a/public/content/core-dependencies/ollama/manual-installation.md +++ b/public/content/core-dependencies/ollama/manual-installation.md @@ -1,7 +1,7 @@ --- title: Ollama | Manual Installation path: /core-dependencies/ollama/manual-installation -visibility: PUBLIC +visibility: PRIVATE status: PUBLISHED description: Read documentation on manually installing Ollama outside of the Pieces Desktop App for use with PiecesOS. metaTitle: Ollama | Manual Installation diff --git a/public/content/core-dependencies/ollama/supported-models.md b/public/content/core-dependencies/ollama/supported-models.md index 597ff2e..18b94d9 100644 --- a/public/content/core-dependencies/ollama/supported-models.md +++ b/public/content/core-dependencies/ollama/supported-models.md @@ -1,9 +1,9 @@ --- title: Pieces-Compatible Local LLMs path: /core-dependencies/ollama/supported-models -visibility: PUBLIC +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. +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. --- diff --git a/public/content/core-dependencies/ollama/troubleshooting.md b/public/content/core-dependencies/ollama/troubleshooting.md index 90f40d6..2f75d0d 100644 --- a/public/content/core-dependencies/ollama/troubleshooting.md +++ b/public/content/core-dependencies/ollama/troubleshooting.md @@ -1,11 +1,11 @@ --- title: Ollama | Troubleshooting path: /core-dependencies/ollama/troubleshooting -visibility: PUBLIC +visibility: PRIVATE status: PUBLISHED -description: Read documentation on basic Ollama troubleshooting steps below if you’re experiencing connectivity issues between the Ollama client and PiecesOS. You can also find minimum and recommended device specifications for running local LLMs below. +description: Read documentation on basic Ollama troubleshooting steps below if you're experiencing connectivity issues between the Ollama client and PiecesOS. You can also find minimum and recommended device specifications for running local LLMs below. metaTitle: Troubleshooting Ollama -metaDescription: Read documentation on basic Ollama troubleshooting steps below if you’re experiencing connectivity issues between the Ollama client and PiecesOS. +metaDescription: Read documentation on basic Ollama troubleshooting steps below if you're experiencing connectivity issues between the Ollama client and PiecesOS. --- ## Initial Checks diff --git a/public/content/core-dependencies/on-device-storage.md b/public/content/core-dependencies/on-device-storage.md index f62d5b2..5b22a60 100644 --- a/public/content/core-dependencies/on-device-storage.md +++ b/public/content/core-dependencies/on-device-storage.md @@ -48,11 +48,20 @@ You are free to **copy, compress,** or **relocate** the entire `production` fold When you open a GitHub issue or contact **Pieces Support**, attaching the most recent logs helps us diagnose problems in *minutes* instead of *hours*. -| **Platform** | **Log Directory** | -| ------------ | --------------------------------------------------------------------- | -| *macOS* | `/Users//Library/com.pieces.os/production/support/logs/` | -| *Windows* | `C:/Users//Documents/com.pieces.os/production/support/logs` | -| *Linux* | `/home//.local/share/com.pieces.os/logs/` | +**macOS:** +``` +/Users//Library/com.pieces.os/production/support/logs/ +``` + +**Windows:** +``` +C:/Users//Documents/com.pieces.os/production/support/logs +``` + +**Linux:** +``` +/home//.local/share/com.pieces.os/logs/ +``` Logs rotate daily and are timestamped (`log-05062025`). diff --git a/public/content/core-dependencies/pieces-os.md b/public/content/core-dependencies/pieces-os.md index 82243bd..d84c726 100644 --- a/public/content/core-dependencies/pieces-os.md +++ b/public/content/core-dependencies/pieces-os.md @@ -3,9 +3,9 @@ title: Understanding PiecesOS path: /core-dependencies/pieces-os visibility: PUBLIC status: PUBLISHED -description: Read about PiecesOS, the foundational layer that supports the whole Pieces Suite, and the core functionalities—like LTM-2.7, Pieces Drive, and Pieces Copilot. +description: Read about PiecesOS, the foundational layer that supports the whole Pieces Suite, and the core functionalities—like LTM-2.7 and Timeline. metaTitle: Understanding PiecesOS | Pieces Docs -metaDescription: Read about PiecesOS, the foundational layer that supports the whole Pieces Suite, and the core functionalities—like LTM-2, Pieces Drive, and Pieces Copilot. +metaDescription: Read about PiecesOS, the foundational layer that supports the whole Pieces Suite, and the core functionalities—like LTM-2.7 and Timeline. ogImage: "https://storage.googleapis.com/hashnode_product_documentation_assets/og_images/core_dependencies/pieces_os.png" --- @@ -13,289 +13,147 @@ ogImage: "https://storage.googleapis.com/hashnode_product_documentation_assets/o PiecesOS is a background service that runs on your machine. It orchestrates local data processing and manages the house-made machine learning (ML) models used within Pieces software. - +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. -There are three core pillars of Pieces functionality powered by PiecesOS: [\[1\] LTM-2.7,](/products/core-dependencies/pieces-os#ltm-27) [\[2\] Pieces Drive,](/products/core-dependencies/pieces-os#pieces-drive) and [\[3\] Pieces Copilot.](/products/core-dependencies/pieces-os#pieces-copilot) + -These components make up the Pieces experience and are essential to the modern AI-powered workflow. +> PiecesOS powering core Pieces functionality ## The Role of PiecesOS -PiecesOS provides the intelligence and power behind Pieces software in two key ways: by (1) supplying the essential components of the Pieces infrastructure and supporting various processes, and (2) powering 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 standalone Pieces plugins and extensions when used without the Pieces Desktop App. -This ‘brain’ is required to enable the 3 fundamental features of the Pieces development experience. +This 'brain' is required to enable the fundamental features of the Pieces development experience. -### How Does PiecesOS Work? +> PiecesOS bridging all Pieces products and services -Powered by PiecesOS, the Long-Term Memory (LTM-2.7) Engine tracks your development and workflow context using the Pieces Drive, allowing you to import and export materials as needed. +### How PiecesOS Works -Then, with Pieces Copilot, you can use cloud-based or local LLMs through Ollama to start chats that include the context you need. +Powered by PiecesOS, the Long-Term Memory (LTM-2.7) Engine tracks your development and workflow context, allowing you to access your workflow history through the Timeline. -This way, all AI-powered elements work together to enhance your context and creativity, especially when you need a memory boost. +With [Conversational Search](/products/desktop/conversational-search), you can have conversations with your captured workflow context. All AI-powered elements work together to enhance your context and creativity. ## Fundamental Components -Using the Pieces Desktop App or a Pieces plugin or extension for your favorite IDE requires PiecesOS, as 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 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. ## LTM-2.7 -The **Long-Term Memory (LTM-2.7) Engine** is a powerful evolution of the original LTM system, designed to store and surface workflow context from up to **nine months** in the past. +The Long-Term Memory (LTM-2.7) Engine is a powerful evolution of the original LTM system, designed to store and surface workflow context from up to nine months in the past. + +By automatically capturing workflow context and providing flexible memory browsing, LTM-2.7 ensures you don't lose track of code, discussions, or references—even if you return to a project weeks or months later. These workflow events and summaries can be found within the [Timeline](/products/desktop/timeline) view in the [Pieces Desktop App](/products/desktop). - Here’s a quick read on some of the nano-models we develop that layer into the data retrieval pipeline for LTM-2.7. + Here's a quick read on some of the nano-models we develop that layer into the data retrieval pipeline for LTM-2.7. -By combining automatic roll-ups with flexible memories browsing, LTM-2.7 ensures you don't lose track of code, discussions, or references—even if you return to a project weeks or months later. - -These workflow summaries can be found within the [Workstream Activities](/products/desktop/workstream-activity) view in the [Pieces Desktop App](/products/desktop). - ### Deep Study -LTM-2.7 includes a powerful new Deep Study feature that provides comprehensive analysis of your recent workstream activities. You can access this advanced context analysis by asking Pieces Copilot questions like: - -*"Can you perform a deep study on what I've done for the last few days?"* +LTM-2.7 includes a powerful Deep Study feature that provides comprehensive analysis of your recent workstream activities. Deep Study goes beyond standard workflow summaries to provide detailed insights into your development patterns, project progress, and workstream activities. This feature analyzes your recent context more thoroughly than standard summaries, helping you understand your workflow trends and identify areas for optimization. -#### How it works in the UI (Pro) +#### Using Deep Study -- In any Pieces Copilot chat, click `Activate DeepStudy` (marked `PRO`) at the bottom of the chat to enable Deep Study for your next prompt. -- Deep Study reports typically take 10–20 minutes to generate. -- While running, progress indicators show a `Thinking` state and multiple cooperating agents. You can expand chevrons to view each agent’s intermediate steps. +Deep Study is built in by default for Pieces Pro users. In any [Conversational Search](/products/desktop/conversational-search) chat, use Deep Study by asking questions like "Can you perform a deep study on what I've done for the last few days?" -#### Model and runtime +Deep Study reports typically take 10–20 minutes to generate. While running, progress indicators show a `Thinking` state and multiple cooperating agents. You can expand chevrons to view each agent's intermediate steps. -- 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. +#### Model and Runtime -*** - -*Pieces Copilot with LTM-2.7 Context —* Pieces Desktop App +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 in action showing progress indicators and cooperating agents ### Grounded Assistance -Long-Term Memory is designed to boost developer productivity by providing assistance that’s temporally grounded within the concrete context of your actual workflow, allowing the Pieces Copilot to better understand your development process over time. - -This helps it offer more relevant and timely responses to queries, as it has a *local database* of information to work from. - -Since LTM has a local database of information to work from, it can offer **relevant, timely** responses to your queries: +Long-Term Memory is designed to boost developer productivity by providing assistance that's temporally grounded within the concrete context of your actual workflow. -* Recall details from older tasks or code reviews without requiring you to re-describe them. +This allows [Conversational Search](/products/desktop/conversational-search) to better understand your development process over time and offer more relevant and timely responses to queries, as it has a local database of information to work from. Since LTM has a local database of information to work from, it can offer relevant, timely responses to your queries: -* Understand ongoing projects more holistically, anticipate next steps, and offer suggestions aligned with your actual workflow. +* Recall details from older tasks or code reviews without requiring you to re-describe them +* Understand ongoing projects more holistically, anticipate next steps, and offer suggestions aligned with your actual workflow ### How Context is Captured -Under the hood, LTM monitors your workflow at the operating system level, capturing data from: - -* **IDEs** (e.g., changes, commits, open files) - -* **Browsers** (e.g., opened tabs, reference links) - -* **Collaboration tools** (e.g., messaging apps, file-sharing platforms) +Under the hood, LTM monitors your workflow at the operating system level, capturing data from IDEs (e.g., changes, commits, open files), browsers (e.g., opened tabs, reference links), and collaboration tools (e.g., messaging apps, file-sharing platforms). LTM (through PiecesOS) extends your ability to [enable or disable specific sources](/products/core-dependencies/pieces-os/quick-menu#quick-menu-actions) for data capture—this way, you can decide exactly what gets tracked and stored, providing flexibility if you have sensitive or personal workflows. - The data captured by LTM is processed and stored entirely on your device, so you don’t need to worry about privacy and security—[which you can read more about here.](/products/privacy-security-your-data) + The data captured by LTM is processed and stored entirely on your device, so you don't need to worry about privacy and security—[which you can read more about here.](/products/privacy-security-your-data) ### Less Context Switching -Traditionally, AI tools require you to restate your environment—what project you’re working on, the code you just wrote, or the documentation you’ve referenced. - -However, with LTM-2.7’s temporal grounding, you have: - -* **Reduced Manual Input**: No more duplicating the same context or re-pasting large code blocks. - -* **Enhanced Continuity**: Your interactions flow seamlessly from one coding session to the next, letting you pick up exactly where you left off. +Traditionally, AI tools require you to restate your environment—what project you're working on, the code you just wrote, or the documentation you've referenced. -* **Intuitive Interactions**: Ask questions like “What was I working on with John last week?” or “How do I fix that same CocoaPods issue from last Tuesday?” - -Pieces Copilot can reference stored LTM data to give you real-time, **context-aware** answers. +However, with LTM-2.7's temporal grounding, you have reduced manual input, enhanced continuity, and intuitive interactions. [Conversational Search](/products/desktop/conversational-search) can reference stored LTM data to give you real-time, context-aware answers. ### Use Cases -Learn [how to use Pieces Long-Term Memory](/products/quick-guides/ltm-context) to capture information from your browser and retrieve it later with a simple prompt to the Pieces Copilot: - -1. **Capture Website Content for Later Reference:** Automatically store information from webpages or browser tabs you’re viewing, without needing to copy-paste anything. - -2. **Recall Important Details with a Single Prompt:** [Ask the Pieces Copilot to retrieve content it previously saw](/products/quick-guides/copilot-with-context#prompt-pieces-copilot)—like secret messages, documentation, or key details from web apps. - -3. **Track and Summarize Research Across Multiple Sites:** Let Pieces Long-Term Memory log what you’ve read across different websites and use that context to generate summaries or next steps. - -4. **Simplify Context Sharing with Teammates:** Capture context once, then have the Pieces Copilot summarize it or export it for others—great for asynchronous collaboration or hand-offs. +Learn [how to use Pieces Long-Term Memory](/products/quick-guides/ltm-context) to capture information from your browser and retrieve it later with [Conversational Search](/products/desktop/conversational-search): -5. **Bridge Gaps Between Tools:** Pull in information from any browser-based tool or document viewer, and make it accessible directly inside Pieces Copilot chats. +* **Capture Website Content for Later Reference** - Automatically store information from webpages or browser tabs you're viewing, without needing to copy-paste anything +* **Recall Important Details with a Single Prompt** - [Ask Conversational Search to retrieve content it previously saw](/products/quick-guides/copilot-with-context#prompt-pieces-copilot)—like secret messages, documentation, or key details from web apps +* **Track and Summarize Research Across Multiple Sites** - Let Pieces Long-Term Memory log what you've read across different websites and use that context to generate summaries or next steps +* **Simplify Context Sharing with Teammates** - Capture context once, then have Conversational Search summarize it or export it for others—great for asynchronous collaboration or hand-offs +* **Bridge Gaps Between Tools** - Pull in information from any browser-based tool or document viewer, and make it accessible directly inside Conversational Search chats - Here’s another use case for you—try combining the power of Pieces Long-Term Memory with Model Context Protocol (MCP) servers with the brand new [Pieces MCP.](/products/mcp/get-started) + Here's another use case for you—try combining the power of Pieces Long-Term Memory with Model Context Protocol (MCP) servers with the brand new [Pieces MCP.](/products/mcp/get-started) ## MCP Support -The Model Context Protocol (MCP) is an open framework that lets Large Language Models (LLMs) access relevant data from your device. - -Created by Anthropic, MCP removes the need for custom integrations by enabling tools like Claude, ChatGPT, GitHub Copilot, and Cursor to request and receive detailed, structured context. +The Model Context Protocol (MCP) is an open framework that lets Large Language Models (LLMs) access relevant data from your device. Created by Anthropic, MCP removes the need for custom integrations by enabling tools like Claude, ChatGPT, GitHub Copilot, and Cursor to request and receive detailed, structured context. [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 —> Cursor* - -*** - -## Workstream Activity +> Pieces MCP integration with Cursor showing context-aware documentation changes -In the [Pieces Desktop App](/products/desktop), the 2nd-generation LTM comes with an incredibly powerful feature called [Workstream Activity](/products/desktop/workstream-activity). +## Timeline -The Workstream Activity view is a dedicated interface in the Pieces Desktop App that provides a continuous snapshot of your recent tasks, discussions, and code or document reviews, captured by the **Long-Term Memory (LTM-2.7)** **Engine.** +In the [Pieces Desktop App](/products/desktop), the 2nd-generation LTM comes with an incredibly powerful feature called [Timeline](/products/desktop/timeline). The Timeline view is a dedicated interface in the Pieces Desktop App that provides a continuous snapshot of your recent tasks, discussions, and code or document reviews, captured by the Long-Term Memory (LTM-2.7) Engine. -Every 20 minutes, LTM generates a *roll-up* that summarizes your workflow context for that period, highlighting details such as major tasks, key decisions, and follow-up actions. +LTM continuously captures workflow context as you work, creating timeline events that summarize your activities, highlighting details such as major tasks, key decisions, and follow-up actions. -*** - -*Reviewing a LTM Roll-up —* Pieces Desktop App - - - -*** +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. -In addition to offering a timeline of roll-ups, the Workstream Activity view [lets you search for keywords, open references or links, and even launch Pieces Copilot Chats](/products/desktop/workstream-activity#interacting-with-roll-ups) directly from a summarized entry. + -By surfacing relevant data right when you need it, the Workstream Activity feature [eliminates the frustration of recounting your background](/products/quick-guides/ltm-prompting/workstream-activity) or re-pasting massive prompts every time you want AI assistance—empowering you to focus on high-value work instead. +> Exploring timeline events in the Timeline view ### Use Cases -Explore real-world scenarios that highlight how Workstream Activities can make collaboration easy, enhance product documentation, and simplify project context sharing: +Explore real-world scenarios that highlight how Timeline can make collaboration easy, enhance product documentation, and simplify project context sharing: -1. **Capture and Share Project Contexts:** Filter activities by project keyword to create a history of actions and conversations. Share as text, markdown, or use Pieces Copilot for a summary. - -2. **Generate Documentation from Workflow:** Use Workstream Activity Rollups to log your process and export a searchable summary with links and context. - -3. **Build Standup Reports or PR Summaries:** Log ticket reviews, create an activity with links and context, and use Copilot to summarize it for updates. - -4. **Collaborate Asynchronously with Markdown Snapshots:** Export activities as markdown for teammates to load into their Pieces Copilot with full context. - -5. **Use Filtered Snapshots in Copilot Chats:** Filter activities by keyword or task and inject them into a chat for insights and documentation help. +* **Capture and Share Project Contexts** - Filter activities by project keyword to create a history of actions and conversations. Share as text, markdown, or use Conversational Search for a summary +* **Generate Documentation from Workflow** - Use Timeline events to log your process and export a searchable summary with links and context +* **Build Standup Reports or PR Summaries** - Log ticket reviews, create an activity with links and context, and use Conversational Search to summarize it for updates +* **Collaborate Asynchronously with Markdown Snapshots** - Export activities as markdown for teammates to load into their Conversational Search with full context +* **Use Filtered Snapshots in Conversational Search** - Filter activities by keyword or task and inject them into a chat for insights and documentation help - This means you can revisit precisely what you worked on in the past, even if you step away from a project for *weeks* or *months.* - - Check out some of the [additional use cases for the Workstream Activity view.](/products/quick-guides/ltm-prompting/workstream-activity) + This means you can revisit precisely what you worked on in the past, even if you step away from a project for weeks or months. Check out some of the [additional use cases for the Timeline view.](/products/quick-guides/ltm-prompting/workstream-activity) ### On-Device Data Storage -All data captured by the LTM is stored locally on your device. It never leaves your device or becomes accessible to anyone, including the Pieces team, unless you choose to share it. +All data captured by LTM is stored locally on your device. It never leaves your device or becomes accessible to anyone, including the Pieces team, unless you choose to share it. LTM applies on-device machine learning algorithms to filter out sensitive information and secrets, maintaining high levels of performance, security, and privacy. -For advanced components that require blended processing, user preferences can be set to leverage a cloud-powered Large Language Model as the Copilot’s runtime.  - ## Pieces Drive -Pieces Drive is an intelligent and interactive material manager baked into PiecesOS that allows you to save, manage, and share important developer resources such as notes, useful code snippets, links, and more within your personal local repository. - -You can view, edit, reuse, and share these materials via Pieces Shareable Links from this repository.  - -*** - -*Viewing Saved Materials with Pieces Drive —* Pieces Desktop App - - +Pieces Drive is a legacy material manager that allows you to save, manage, and share developer resources. This feature will be merged with Timeline in a future update. *** -### Multi-Tool Integration - -With PiecesOS, you can use Pieces Drive in tools like [Obsidian](/products/obsidian) and [Raycast](/products/raycast), as well as your favorite code editors, such as IntelliJ, Visual Studio Code, and Sublime Text. - -You can also view and adjust metadata saved with your materials in the Applet View of Pieces plugins or the Pieces Desktop App. - -### AI-Powered Enrichment - -When you save code or other useful materials to Pieces Drive, AI automatically enriches them with a wide variety of useful metadata. - -The enrichment process, powered by on-device ML models, provides: - -* annotations - -* anchors - -* shareable links - -* related links - -* related people - -* suggested searches - -* tags - -* sensitive information - -* date created - -* source of origin - - - Pieces will also identify and flag any sensitive information, like API keys or personal data, and flag this information under **Sensitive Information.** - - -## Pieces Copilot - -Like Pieces Drive, Pieces Copilot can be found nested within Pieces plugins and extensions or the Pieces Desktop App. - -It can generate code, answer questions, add code documentation, and serve as the bridge between you and your workflow context, as captured by the LTM-2.7. - -*** - -*Pieces Copilot for Code Generation —* Pieces Desktop App - - - -*** - -### Introducing Context to Chats - -If you encounter a scenario where you need to recall a specific URL to a Firestore database that was used during a live demo with another coworker, you can use Pieces Copilot (with LTM enabled) to recall that *exact link.* - -#### Supported Cloud Models - -Pieces Copilot supports leading cloud providers and models, including: - -- OpenAI: GPT-5, GPT-5 Mini, GPT-5 Nano, o4 Mini, o3 Pro, o3 Mini, o3, o1, GPT-4.1 -- Anthropic: Claude 4.1 Opus, Claude 4 Opus, Claude 4 Sonnet -- Google: Gemini 2.5 Pro, Gemini 2.5 Flash, Gemini 2.5-Flash-Lite - -[Browse the full Cloud Models catalog →](/products/large-language-models/cloud-models) - -### Understanding Code - -Pieces Copilot helps you comprehend complex code snippets by providing explanations, detailing how specific functions work, and suggesting alternative implementations for that code. - -Try asking it alternative ways to handle logging, or more robust methods of error handling—give it an entire file, an entire *project,* or just a function. - -### Code Generation - -By specifying your requirements for a function or script, Pieces Copilot can generate code that seamlessly fits into your active file. - -Use Pieces Copilot and Pieces Drive together to generate boilerplate code or adjust a function. Then, save it to the Pieces Drive with enriched metadata for future use, saving time. - -### Error Handling - -Debugging, checking logs, and handling errors are often the toughest parts of coding. But with Pieces Copilot, you can debug code thoroughly using the Pieces Desktop App or your preferred plugin. - -Context-based debugging is powerful because generative AI, whether cloud-based or local, can understand code semantics beyond what's visible and within the project's scope to find solutions and fixes. - -You might even be able to finally center that `div`—seriously, we’ve actually done it. +If PiecesOS isn't what you're looking for, check out the [Pieces Desktop App](/products/desktop) to see how these components work together, or explore [Conversational Search](/products/desktop/conversational-search) to learn how to talk with your memories. diff --git a/public/content/core-dependencies/pieces-os/quick-menu.md b/public/content/core-dependencies/pieces-os/quick-menu.md index 00b2a77..58d82dd 100644 --- a/public/content/core-dependencies/pieces-os/quick-menu.md +++ b/public/content/core-dependencies/pieces-os/quick-menu.md @@ -31,14 +31,13 @@ There are several views and buttons you can click to expand or enter in the Piec | *Long-Term Memory Engine* | Enable or disable LTM. | | *Long-Term Memory Access Control* | Enable or disable sources from which LTM captures contextual workflow data. | | *Settings* | Adjust settings like launch on login, enabled Pieces products, ML processing configurations, telemetry permissions, or optimize RAM usage. | -| *Activity* | View recent LTM activity, like most recent Copilot Chats, people, and related websites. | | *Resources* | Find links to documentation and Pieces social accounts. | *** *PiecesOS Quick Menu on macOS* - + The PiecesOS Quick Menu shares the same user interface (UI) as the Quick Menu on Windows. @@ -58,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. - + ### Checking for Updates @@ -68,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. - + ## LTM-2.7 Engine @@ -82,12 +81,10 @@ 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. - + 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. - - ### Long-Term Memory Access Control This section allows you to manage which applications and sources LTM captures data from through two menus: @@ -98,15 +95,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. - - -2. **Disabled Sources** - -Apps or sources that LTM is blocked from accessing appear here. - -Click the `Add` button to open a Finder (macOS) or Folder (Windows) window, where you can manually select additional applications to allow memory capture. - - + ## MCP Menu @@ -114,7 +103,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. - + ## Settings @@ -124,7 +113,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. - + ### Launch on Login @@ -150,18 +139,6 @@ You can also make changes to the enrichment to level and type to individual appl -### Activity - -The `Activity` menu provides a log of recent actions and interactions within PiecesOS, such as: - -1. **Most Recent Copilot Chat:** Displays the last Copilot conversation timestamp. - -2. **Most Recent People:** Lists recognized people based on saved materials and shared code. - - **Most Recent Websites:** Shows the last visited web pages that PiecesOS captured. Each website is listed with a clickable URL - - - ### Resources The `Resources` provides quick access to documentation, support, and community links: diff --git a/public/content/core-dependencies/pieces-os/troubleshooting.md b/public/content/core-dependencies/pieces-os/troubleshooting.md index 3a3424b..91b28b9 100644 --- a/public/content/core-dependencies/pieces-os/troubleshooting.md +++ b/public/content/core-dependencies/pieces-os/troubleshooting.md @@ -96,7 +96,7 @@ Many issues can stem from out-of-date plugins, extensions, or PiecesOS itself. 3. Check for and install available updates - + diff --git a/public/content/desktop.md b/public/content/desktop.md index 01ef419..604f2ce 100644 --- a/public/content/desktop.md +++ b/public/content/desktop.md @@ -10,16 +10,14 @@ metaDescription: Boost productivity with the Pieces Desktop App – AI-powered t -*** +> Pieces Desktop App logos and branding ## Meet the Pieces Desktop App -The **Pieces Desktop Application** contains a suite of AI-powered tools designed to improve productivity by utilizing your workflow context and enabling you to make intelligent decisions on a day-to-day basis with generative AI. +The Pieces Desktop Application contains a suite of AI-powered tools designed to improve productivity by utilizing your workflow context and enabling you to make intelligent decisions on a day-to-day basis with Pieces Long-Term Memory. Powered by [PiecesOS](/products/core-dependencies/pieces-os)—the heart and soul of Pieces—the Pieces Desktop app is the ultimate assistant for code, context, and creativity. -Let’s dive in! - Follow these instructions to download and install the Pieces Desktop Application for [macOS](/products/meet-pieces/macos-installation-guide), [Windows](/products/meet-pieces/windows-installation-guide), or [Linux](/products/meet-pieces/linux-installation-guide). @@ -32,86 +30,78 @@ Let’s dive in! -## Using the Desktop App +## Overview -The Pieces Desktop app is designed to act as a *hub* for the three main features of the Pieces Suite, some of which can be found within Pieces extensions and plugins and PiecesOS—the **LTM-2.7 Engine, Pieces Copilot, and Pieces Drive.** +The Pieces Desktop app is designed to act as a hub for the Pieces Suite, powered by PiecesOS and the [Long-Term Memory (LTM-2.7)](/products/core-dependencies/pieces-os#ltm-27) Engine. -With the Pieces Desktop App, you have access to dedicated views for the context captured by Long-Term Memory and the Workstream Activity feature, Pieces Copilot, and Pieces Drive. +With the Pieces Desktop App, you have access to dedicated views for the context captured by Long-Term Memory through [Pieces Timeline](/products/desktop/timeline). -If you know what you’re after, jump to our [documentation on the different navigation views.](/products/desktop/navigation) +## Pieces Timeline -## Core Features +Keep track of your workflow so you can access stored context from yesterday, last week, or even last month—whenever you need it. The [Long-Term Memory (LTM-2.7)](/products/core-dependencies/pieces-os#ltm-27) Engine ensures that nothing slips through the cracks. -There are three core components of Pieces that are intelligently integrated to minimize context switching and improve productivity in your daily workflow. +[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. -### LTM & Workstream Activity + -Keep track of your workflow so you can access stored context from yesterday, last week, or even *last month*—whenever you need it. +> Pieces Timeline showing workflow events, summaries, and activity graph visualization -Imagine what you could do if you could always recall past solutions, find specific links that were lost to your browser history, or remember what so-and-so said in that one Slack channel about that new staging release? + + Explore Pieces Timeline features including filtering events, managing event actions, and understanding timeline contents. + -[The Long-Term Memory (LTM-2.7) ](/products/core-dependencies/pieces-os#ltm-27)engine ensures that *nothing* slips through the cracks. +## Single-Click Summaries -The new, incredibly powerful [Workstream Activity](/products/desktop/workstream-activity) feature provides a sleek UI for interacting with saved data from up to **9 months ago** in an easily digestible *LTM Roll-Up* format, allowing you to start conversations with that context or copy and download it. +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. - + - - Read our [documentation on the new Long-Term Memory (LTM-2.7) Engine](/products/core-dependencies/pieces-os#ltm-27) for more information on what it is and how it works. - - -### MCP Support - -The Pieces suite, powered by the LTM-2.7 Engine through PiecesOS, also provides support for [Model Context Protocol (MCP) servers](/products/mcp/get-started) through Server-Sent Events (SSEs). +> Showing Pieces with Timeline open and Single-Click Summaries Generating -With the Pieces MCP, you can thread rich workflow context stored in the Pieces Drive through to [Cursor](/products/mcp/cursor), [GitHub Copilot](/products/mcp/github-copilot), [Goose](/products/mcp/goose), and other IDEs and productivity tools, making Pieces a *platform* for using long-term context in other workflows outside of just the Pieces Desktop App. + + Discover all available summary types and learn how to generate, view, and manage your summaries. + - - To integrate the Pieces MCP into one of the available integrations, copy the SSE endpoint URL and/or `.json` schema into your IDE of choice. +## Conversational Search - You can find the MCP URL inside the **Model Context Protocol (MCP)** tab within **Settings**. - +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. -*** + -*Pieces MCP → Cursor* +> Conversational Search interface showing chat interface and suggested prompts - + + Learn how to use Conversational Search, integrate context, and chat with timeline events. + -*** +## Configuration -### Pieces Copilot +Customize your Pieces Desktop App experience through *Settings*, which includes options for Account (with Personal Cloud and Telemetry), Long-Term Memory, Models, Copilot Chats, Machine Learning, Model Context Protocol (MCP), Connected Applications, Views & Layouts, Appearance, and Troubleshooting. -Engage with generative AI using cloud-hosted or local-only LLMs to solve challenges, generate new code, debug tricky issues, or get a second pair of eyes on some complex logic—all with real-time, context-aware assistance. + + Explore all configuration options to customize your Pieces Desktop experience. + -The [Pieces Copilot](/products/desktop/copilot) offers optional integration with Long-Term Memory, so you can ask it about previous GitHub commits, request help refactoring your code based on a discussion with a coworker from the other day, and more. +## Model Context Protocol (MCP) Support - - -### Pieces Drive - -Transform the way you manage your code snippets, documentation, and creative ideas with [Pieces Drive.](/products/desktop/drive) - -Save and organize your materials in one place, then watch as AI-enriched metadata brings context to every snippet—whatever the objective, Pieces Drive makes it simple to find exactly what you need. - - - -## Troubleshooting +The Pieces suite, powered by the LTM-2.7 Engine through PiecesOS, also provides support for [Model Context Protocol (MCP) servers](/products/mcp/get-started) through Server-Sent Events (SSEs). -Designed for three different operating systems, the Pieces Desktop Application has [in-depth troubleshooting documentation](/products/desktop/troubleshooting) for cross-platform issues and OS-specific issues. +With the Pieces MCP, you can thread rich workflow context through to [Cursor](/products/mcp/cursor), [GitHub Copilot](/products/mcp/github-copilot), [Goose](/products/mcp/goose), and other IDEs and productivity tools, making Pieces a platform for using long-term context in other workflows outside of just the Pieces Desktop App. -## Support + + To integrate the Pieces MCP into one of the available integrations, copy the SSE endpoint URL and/or `.json` schema into your IDE of choice. -If you're running into an issue during the installation process or while using the Pieces Desktop app, check out our support page for resources, helpful links, and an option to reach out directly to our team members. + You can find the MCP URL inside the *Model Context Protocol (MCP)* tab within *Settings*. + -## Get Started with Pieces +*** -Ready to install the Pieces Desktop Application? Let’s get you on your way. +*Pieces MCP → Cursor* -Click one of the links below to be redirected to your platform-specific (OS) download and installation *Quickstart* page: + -* [macOS](/products/meet-pieces/macos-installation-guide) +> Pieces MCP integration with Cursor showing workflow context threading -* [Windows](/products/meet-pieces/windows-installation-guide) +*** -* [Linux](/products/meet-pieces/linux-installation-guide) +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. diff --git a/public/content/desktop/actions/power-menu.md b/public/content/desktop/actions/power-menu.md index f299786..972f3df 100644 --- a/public/content/desktop/actions/power-menu.md +++ b/public/content/desktop/actions/power-menu.md @@ -22,7 +22,7 @@ For example: * **Pieces Drive View:** You’ll see commands related to creating, editing, or managing snippets (e.g., “Create New Material,” “Optimize Snippet,” etc.). -* **Pieces Copilot View:** You’ll see commands focused on AI-driven interactions (e.g., “Ask Copilot,” “Analyze this Snippet,” etc.). +* **Conversational Search View:** You'll see commands focused on AI-driven interactions (e.g., "Ask Conversational Search," "Analyze this Snippet," etc.). * **Application & Cloud / Global Context:** Some commands (e.g., “Check for Updates,” “Manage Accounts & Cloud Integrations,” “Go to Settings”) appear in multiple views or from a global context. @@ -30,24 +30,24 @@ For example: If you search for a command in the Power Menu and you’re *not* in the view where that command is valid, **it will not appear** in your search results. -### Pieces Copilot +### Conversational Search -You can find lots of saved material and generative AI-focused actions when accessing the Power Menu from the Pieces Copilot view. +You can find lots of saved material and generative AI-focused actions when accessing the Power Menu from the Conversational Search view. *** | **Command** | **Description** | | ------------------------------------------- | ------------------------------------------------------------------------------- | -| *Manage General Copilot Settings* | Takes you to the Pieces Copilot settings page. | -| *Manage Copilot LLM Runtime Configuration* | Opens a modal for changing cloud and local LLMs. | -| *Enter Focused Copilot* | Collapses the sidebar and enters Focus Mode. | -| *Launch Copilot in Browser* | Launches an instance of the Pieces Desktop App UI in your browser. | -| *New Copilot Conversation with LTM Context* | Starts a new Pieces Copilot Chat with LTM enabled. | -| *New General Copilot Conversation* | Starts a new Pieces Copilot Chat without additional prompting pipelines. | -| *New Contextual Copilot Conversation* | Starts a new Pieces Copilot Chat with context. | -| *New Copilot Conversation* | Starts a new Pieces Copilot Chat that defaults to the set LTM behavior. | -| *New Generative Copilot Conversation* | Starts a new Pieces Copilot Chat with a code-generating prompt pipeline preset. | -| *Delete All Copilot Chats* | Deletes all Pieces Copilot chats. | +| *Manage General Conversational Search Settings* | Takes you to the Conversational Search settings page. | +| *Manage Conversational Search LLM Runtime Configuration* | Opens a modal for changing cloud and local LLMs. | +| *Enter Focused Conversational Search* | Collapses the sidebar and enters Focus Mode. | +| *Launch Conversational Search in Browser* | Launches an instance of the Pieces Desktop App UI in your browser. | +| *New Conversational Search Conversation with LTM Context* | Starts a new Conversational Search with LTM enabled. | +| *New General Conversational Search Conversation* | Starts a new Conversational Search without additional prompting pipelines. | +| *New Contextual Conversational Search Conversation* | Starts a new Conversational Search with context. | +| *New Conversational Search Conversation* | Starts a new Conversational Search that defaults to the set LTM behavior. | +| *New Generative Conversational Search Conversation* | Starts a new Conversational Search with a code-generating prompt pipeline preset. | +| *Delete All Conversational Search Conversations* | Deletes all Conversational Search conversations. | *** @@ -120,12 +120,12 @@ These commands help you traverse the Pieces interface, letting you access differ | **Command** | **Description** | | -------------------------------- | --------------------------------------------------------------------- | -| *Go to Workstream Activity* | Open the workstream activities overview to see recent tasks. | +| *Go to Timeline* | Open Timeline to view workflow summaries and captured context. | | *Go to Updates & Upcoming* | Check upcoming features, announcements, or patch notes. | | *Go to Global Search* | Access the global search interface for snippets and materials. | | *Go to Settings* | Open the main settings panel for Pieces. | | *Go Back* | Return to the previous screen or menu. | -| *Go to Pieces Copilot* | Launch or navigate to the AI-assisted Copilot interface. | +| *Go to Conversational Search* | Launch or navigate to the AI-assisted Conversational Search interface. | | *Go Home* | Navigate to the main dashboard or home screen. | | *Go to VS Code Plugin* | Redirect to the Visual Studio Code integration. | | *Go to Visual Studio Plugin* | Redirect to the Visual Studio integration. | diff --git a/public/content/desktop/configuration.md b/public/content/desktop/configuration.md index 3b0d14e..82f71c8 100644 --- a/public/content/desktop/configuration.md +++ b/public/content/desktop/configuration.md @@ -3,129 +3,130 @@ title: Configuration path: /desktop/configuration visibility: PUBLIC status: PUBLISHED -description: In the Pieces Desktop App, you can customize everything from visuals and aesthetics to Pieces Drive enrichment and Pieces Copilot models to fit your preferences and workflow. +description: In the Pieces Desktop App, you can customize everything from visuals and aesthetics to Pieces Timeline enrichment and Conversational Search models to fit your preferences and workflow. metaTitle: Configuring Pieces Desktop Application -metaDescription: Customize Pieces with settings for visuals, Pieces Drive enrichment, and Copilot models to optimize your workflow. +metaDescription: Customize Pieces with settings for visuals, Pieces Timeline enrichment, and Conversational Search models to optimize your workflow. --- ## Accessing Settings -There are several ways to open up **Settings** in the Pieces Desktop App, where you can adjust account and cloud behaviors, check your application versions, change views and layouts, and more. +Open Settings from the home view to adjust account and cloud behaviors, check your application versions, change views and layouts, and more. -You can access **Settings** by clicking the profile picture icon in the upper-right and clicking `All Settings`. - - + + + Click your profile picture in the top left of the home view. - - You may also click the *Settings Gear* icon in the bottom-left corner to open the **Settings** view. - + + -You can also open up the **Power Menu** and search for *“settings”,* then click `Go to Settings` using the shortcuts in the table below: + + Hover over `Settings` in the dropdown menu that appears. + -| **macOS** | **Windows** | **Linux** | -| ---------- | ------------ | ------------ | -| `⌘+return` | `ctrl+enter` | `ctrl+enter` | + + You can either select one of the quick options (Account, Long-Term Memory, Models, MCP, Appearance, Troubleshooting) to jump directly to that category, or select `All` at the top of the quick options to open the full Settings view with all categories. You can also select `Log Out` at the bottom of the menu to sign out of your account. + -### Account & Cloud + + The Settings view is organized into a two-column layout: -The [Account & Cloud](/products/desktop/configuration/account-and-cloud) section manages your Pieces account, cloud services, and backups. This ensures a seamless connection across devices and helps keep your data secure. + * **Left sidebar**: Lists all settings categories + * **Right content area**: Displays the settings for the selected category + - - - Connect and sync with Pieces Cloud for *real-time access* across multiple devices, or monitor your connection status and manage sync preferences. + + Scroll through the sidebar to browse categories or scroll through the content area to see all options within a category. - - Automatically backup your snippets, files, and projects or restore previous versions in case of data loss. + + Clicking a category in the left sidebar filters the right content area to show only that category's settings. Click `All` in the sidebar to see all settings at once. - +## Account -### Pieces Copilot & Machine Learning +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. -These [Pieces Copilot and Pieces Drive](/products/desktop/configuration/copilot-and-machine-learning) configuration sections let you adjust default behaviors related to metadata, LTM context, models, and local model processing. + - - - Change models, reset the active runtime if facing issues, and use Long-Term Memory (LTM) context by default, and more. - +> Account settings showing profile information, linked accounts, organizations, subscriptions, personal cloud, and privacy settings - - Adjust the level of auto-enrichment performed locally when Pieces Drive generates and assigns metadata to saved materials. - - + + Learn how to manage your account, view linked services, configure personal cloud synchronization, manage subscriptions, and configure privacy settings. + - +### Organizations & Teams -### Model Content Protocol (MCP) +Create and manage organizations and teams to collaborate with others, share resources, and maintain consistent settings across your team in Pieces. -From this view, you can access the [*HTTP Server URL* for the Pieces MCP.](/products/desktop/configuration/mcp) This allows you to set up productivity tools and code editors that support this protocol with context directly from your local Pieces database. + -You'll also find a *Book* icon that links you to documentation on getting started with the Pieces MCP and information about available integrations. +> Account settings page showing Organizations & Teams section with organization list and management options - + + Learn how to create organizations, invite team members, manage team settings, and collaborate effectively with your team. + -### Aesthetics & Layouts +## Long-Term Memory -The [Aesthetics & Layouts](/products/desktop/configuration/aesthetics-layout) section allows you to customize the visual appearance of the Pieces Desktop App, including dark and light modes, UI scaling, accent color, and more. +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. -You can also set the default UI of different views and adjust default sorting and listing methods for displaying snippets & summaries + - - - Adjust auto-switch settings based on system preferences. - +> Long-Term Memory settings showing Memory Formation, Performance, and Stored Data sections - - Select from various colors to adjust Pieces Copilot chat accents and other visual elements. - + + Configure the Long-Term Memory Engine, manage app access control, system permissions, and optimize performance. + - - Increase or decrease font size and UI size for different screen resolutions. - +## Models - - Set the default view to Pieces Copilot or Pieces Drive, default search mode, and default gallery & list views. - +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. - - Choose between *Blended, Full-Text, Neural Code Search,* or *Search-with-Material* as the default search mode for the **Search Bar.** - - + - +> Models settings showing Model Capabilities, Local Model Runtime, and Model Management sections -### Additional Settings + + Configure processing modes, set up Ollama for local models, and enable or disable specific AI models. + -The [Additional Settings](/products/desktop/configuration/additional-settings) section contains advanced configurations that allow you to fine-tune Pieces to suit your workflow. +## Model Context Protocol (MCP) - - - Enable or disable anonymous usage data collection and manage crash reporting and performance monitoring. - +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. - - Customize which in-app alerts you receive and the frequency of notification pop-up modals. - + - - View the default shortcuts for Pieces Desktop App functionality specific to your device’s operating system (OS). - - +> MCP settings showing server URLs and documentation options + + + Learn how to configure the Pieces MCP and integrate it with Cursor, GitHub Copilot, Goose, and other tools. + + +## Appearance + +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 showing Theming, Fonts, and Spacing sections - + + Switch between themes, customize accent colors, adjust font size and weight, and configure visual density. + -### Support & Information +## Troubleshooting -Whenever you access the **Settings** view and click on a specific section—i.e., *Machine Learning, Telemetry,* or *Copilot Chats*—three smaller Support & Information sections are appended to the end of the focused settings view. +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. -These always-available sections are: + -1. **Support**: Contains links to documentation, submitting feedback or reporting issues, and all keyboard shortcuts. +> Troubleshooting settings showing Online Resources, Get In Touch, PiecesOS Information, and Desktop App Information sections -2. **Desktop App Information**: This section lists the Pieces Desktop App version, lets you check for updates, launches onboarding, and provides your platform information. + + Access support resources, view version information, check for updates, and contact the Pieces team. + -3. **PiecesOS Information**: This page lists your PiecesOS version, lets you check for updates, and lists the active PiecesOS port. +*** - \ No newline at end of file +If Configuration isn't what you're looking for, check out [Conversational Search](/products/desktop/conversational-search) to learn about asking questions about your workflow, or explore the [Timeline](/products/desktop/timeline) to see how Pieces [creates](/products/desktop/single-click-summaries) and [stores memories](/products/desktop/timeline/timeline-events). diff --git a/public/content/desktop/configuration/_deprecated_/about.md b/public/content/desktop/configuration/_deprecated_/about.md new file mode 100644 index 0000000..f9d166b --- /dev/null +++ b/public/content/desktop/configuration/_deprecated_/about.md @@ -0,0 +1,143 @@ +--- +title: About Pieces +path: /desktop/configuration/about +visibility: PUBLIC +status: PUBLISHED +description: View version information, system details, and update options for PiecesOS and the Pieces Desktop App. +metaTitle: About Pieces Desktop Application +metaDescription: View version information, system details, and update options for PiecesOS and the Pieces Desktop App. +--- + +*** + +## About Pieces + +View version information, system details, and update options for PiecesOS and the Pieces Desktop App. Check installed versions, manually check for updates, and view platform information. + +To access About Pieces settings, click your `User Profile` in the top left, then hover over `Settings` and select `About Pieces`. + + + +> About Pieces settings showing PiecesOS Information and Desktop App Information sections + +## PiecesOS Information + +View information about your installed PiecesOS version, check for updates, and see what port PiecesOS is using. PiecesOS is the core engine that powers all Pieces functionality. + +### Viewing PiecesOS Version + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `About Pieces`. + + + + In the *PiecesOS Information* section, find the "PiecesOS Version" field showing your installed version (e.g., "12.3.5"). + + + + Click the `Copy Icon` next to the PiecesOS version to copy the version number to your clipboard. + + + +### Checking for PiecesOS Updates + +Manually check if a new version of PiecesOS is available. Updates may include bug fixes, performance improvements, and new features. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `About Pieces`. + + + + In the *PiecesOS Information* section, find the "Check for Pieces OS Updates" link. + + + + Click the `Check for Pieces OS Updates` link to manually trigger an update check. If an update is available, you'll be prompted to install it. + + + +### Viewing PiecesOS Port + +View the port number that PiecesOS is currently using. This information is useful for troubleshooting connection issues or configuring integrations. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `About Pieces`. + + + + In the *PiecesOS Information* section, find the "PiecesOS Port" field showing the current port (e.g., "39300"). + + + + Click the `Copy Icon` next to the PiecesOS port to copy the port number to your clipboard. + + + +## Desktop App Information + +View information about your installed Pieces Desktop App version, check for updates, and see your platform details. The Desktop App provides the user interface and features built on top of PiecesOS. + +### Viewing Desktop App Version + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `About Pieces`. + + + + In the *Desktop App Information* section, find the "Desktop App Version" field showing your installed version (e.g., "5.0.0"). + + + + Click the `Copy Icon` next to the Desktop App version to copy the version number to your clipboard. + + + +### Checking for Desktop App Updates + +Manually check if a new version of the Pieces Desktop App is available. Updates may include new features, UI improvements, and bug fixes. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `About Pieces`. + + + + In the *Desktop App Information* section, find the "Check for Desktop App Updates" link. + + + + Click the `Check for Desktop App Updates` link to manually trigger an update check. If an update is available, you'll be prompted to install it. + + + + + You can also check for Desktop App updates using the keyboard shortcut `shift+U` (macOS) or `shift+U` (Windows/Linux) from anywhere in Pieces. + + +### Viewing Platform Information + +View your operating system and platform details. This information is useful for troubleshooting or when seeking support. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `About Pieces`. + + + + In the *Desktop App Information* section, find the "Platform" field showing your OS version and build information (e.g., "macOS Version 15.7.3 (Build 24G419)"). + + + + Click the `Copy Icon` next to the Platform information to copy the platform details to your clipboard. + + + +*** + +## Next Steps + +Now that you understand how to view version information and check for updates, learn about [Support & Feedback](/products/desktop/configuration/support) settings to access help resources, or explore [Telemetry](/products/desktop/configuration/telemetry) settings to configure data collection preferences. diff --git a/public/content/desktop/configuration/_deprecated_/aesthetics.md b/public/content/desktop/configuration/_deprecated_/aesthetics.md new file mode 100644 index 0000000..cb94b0f --- /dev/null +++ b/public/content/desktop/configuration/_deprecated_/aesthetics.md @@ -0,0 +1,180 @@ +--- +title: Aesthetics +path: /desktop/configuration/aesthetics +visibility: PUBLIC +status: PUBLISHED +description: Customize the visual appearance of Pieces Desktop including theme mode, accent colors, font settings, and visual density. +metaTitle: Aesthetics Settings in Pieces Desktop +metaDescription: Customize the visual appearance of Pieces Desktop including theme mode, accent colors, font settings, and visual density. +--- + +*** + +## Aesthetics Settings + +Customize the visual appearance of the Pieces Desktop App, including theme mode, accent colors, font size, font weight, and visual density. Adjust these settings to match your preferences and create a comfortable work environment. + +To access Aesthetics settings, click your `User Profile` in the top left, then hover over `Settings` and select `Aesthetics`. + + + +> Aesthetics settings showing Theme Mode, Accent Color, Font Size, Font Weight, and Visual Density options + + + Theme changes are automatically saved when adjusted, and settings are stored locally, not synced with Pieces Cloud. + + +## Theme Mode + +Choose how Pieces displays its theme. You can select Dark, Light, or System mode, which automatically matches your operating system's theme preference. + +### Changing Theme Mode + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Aesthetics`. + + + + Find the "Theme Mode" option showing your current mode (e.g., "Theme Mode: System"). + + + + Click the `Dropdown Arrow` next to the current theme mode to open the theme options. + + + + Choose from the following options: + * **Dark**: Dark theme for low-light environments + * **Light**: Light theme for bright environments + * **System**: Automatically matches your operating system's theme preference + + + + + +> Theme Mode dropdown showing Dark, Light, and System options + +## Accent Color + +Customize the accent color used throughout the Pieces interface. The accent color affects interactive elements like buttons and highlights, but not the entire UI. + +### Changing Accent Color + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Aesthetics`. + + + + Find the "Accent Color" option showing your current color (e.g., "Accent Color: Blue") with a color swatch. + + + + Click the `Dropdown Arrow` next to the accent color to open the color picker, which displays a grid of 36 available colors. + + + + Click on any color in the grid to select it. The selected color will be marked with a checkmark, and your accent color will update immediately. + + + + + +> Accent Color picker showing grid of 36 colors with selected color marked with checkmark + +## Font Size + +Adjust the size of all text in the Pieces Desktop App. This is helpful for different screen sizes, resolutions, or if you prefer larger or smaller text for readability. + +### Changing Font Size + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Aesthetics`. + + + + Find the "Font Size" option showing your current size (e.g., "Font Size: 100%"). + + + + Use the controls to change the font size: + * Click the `Minus Button` (`-`) to decrease the font size + * Click the `Plus Button` (`+`) to increase the font size + * The current percentage is displayed between the buttons + + + + + You can also use keyboard shortcuts to zoom: `⌘+,+` (macOS) or `ctrl+,+` (Windows/Linux) to zoom in, and `⌘+,-` (macOS) or `ctrl+,-` (Windows/Linux) to zoom out. + + +## Font Weight + +Adjust the thickness of text throughout the Pieces Desktop App. Choose from Thin, Normal, Medium, or Bold to match your reading preferences. + +### Changing Font Weight + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Aesthetics`. + + + + Find the "Font Weight" option showing your current weight (e.g., "Font Weight: Normal"). + + + + Click the `Dropdown Arrow` next to the current font weight to open the font weight options. + + + + Choose from the following options: + * **Thin**: Lightest font weight for minimal visual weight + * **Normal**: Standard font weight (default) + * **Medium**: Slightly bolder than normal + * **Bold**: Heaviest font weight for maximum emphasis + + + + + +> Font Weight dropdown showing Thin, Normal, Medium, and Bold options + +## Visual Density + +Adjust the spacing and layout density of the Pieces interface. Choose between Tight, Compact, or Standard to control how much information is displayed and how much space elements take up. + +### Changing Visual Density + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Aesthetics`. + + + + Find the "Visual Density" option showing your current density (e.g., "Visual Density: Standard"). + + + + Click the `Dropdown Arrow` next to the current visual density to open the density options. + + + + Choose from the following options: + * **Tight**: Maximum density with minimal spacing, showing more content in less space + * **Compact**: Moderate density with reduced spacing + * **Standard**: Default density with comfortable spacing (default) + + + + + +> Visual Density dropdown showing Tight, Compact, and Standard options + +*** + +## Next Steps + +Now that you understand how to customize Aesthetics, learn about [Views & Layouts](/products/desktop/configuration/views-layouts) settings to configure confirmation prompts and metrics display, or explore [Telemetry](/products/desktop/configuration/telemetry) settings to manage data collection preferences. diff --git a/public/content/desktop/configuration/_deprecated_/copilot-and-machine-learning.md b/public/content/desktop/configuration/_deprecated_/copilot-and-machine-learning.md new file mode 100644 index 0000000..3915a7a --- /dev/null +++ b/public/content/desktop/configuration/_deprecated_/copilot-and-machine-learning.md @@ -0,0 +1,228 @@ +--- +title: Machine Learning +path: /desktop/configuration/copilot-and-machine-learning +visibility: PUBLIC +status: PUBLISHED +description: Configure auto-enrichment, processing modes, Long-Term Memory Engine settings, and device resource management. +metaTitle: Machine Learning Settings in Pieces Desktop +metaDescription: Configure auto-enrichment levels, processing modes, Long-Term Memory Engine settings, and device resource management. +--- + +*** + +## Machine Learning Settings + +Configure how Pieces enriches your saved materials, controls local vs. cloud-based machine learning resources, and manages the Long-Term Memory Engine. Adjust auto-enrichment levels, processing modes, and device resources to match your workflow and privacy preferences. + +To access Machine Learning settings, click your `User Profile` in the top left, then hover over `Settings` and select `Machine Learning`. + + + +> Machine Learning settings showing auto-enrichment, processing mode, and Long-Term Memory Engine options + +## Saved Material Auto-Enrichment + +Control how much enriched metadata is automatically attached to your saved materials. Auto-enrichment adds tags, related websites, hints, and references to help you organize and discover your materials more effectively. + +### Auto-Generated Context + +Set the level of enriched metadata that Pieces automatically generates for your saved materials. Higher levels provide more detailed metadata but may take longer to process. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Machine Learning`. + + + + In the *Saved Material Auto-Enrichment* section, find the "Auto-Generated Context" option showing your current level (e.g., "Auto-Generated Context: Medium"). + + + + Click the `Dropdown Arrow` next to the current level to open the enrichment level options. + + + + Choose from the following levels: + * **None**: No enriched metadata (0) + * **Low**: Lower levels of enriched metadata (2-3) + * **Medium**: Medium levels of enriched metadata (3-5) + * **High**: Higher levels of enriched metadata (7-9) + + + + + +> Auto-Generated Context dropdown showing None, Low, Medium, and High enrichment levels with descriptions + + + By default, auto-generated context is set to *Medium*. Lower levels may be beneficial if you prefer minimal automatic annotations or need to limit processing time. + + +## ML Processing + +Configure how Pieces uses local and cloud machine learning resources to process your materials and power various functions within the Pieces software experience. + +### Processing Mode + +Choose how Pieces processes your materials using machine learning resources. You can select Cloud, Local, or Blended processing modes based on your performance and privacy preferences. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Machine Learning`. + + + + In the *ML Processing* section, find the "Processing Mode" option showing your current mode (e.g., "Processing Mode: Blended"). + + + + Click the `Dropdown Arrow` next to the current processing mode to open the mode options. + + + + Choose from the following options: + * **Cloud**: Optimized for speed, but all data gets sent to the cloud for processing + * **Local**: Most processing happens locally before reaching out to the selected model, providing better privacy + * **Blended**: Uses a combination of local and cloud resources, balancing speed and privacy + + + + + +> Processing Mode dropdown showing Cloud, Blended, and Local options with icons + + + Selecting the processing mode that best fits your security and performance needs ensures that Pieces processes your materials in the most efficient or privacy-conscious way possible. + + +## Long-Term Memory Engine + +Configure the Long-Term Memory (LTM-2.7) Engine, which uses on-device machine learning to auto-generate Workstream Activities and provide temporal context for your Conversational Search. + +### Enabling Long-Term Memory Engine + +Toggle the Long-Term Memory Engine on or off to control whether Pieces captures and uses your workflow context. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Machine Learning`. + + + + In the *ML Processing* section, find the "Long-Term Memory Engine" option showing your current status (e.g., "Long-Term Memory Engine: On" with a green indicator). + + + + Click the toggle to enable or disable the Long-Term Memory Engine. When enabled, it uses on-device machine learning to auto-generate Workstream Activities and provide temporal context for your Conversational Search. + + + + + The Long-Term Memory Engine helps Pieces understand your workflow patterns and provide more contextual suggestions in Conversational Search. When disabled, Pieces won't capture or use workflow context. + + +### Long-Term Memory Source Control + +Manage which sources the Long-Term Memory Engine interacts with. This allows you to control what data sources Pieces uses when capturing workflow context. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Machine Learning`. + + + + In the *ML Processing* section, find the "Long-Term Memory Source Control" option. + + + + Click the `Dropdown Arrow` next to "Long-Term Memory Source Control" to manage which sources the Long-Term Memory Engine interacts with. + + + +### Long-Term Memory Permissions + +Manage accessibility and screen permissions for the Long-Term Memory Engine. If permissions are not already enabled, you can provide the necessary permissions to Pieces. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Machine Learning`. + + + + In the *ML Processing* section, find the "Long-Term Memory Permissions" option. + + + + Click the `Permissions Icon` to open the permissions settings. If permissions are not already enabled, you'll be prompted to provide the necessary permissions to Pieces. + + + + Follow the system prompts to grant the required accessibility and screen permissions that allow the Long-Term Memory Engine to capture workflow context. + + + +### Clearing Long-Term Memory Engine Data + +Remove persisted data captured by the Long-Term Memory Engine for a specific time range. This allows you to clear workflow context while keeping the engine enabled. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Machine Learning`. + + + + In the *ML Processing* section, find the "Clear Long-Term Memory Engine Data..." option. + + + + Click the `Trash Icon` next to "Clear Long-Term Memory Engine Data..." to open the clearing options. + + + + Choose the time range for the data you want to clear (e.g., last 7 days, last 30 days, all time). + + + + Confirm the clearing action when prompted. The selected Long-Term Memory Engine data will be permanently removed. + + + + + Clearing Long-Term Memory Engine data is a permanent action that cannot be undone. This will remove workflow context captured during the selected time range. + + +## Device Resources + +Manage device resources and optimize memory usage by unloading local machine learning models and resources from memory when not in use. + +### Optimize Memory Usage + +Unload local machine learning models and resources from memory to free up system resources. This is useful if you need to reduce memory usage or free up resources for other applications. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Machine Learning`. + + + + Scroll down to the *Device Resources* section at the bottom of the Machine Learning settings. + + + + Click the `Optimize Memory Usage` button (CPU/Microchip Icon) to unload local machine learning models and resources from memory. + + + + + +> Device Resources section showing Optimize Memory Usage option + + + Optimizing memory usage can help free up system resources, but you may need to reload models when you next use features that require them, which may take a moment. + + +*** + +## Next Steps + +Now that you understand how to configure Machine Learning settings, learn about [Conversational Search](/products/desktop/conversational-search) to query your workflow memories and get AI-powered insights, or explore [Model Context Protocol (MCP)](/products/desktop/configuration/mcp) to integrate Pieces with other tools. diff --git a/public/content/desktop/configuration/_deprecated_/personal-cloud.md b/public/content/desktop/configuration/_deprecated_/personal-cloud.md new file mode 100644 index 0000000..1570fbd --- /dev/null +++ b/public/content/desktop/configuration/_deprecated_/personal-cloud.md @@ -0,0 +1,275 @@ +--- +title: Personal Cloud +path: /desktop/configuration/personal-cloud +visibility: PUBLIC +status: PUBLISHED +description: Configure Personal Cloud settings for synchronization, backups, and personal domain management. +metaTitle: Personal Cloud Settings in Pieces Desktop +metaDescription: Configure Personal Cloud settings for synchronization, backups, and personal domain management. +--- + +*** + +## Personal Cloud Settings + +Configure cloud synchronization, backups, and your personal domain. This keeps your materials and workflow history available wherever you work. + +To access Personal Cloud settings, click your `User Profile` in the top left, then hover over `Settings` and select `Personal Cloud`. + +Pieces can run entirely offline, but connecting to Pieces Cloud enables real-time syncing and access across devices. This keeps your materials, settings, and workflow history available wherever you work. + + + +> Personal Cloud settings showing disconnected status with connection options + +## Connecting to Personal Cloud + +Connect to your Personal Cloud to enable cloud synchronization, backups, and sharing features. When you connect, Pieces will automatically sync if you already have a cloud account, or create a new cloud for you. + +### Connecting Your Cloud + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Personal Cloud`. + + + + When your cloud is disconnected, click the `Cloud Icon` to the right of the status indicator to connect to your Personal Cloud. + + + + Pieces will automatically sync your data if you already have a cloud account, or create a new cloud account for you. Once connected, your status will update to "Connected" and you'll have access to all cloud features. + + + + + Any material saved in *Pieces Drive* or marked as a snippet is backed up. There are *no storage limits* on cloud-synced data. + + +## Cloud Status + +View your cloud connection status and when it was last updated. The status indicator shows whether your Personal Cloud is connected or disconnected, along with a timestamp of the last update. + +### Viewing Cloud Status + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Personal Cloud`. + + + + At the top of the Personal Cloud settings, you'll see your connection status: + * **Connected**: Shows "Status: Connected" with a green dot, along with "Last updated [time]" + * **Disconnected**: Shows "Status: Disconnected" with a gray dot + + + + + +> Personal Cloud settings showing connected status with personal domain and backup options + +## Disconnecting Personal Cloud + +Disconnect from your Personal Cloud at any time to disable cloud synchronization and features. You can reconnect later if needed. + +### Disconnecting Your Cloud + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Personal Cloud`. + + + + When your cloud is connected, click the `Disconnect Cloud Icon` (cloud with diagonal line) to disconnect from your Personal Cloud. + + + + Confirm the disconnection when prompted. Once disconnected, cloud features will be disabled and your status will show as "Disconnected". + + + +Before disconnecting, keep in mind that several features require connectivity to your Personal Cloud: + +* **Sharing (beta)**: The ability to generate and share links for saved materials from Pieces Drive +* **Cloud ML**: Cloud-based enrichment of metadata for saved materials +* **Cloud Backup**: The automatic synchronization of your data to Pieces Cloud +* **Cloud Integrations**: Your Pieces Cloud which controls your personal subdomain and other integrations + +## Personal Domain + +Customize your personal subdomain to create a unique URL for sharing your materials. Your personal domain is used when generating shareable links for your saved materials. + +### Understanding Personal Domains + +When you're connected to Pieces Cloud, you're assigned a personal subdomain (e.g., `yourname.pieces.cloud`) for sharing snippets. This subdomain isn't publicly browsable like a profile page—instead, it's prepended to any URLs you generate when sharing saved materials. + +### Customizing Your Personal Domain + +Create a custom subdomain by entering any text you want before `.pieces.cloud` to make `your_custom_url.pieces.cloud`. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Personal Cloud`. + + + + Scroll to the *Personal Domain* section, which shows your current domain status and the text input field. + + + + In the text input field, enter the custom text you want to use before `.pieces.cloud`. For example, entering "nolanworksat" will create `nolanworksat.pieces.cloud`. + + + + Your domain will update automatically. The section will show "Your domain [your_custom_url].pieces.cloud is running" when active. + + + + + +> Personal Domain section showing custom subdomain input and active domain status + +## Backup & Restore Data + +Create manual backups of your data for long-term storage and recovery. These backups are stored in your personal Pieces cloud and can be restored or deleted at any time. + +### Opening Backup & Restore Data + +Access the backup management interface to create backups, view existing backups, restore previous versions, or delete old backups. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Personal Cloud`. + + + + In the *Backup & Restore Data* section, click the `Restore Icon` (Circular Arrow Icon) to open the Backup & Restore Data modal. + + + + + +> Backup & Restore Data modal showing backup list, create backup option, and Check for Backups button + +### Checking for Backups + +Manually check for new backups that may have been created from other devices or sessions. + + + + Click your `User Profile` in the top left, hover over `Settings`, select `Personal Cloud`, then click the `Restore Icon` in the *Backup & Restore Data* section. + + + + In the top right of the modal, click the `Check for Backups` button (Refresh Icon) to manually check for any new backups. + + + +### Creating a Backup + +Create a manual backup snapshot of your data. Backups are stored in your personal Pieces cloud and include all your saved materials, settings, and preferences. + + + + Click your `User Profile` in the top left, hover over `Settings`, select `Personal Cloud`, then click the `Restore Icon` in the *Backup & Restore Data* section. + + + + In the modal, find the *Create Backup* section, which shows "Backups will be stored in your personal Pieces cloud". + + + + Click the `Cloud Icon with Upward Arrow` to create a new backup. The backup will be created and uploaded to your personal Pieces cloud. + + + +### Backup Contents + +A Pieces backup contains the following data: + +| **Data Type** | **Summary** | +| ----------------------- | ----------------------------------------------------------------- | +| *Snippets* | All saved code snippets and related metadata. | +| *Pieces Drive Files* | Any files stored in Pieces Drive. | +| *User Preferences* | Theme, UI settings, and personalization options. | +| *Pieces Copilot Data* | Recent chat history and AI context for Pieces Copilot. | +| *Search & Tagging Data* | User-defined tags and previous searches for quick retrieval. | +| *Account Connections* | Linked GitHub, Google, or Microsoft accounts (without passwords). | + + + Backups *do not include* Pieces Cloud data that is already synced or external files which are not explicitly stored in Pieces Drive. + + +### Viewing Your Backups + +See all of your available backups with details about when they were created, their size, the device they were created on, and the PiecesOS version at the time of backup. + + + + Click your `User Profile` in the top left, hover over `Settings`, select `Personal Cloud`, then click the `Restore Icon` in the *Backup & Restore Data* section. + + + + Scroll down to the *Backups* section, which shows the total number of backups and lists each backup with: + * **Date and time**: When the backup was created (e.g., "Mon, Dec 8, 2025 9:41 AM") + * **Size**: The backup file size (e.g., "342.85 MB") + * **Device**: The device name where the backup was created (e.g., "Judsons MacBook Air") + * **OS Version**: The PiecesOS version at the time of backup (e.g., "PiecesOS v12.3.3") + + + +### Restoring a Backup + +Restore a previous backup to recover all saved materials, settings, and preferences. This will return Pieces Drive and the Pieces Desktop App to the state captured in that backup. + + + + Click your `User Profile` in the top left, hover over `Settings`, select `Personal Cloud`, then click the `Restore Icon` in the *Backup & Restore Data* section. + + + + In the *Backups* section, find the backup you want to restore from the list. + + + + Click the `Restore Icon` (Refresh/Circular Arrow Icon) on the right side of the backup entry to restore that backup. + + + + Confirm the restoration when prompted. All saved materials, settings, and preferences will be restored to the state captured in that backup. + + + +### Deleting a Backup + +Remove old backups that you no longer need. Deleted backups cannot be restored—this is a permanent deletion. + + + + Click your `User Profile` in the top left, hover over `Settings`, select `Personal Cloud`, then click the `Restore Icon` in the *Backup & Restore Data* section. + + + + In the *Backups* section, find the backup you want to delete from the list. + + + + Click the `Trash Icon` on the right side of the backup entry to delete that backup. + + + + Confirm the deletion when prompted. The backup will be permanently removed and cannot be restored. + + + +## Cloud Syncing + +Cloud syncing is optional—you can use Pieces entirely offline if you prefer. Once connected, syncing happens automatically in real time, keeping your data synchronized across all your devices. The only way to disable syncing is by disconnecting from Pieces Cloud. + +When connected, your data is automatically synchronized in real time across all devices where you're signed in. This includes snippets, Pieces Drive files, settings, and workflow history. + +*** + +## Next Steps + +Now that you understand how to manage your Personal Cloud, learn about [Account](/products/desktop/configuration/account) settings to manage your authentication and linked accounts, or explore [Connected Applications](/products/desktop/configuration/connected-applications) to integrate Pieces with other services. diff --git a/public/content/desktop/configuration/_deprecated_/support.md b/public/content/desktop/configuration/_deprecated_/support.md new file mode 100644 index 0000000..c6a11ad --- /dev/null +++ b/public/content/desktop/configuration/_deprecated_/support.md @@ -0,0 +1,97 @@ +--- +title: Support & Feedback +path: /desktop/configuration/support +visibility: PUBLIC +status: PUBLISHED +description: Access support resources, documentation, feedback channels, and keyboard shortcuts. +metaTitle: Support & Feedback Settings in Pieces Desktop +metaDescription: Access support resources, documentation, feedback channels, and keyboard shortcuts in Pieces Desktop. +--- + +*** + +## Support & Feedback Settings + +Access support resources, documentation, feedback channels, and keyboard shortcuts. Get help, share feedback, and learn how to use Pieces more effectively. + +To access Support & Feedback settings, click your `User Profile` in the top left, then hover over `Settings` and select `Support & Feedback`. + + + +> Support & Feedback settings showing Chat with us, Documentation, Share Feedback or Get Help, and Keyboard Shortcuts options + +## Chat with us + +Join the Pieces Discord community to get support, share feature ideas, and connect with the team. The Discord server is a great place to ask questions, report issues, and interact with other Pieces users. + +### Accessing Discord + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Support & Feedback`. + + + + Click the `Chat with us` option (Discord Icon) to open the Pieces Discord server in your browser. + + + +## Documentation + +Access Pieces' official documentation to learn how to use features, configure settings, and get the most out of Pieces. + +### Accessing Documentation + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Support & Feedback`. + + + + Click the `Documentation` option (Question Mark Icon) to open Pieces' official documentation in your browser. + + + +## Share Feedback or Get Help + +Check out support resources and share any issues or feedback with the team. Access the support page, submit bug reports, or get help with troubleshooting. + +### Accessing Support Resources + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Support & Feedback`. + + + + Click the `Share Feedback or Get Help` option (Gear Icon) to access support resources, submit feedback, or report issues. + + + +## Keyboard Shortcuts + +View all available keyboard shortcuts for Pieces Desktop. Learn shortcuts to navigate faster, perform actions quickly, and improve your workflow efficiency. + +### Viewing Keyboard Shortcuts + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Support & Feedback`. + + + + Click the `Keyboard Shortcuts` option (Keyboard Icon) to open the keyboard shortcuts modal, which displays all available shortcuts for Pieces Desktop. + + + + + You can also open the keyboard shortcuts modal using the keyboard shortcut `⌘+;` (macOS) or `ctrl+;` (Windows/Linux) from anywhere in Pieces. + + +For a complete reference guide of all keyboard shortcuts, see the [Keyboard Shortcuts](/products/desktop/actions/keyboard-shortcuts) documentation. + +*** + +## Next Steps + +Now that you understand how to access support resources, learn about [Telemetry](/products/desktop/configuration/telemetry) settings to configure data collection preferences, or explore [About Pieces](/products/desktop/configuration/about) to view version information and system details. diff --git a/public/content/desktop/configuration/_deprecated_/telemetry.md b/public/content/desktop/configuration/_deprecated_/telemetry.md new file mode 100644 index 0000000..0220f66 --- /dev/null +++ b/public/content/desktop/configuration/_deprecated_/telemetry.md @@ -0,0 +1,55 @@ +--- +title: Telemetry +path: /desktop/configuration/telemetry +visibility: PUBLIC +status: PUBLISHED +description: Configure telemetry and diagnostics settings to help improve Pieces. +metaTitle: Telemetry Settings in Pieces Desktop +metaDescription: Configure telemetry and diagnostics settings to share anonymous usage data and help improve Pieces. +--- + +*** + +## Telemetry Settings + +Configure telemetry and diagnostics settings to help improve Pieces. Share anonymous telemetry and crash data to help the Pieces team build better developer tools across macOS, Linux, and Windows. + +To access Telemetry settings, click your `User Profile` in the top left, then hover over `Settings` and select `Telemetry`. + + + +> Telemetry settings showing Telemetry & Diagnostics option with checkbox + +## Telemetry & Diagnostics + +Enable or disable anonymous telemetry and crash data collection. Building next generation Developer Tools across macOS, Linux, and Windows is hard! Share anonymous telemetry and crash data to help improve Pieces 🙏 + +### Understanding Telemetry + +Telemetry helps the Pieces team identify issues, understand how features are used, and prioritize improvements. All data collected is anonymous and helps improve the Pieces experience for all users. + +### Enabling or Disabling Telemetry + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Telemetry`. + + + + Find the "Telemetry & Diagnostics" option in the *Telemetry* section. + + + + Check or uncheck the `Checkbox` next to "Telemetry & Diagnostics" to enable or disable anonymous telemetry and crash data collection. + + + + + Participating in telemetry helps Pieces evolve more effectively, but you can opt out for greater privacy. Read more about compliance, privacy, and security [here](/products/privacy-security-your-data), and as always feel free to reach out to our team on [Discord](https://discord.gg/getpieces), [GitHub](https://github.com/pieces-app), or at support@pieces.app. + + +*** + +## Next Steps + +Now that you understand how to configure Telemetry, learn about [Support & Feedback](/products/desktop/configuration/support) settings to access help resources, or explore [About Pieces](/products/desktop/configuration/about) to view version information and system details. diff --git a/public/content/desktop/configuration/_deprecated_account-and-cloud.md b/public/content/desktop/configuration/_deprecated_account-and-cloud.md new file mode 100644 index 0000000..6b24697 --- /dev/null +++ b/public/content/desktop/configuration/_deprecated_account-and-cloud.md @@ -0,0 +1,128 @@ +--- +title: Account & Cloud +path: /desktop/configuration/account-and-cloud +visibility: PUBLIC +status: PUBLISHED +description: The Account & Cloud settings allows you to manage third-party account connections, cloud synchronization, backups, your personal domain, and more. +metaTitle: Account and Cloud Configuration in the Pieces Desktop Application +metaDescription: The Account & Cloud settings allows you to manage third-party account connections, cloud synchronization, backups, your personal domain, and more. +--- + +## Accessing Settings + +To open the **Account & Integration** and **Personal Cloud** settings, hover over your username in the top left, then hover over `Settings` and select either: + +1. **Account & Integrations**: Manage external account connections and sign into or out of your Pieces account. + +2. **Personal Cloud**: Connect to or disconnect from your Personal Cloud, manage backups, and edit the URL of your personal domain. + +## Account Management + +External account connections in Pieces are managed through third-party services such as Microsoft, Google, or GitHub. + +### Viewing & Editing Linked Accounts + +You can connect or disconnect third-party services from this modal. + +* View connected accounts (GitHub, Google, Microsoft). + +* Accounts are linked upon sign-in and cannot be manually edited. + +* Profile information (name, email, avatar) is pulled from the linked service. + + + +## Personal Cloud + +Pieces can run entirely offline, but connecting to Pieces Cloud enables real-time syncing and access across devices. + +### Cloud Syncing + +Cloud syncing is *optional.* + +Once connected, syncing is automatic and happens in real time. Once connected, the only way to disable syncing is by disconnecting from Pieces Cloud. + + + Any material saved in **Pieces Drive** or marked as a snippet is backed up. There are *no storage limits* on cloud-synced data. + + +### Disconnecting Personal Cloud + +You can disconnect from your *Personal Cloud* at anytime by clicking the slashed `Cloud` icon, which opens up a *Disconnect Cloud* modal. + + + +There are several features which require connectivity to your *Personal Cloud,* so be sure to read through these before disconnecting: + +1. **Link Sharing:** The ability to generate and share links for saved materials from the **Pieces Drive.** + +2. **Cloud ML:** Cloud-based enrichment of metadata for saved materials. + +3. **Cloud Backup:** The automatic synchronization of your data to Pieces Cloud. + +4. **Cloud Integrations:** Your Pieces Cloud which controls your personal subdomain and other integrations. + +### Backup & Restore + +Pieces allows *manual backups* of your data for long-term storage and recovery. + +These data backups are *not automatic* and must be manually created. To create a backup: + + + + Click on your username in the top left, then hover over `Settings` and select `Personal Cloud`. + + + + Click the **Backup & Restore** icon to open the backup menu. + + + + Click `Create Backup` to save a snapshot and upload it to Pieces Cloud. + + + + + +### Backup Contents + +A Pieces backup contains the following data: + +| **Data Type** | **Summary** | +| ----------------------- | ----------------------------------------------------------------- | +| *Snippets* | All saved code snippets and related metadata. | +| *Pieces Drive Files* | Any files stored in Pieces Drive. | +| *User Preferences* | Theme, UI settings, and personalization options. | +| *Pieces Copilot Data* | Recent chat history and AI context for Pieces Copilot. | +| *Search & Tagging Data* | User-defined tags and previous searches for quick retrieval. | +| *Account Connections* | Linked GitHub, Google, or Microsoft accounts (without passwords). | + + + Backups *do not include* Pieces Cloud data that is already synced or external files which are not explicitly stored in Pieces Drive. + + +### Restoring a Backup + +Previous backups are listed in the **Backup Manager** with details including: + +1. **Timestamp** of when the backup was created. + +2. **File size** of the backup. + +3. **Device name** that created the backup. + +4. **PiecesOS version** at the time of backup. + +Clicking the `Restore` icon will recover all saved materials, settings, and preferences and return Pieces Drive and the Pieces Desktop App to that previous state. + +### Deleting a Backup + +To delete a backup, click the `Trash` icon. Note that, when a backup is deleted, it *cannot be restored.* This is a permanent deletion. + +## Personal Domain + +When you’re connected to Pieces Cloud, you’re assigned a personal subdomain (e.g., [yourname.pieces.cloud](http://yourname.pieces.cloud)) for sharing snippets. + +This subdomain isn’t publicly browsable like a profile page—instead, it’s prepended to any URLs you generate when sharing saved materials. + +You can customize your subdomain at any time. To do so, open **Settings,** then **Personal Cloud**, and edit the input field under **Personal Domain**. \ No newline at end of file diff --git a/public/content/desktop/configuration/_deprecated_additional-settings.md b/public/content/desktop/configuration/_deprecated_additional-settings.md new file mode 100644 index 0000000..a3b1888 --- /dev/null +++ b/public/content/desktop/configuration/_deprecated_additional-settings.md @@ -0,0 +1,33 @@ +--- +title: Additional Settings +path: /desktop/configuration/additional-settings +visibility: PUBLIC +status: PUBLISHED +description: There are several configurable behaviors and adjustable settings within the main Settings view that offer deeper configuration choices to help you align the app with your workflow. +metaTitle: Configuring Additional Settings | Pieces Docs +metaDescription: There are several configurable behaviors and adjustable settings within the main Settings view that offer deeper configuration choices to help you align the app with your workflow. +--- + +## Accessing Settings + +To access the general **Settings** view, navigate to the `Home Icon`, type *“settings,”* and click Go to Settings. Alternatively, you can click the `Settings` gear in the bottom-left corner of the *default view.* + +## Telemetry & Diagnostics + +You can control whether or not Pieces collects crash data and anonymous usage information. The Pieces team uses this information to help fix bugs and improve the app. + + + +To enable or disable **Telemetry,** check or uncheck the `Tickbox` to the right of the **Telemetry** setting. + + + Participating in telemetry helps Pieces evolve more effectively, but you can opt out for greater privacy. + + +## Notification Preferences + +Avoid unnecessary interruptions by customizing how and when you receive in-app alerts. + +You can select the `Bell` icon under *Notifications* to enable `All`, `Critical`, or `None` to determine how many—and what type—of notifications you receive. + +`Critical` notifications are regarded primarily as errors and alerts—i.e., if PiecesOS is not detected (an edge case). \ No newline at end of file diff --git a/public/content/desktop/configuration/_deprecated_aesthetics-layout.md b/public/content/desktop/configuration/_deprecated_aesthetics-layout.md new file mode 100644 index 0000000..0c35830 --- /dev/null +++ b/public/content/desktop/configuration/_deprecated_aesthetics-layout.md @@ -0,0 +1,97 @@ +--- +title: Aesthetics & Layouts +path: /desktop/configuration/aesthetics-layout +visibility: PUBLIC +status: PUBLISHED +description: The Views & Layouts and Aesthetics settings allow users to adjust the visual appearance of the app, including dark and light-themed UI modes, accent colors, and UI scaling. +metaTitle: Configuring Aesthetics & Layouts Settings | Pieces Docs +metaDescription: The Views & Layouts and Aesthetics settings allow users to adjust the visual appearance of the app, including dark and light-themed UI modes, accent colors, and UI scaling. +--- + +## Accessing Settings + +When opening the Pieces Desktop App, click the `settings gear` at the bottom left of the default view to open the Views & Layouts and Aesthetics settings. + +Then, navigate to either of the two sections: + +1. **Views & Layouts**: Manage the layout of the Pieces Desktop app to customize it according to your preferences. + +2. **Aesthetics**: Change the Pieces App's brightness, colors, and zoom level to ensure you're comfortable using it. + +## Changing Theme + +Pieces allows users to toggle between *dark mode* and *light mode*, giving you complete control over the appearance of the Pieces Desktop App. + +### Dark & Light Mode + +In the **Aesthetics** settings section, you can click the `Toggle Mode` button to switch between light and dark UI themes. + +You can also use the keyboard shortcuts `⌘+shift+t` (macOS) or `ctrl+shift+t` (Windows/Linux). + +### Changing the Accent Color + +Users can customize the UI with one of 35 preset accent colors. + +Click the `Accent Color` dropdown in the **Aesthetics** settings section, select one of the available preset colors, and the accent color will apply to interactive elements like buttons and highlights, but not to the entire UI. + + + +### Font & UI Size + +Use the `Font Size` setting to adjust the size of all text. + +\`To zoom in, use `⌘+,+` (macOS) or `ctrl+,+` (Windows/Linux)—to zoom out, use `⌘+,-` (macOS) or `ctrl+,-` (Windows/Linux). + + + +## Adjusting Layout + +There are several default layout behaviors to adjust within the **Views & Layouts** page. + + + Theme changes are automatically saved when adjusted, and settings are stored locally, not synced with Pieces Cloud. + + +### Default Layout + +In this section, you can select the `Default Layout` option to determine which interface appears when Pieces Desktop first launches. + +For example, setting it to Pieces Copilot allows you to start with the default generative AI interface, whereas Pieces Drive sets the default interface to the saved materials view on application launch. + +### Default List View Sort + +In this section, the `Default List View Sort` option lets you arrange materials in *List View* based on `Recent`, `Suggested`, or `Alphabetical`, and `Language` criteria. + +This default sorting ensures you see new or popular items first (or in whichever order best suits your workflow), without needing to manually re-sort each time. + +### Default Gallery View Sort + +The **Views & Layout** settings also include `Default Gallery View Sort`, allowing you to specify how items appear in *Gallery View* (e.g., sorted by `Most Recent` or `Alphabetical`). + +If you frequently rely on visual cues, this setting ensures you’ll quickly spot the snippets or media you need, saving time on manual sorting. + +### Default Search Mode + +You can pick `Default Search Mode` to define which search method Pieces uses by default. + +For instance, selecting Neural Code Search (NCS) lets you enter natural language queries—perfect for quickly finding code snippets or references without remembering exact filenames or tags. + +This is opposed to *Full-Text Search (FTS)* or *Search with Snippet*, which are more specific, hyper-focused querying workflows. + +### Confirmation Settings + +Confirmation prompts can protect you from unintended deletions or other irreversible changes. + +Enabling or adjusting `Confirmation Settings` determines whether Pieces requests an extra step (such as “Are you sure?”) before making significant modifications. + +### Metrics Summary Settings + +Each setting in the **Metrics Summary** settings view addresses a distinct scenario or user action within *Pieces Drive*. + + + +Under the *Gallery View*, for instance, `Smart Layout` automatically displays the context summary for smaller snippets, while `All` shows summaries whenever you navigate or hover over snippet icons. + +The `Navigating` option triggers summaries only when you scroll or switch between snippets in the *Gallery View*, and `Hovering` keeps them hidden until you hover over the context icon. + +Mixing and matching these options allows you to highlight crucial snippet details precisely when needed. \ No newline at end of file diff --git a/public/content/desktop/configuration/account.md b/public/content/desktop/configuration/account.md new file mode 100644 index 0000000..0604e2a --- /dev/null +++ b/public/content/desktop/configuration/account.md @@ -0,0 +1,626 @@ +--- +title: Account +path: /desktop/configuration/account +visibility: PUBLIC +status: PUBLISHED +description: Manage your Pieces account settings, authentication, linked accounts, organizations, subscriptions, personal cloud, and privacy settings. +metaTitle: Account Settings in Pieces Desktop +metaDescription: Manage your Pieces account settings, authentication, linked accounts, organizations, subscriptions, personal cloud synchronization, and privacy settings. +--- + +## Account Settings + +Manage your Pieces account settings, authentication, linked accounts, organizations, subscriptions, personal cloud synchronization, and privacy settings. Your account information is automatically synced from the third-party service you used to sign in, ensuring your profile stays up to date. + +To access Account settings, click your `User Profile` in the top left, then hover over `Settings` and select `Account`. + + + +> Account settings showing profile information, linked accounts, organizations, and subscriptions + +## Account Information + +View your *account details* and manage your session. Your name and email are pulled from the third-party service you used to authenticate, ensuring your profile information stays synchronized. + +### Viewing Your Account Information + +Your account information displays your name and email address at the top of the Account settings page. + +Clicking on your name opens the *Accounts & Cloud Integrations* modal, where you can manage linked accounts and account settings. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Account`. + + + + At the top of the Account settings page, you'll see your name and email address. This information is automatically synced from the service you used to sign in (GitHub, Google, or Microsoft). + + + + Click on your `Name` in the *Account* section to open the *Accounts & Cloud Integrations* modal, which provides detailed account management options. + + + +### Logging Out + +Sign out of your Pieces account to end your current session. You can log back in using any of your linked accounts. You can sign out from multiple locations. + +#### Signing Out from Settings Hover Menu + + + + Click your `User Profile` in the top left of the home view. + + + + In the dropdown menu that appears, click `Log Out` to sign out of your account. + + + + You'll be signed out and returned to the login screen. You can sign back in using any of your linked accounts. + + + +#### Signing Out from Account Settings + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Account`. + + + + Click the `logout icon` (arrow pointing out of a square) next to your name and email to sign out of your account. + + + + You'll be signed out and returned to the login screen. You can sign back in using any of your linked accounts. + + + +#### Signing Out from Accounts & Cloud Integrations Modal + +You can also sign out from the *Accounts & Cloud Integrations* modal. Open the modal by clicking your `Name` in the *Account* section, then scroll down to the *Danger Zone* section and click `Sign Out` to sign out of your account. + + +You will no longer have the ability to generate shareable links or share via GitHub Gist after signing out. + + +## Linked Accounts + +Link accounts with the same email address to enable unique features from each provider, such as importing and exporting GitHub Gists. Your profile information (name, email, avatar) is automatically pulled from these linked accounts, making it easy to sign in and keep your information up to date. + +### Understanding Linked Accounts + +Accounts are linked when you sign in using a third-party service (GitHub, Google, or Microsoft). You can link multiple accounts that use the same email address to access features from each provider. Accounts cannot be manually edited—this ensures your account stays secure and synced with the services you use to authenticate. + +### Viewing Linked Accounts + +See which third-party services are connected to your Pieces account. You can view linked accounts either from the Account settings page. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Account`. + + + + Scroll down to the *Linked Accounts* section, which displays icons for GitHub, Google, and Microsoft. Connected services will have a green dot on them. Services that aren't linked will not. + + + + For detailed account management, click on your `Name` in the *Account* section to open the *Accounts & Cloud Integrations* modal. In the *Connect Individual Accounts* section, you'll see: + * Connected services show "Connected to [Service]" with a green checkmark + * Unconnected services show "Connect to [Service]" without a checkmark + + + +### Opening Accounts & Cloud Integrations Modal + +Access the *Accounts & Cloud Integrations* modal to manage your linked accounts, view connection status, and access account features. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Account`. + + + + Click on your `Name` in the *Account* section at the top of the page to open the *Accounts & Cloud Integrations* modal. + + + + The modal displays: + * **Introduction**: Information about connecting accounts to enable features like importing/exporting GitHub Gists and generating shareable links + * **Important Note**: Only accounts with a matching primary email address will be linked + * **Connect Individual Accounts**: List of available services (Microsoft, GitHub, Google) with connection status + * **Support**: Links to Discord support and feedback resources + * *Danger Zone*: Option to sign out of your account + + + +### Linking an Account + +Connect a new third-party service to your Pieces account to access provider-specific features like importing and exporting GitHub Gists. + + + + Click your `User Profile` in the top left, hover over `Settings`, select `Account`, then click on your `Name` to open the *Accounts & Cloud Integrations* modal. + + + + In the *Connect Individual Accounts* section, find the service you want to link (Microsoft, GitHub, or Google). + + + + Click on the service name (e.g., "Connect to Microsoft") to start the connection process. + + + Make sure the account uses the same email address as your Pieces account. Only accounts with a matching primary email address will be linked. Otherwise, a new, separate account will be created. + + + + + Follow the authentication flow for the selected service. Once authenticated, the account will be linked and you'll see a green checkmark next to the service name. + + + +### Disconnecting an Account + +Remove a linked account from your Pieces account. You can disconnect accounts from the *Accounts & Cloud Integrations* modal. + + + + Click your `User Profile` in the top left, hover over `Settings`, select `Account`, then click on your `Name` to open the *Accounts & Cloud Integrations* modal. + + + + In the *Connect Individual Accounts* section, find the service you want to disconnect. Connected services show "Connected to [Service]" with a green checkmark. + + + + Click on the connected service to disconnect it. Confirm the disconnection when prompted. + + + + The service will no longer show a green checkmark, indicating it has been disconnected. You'll lose access to provider-specific features for that service. + + + + +## Organizations & Teams + +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. + + + +> Account settings page showing Organizations & Teams section with organization list and management options + +### Viewing Your Organizations + +See all organizations you're a member of, including their subscription plans. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Account`. + + + + Scroll down to the *Organizations & Teams* section to view your organization memberships. + + + + Each organization displays: + * **Organization name**: The name of the organization + * **Organization label**: A blue badge indicating it's an organization + * **Subscription type**: The plan type (e.g., Enterprise Seat Yearly, Enterprise Seat Quarterly, Enterprise Seat Monthly) + + + +### Managing Organizations + +Access organization management features from the Account settings page. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Account`. + + + + Scroll down to the *Organizations & Teams* section. + + + + Click the `Manage` button (external link icon) to open your account page in the browser, where you can view and manage your organizations, invite members, configure settings, and access billing information. + + + +### Refreshing Organizations + +Manually refresh your organization list if it doesn't appear up to date. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Account`. + + + + Scroll down to the *Organizations & Teams* section. + + + + Click the `Refresh` button (circular arrow icon) to manually sync your organization list with the latest information. + + + +### Getting Help with Organizations + +Access troubleshooting resources for organization-related issues. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Account`. + + + + Scroll down to the *Organizations & Teams* section. + + + + Click the `Get Help` button (question mark icon) to open the [Organizations & Teams troubleshooting page](/products/organizations-and-teams/troubleshooting), which provides solutions for common organization access issues and authentication problems. + + + + + Learn how to create organizations, invite team members, manage team settings, and collaborate effectively with your team. + + + +## Personal Subscriptions + +Manage your Pieces Pro subscription, view your plan details, update payment methods, and access billing information. Your subscription status, renewal dates, and payment history are all accessible from this section. + +### Viewing Your Subscriptions + +See all of your active and canceled subscriptions, including plan types, status, and renewal information. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Account`. + + + + Scroll down to the *Personal Subscription(s)* section to view all of your subscription plans. + + + + Each subscription shows: + * **Plan name**: The type of subscription (e.g., Pieces Pro Plan Yearly, Pieces Pro Plan Monthly) + * **Status**: Active (green badge) or Canceled (red badge) + * **Renewal information**: Auto-renewal date for active plans or cancellation date for canceled plans + + + +### Managing Your Subscription + +[Access the billing dashboard](/products/paid-plans/manage-subscription) to update payment methods, view invoices, and manage your subscription settings. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Account`. + + + + Scroll down to the *Personal Subscription(s)* section. + + + + Click the `Manage` button (document with checkmark icon) next to your subscription to open the [billing dashboard](/products/paid-plans/manage-subscription). + + + + In the [billing dashboard](/products/paid-plans/manage-subscription), you can: + * Update your payment method + * View and download invoices + * Change your subscription plan + * Cancel your subscription + + + +### Refreshing Subscription Status + +Manually refresh your subscription status if it doesn't appear up to date. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Account`. + + + + Scroll down to the *Personal Subscription(s)* section. + + + + Click the `Refresh` button (circular arrow icon) to manually sync your subscription status with the latest information from the billing system. + + + +### Getting Help with Subscriptions + +Access support resources for subscription and billing questions. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Account`. + + + + Scroll down to the *Personal Subscription(s)* section. + + + + Click the `Get Help` button (question mark icon) to access support resources for subscription and billing questions, including payment issues, plan changes, and account management. + + + +## Personal Cloud + +Configure cloud synchronization, backups, and your personal domain. This keeps your materials and workflow history available wherever you work. Pieces can run entirely offline, but connecting to Pieces Cloud enables real-time syncing and access across devices. + +### Cloud Status + +View your cloud connection status and when it was last updated. The status indicator shows whether your Personal Cloud is connected or disconnected, along with a timestamp of the last update. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Account`. + + + + Scroll down to the *Personal Cloud* section to view your connection status. + + + + You'll see your connection status: + * **Connected**: Shows "Status: Connected" with a green dot, along with "Last updated [time]" + * **Disconnected**: Shows "Status: Disconnected" with a gray dot + + + +### Connecting to Personal Cloud + +Connect to your Personal Cloud to enable cloud synchronization, backups, and sharing features. When you connect, Pieces will automatically sync if you already have a cloud account, or create a new cloud for you. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Account`. + + + + Scroll down to the *Personal Cloud* section. + + + + When your cloud is disconnected, click the `Cloud Icon` to the right of the status indicator to connect to your Personal Cloud. + + + + Pieces will automatically sync your data if you already have a cloud account, or create a new cloud account for you. Once connected, your status will update to "Connected" and you'll have access to all cloud features. + + + + + Any material saved in *Pieces Drive* or marked as a snippet is backed up. There are *no storage limits* on cloud-synced data. + + +### Disconnecting Personal Cloud + +Disconnect from your Personal Cloud at any time to disable cloud synchronization and features. You can reconnect later if needed. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Account`. + + + + Scroll down to the *Personal Cloud* section. + + + + When your cloud is connected, click the `Disconnect Cloud Icon` (cloud with diagonal line) to disconnect from your Personal Cloud. + + + + Confirm the disconnection when prompted. Once disconnected, cloud features will be disabled and your status will show as "Disconnected". + + + +Before disconnecting, keep in mind that several features require connectivity to your Personal Cloud: + +* **Sharing (beta)**: The ability to generate and share links for saved materials from Pieces Drive +* **Cloud ML**: Cloud-based enrichment of metadata for saved materials +* **Cloud Backup**: The automatic synchronization of your data to Pieces Cloud +* **Cloud Integrations**: Your Pieces Cloud which controls your personal subdomain and other integrations + +### Personal Domain + +Customize your personal subdomain to create a unique URL for sharing your materials. Your personal domain is used when generating shareable links for your saved materials. + +When you're connected to Pieces Cloud, you're assigned a personal subdomain (e.g., `yourname.pieces.cloud`) for sharing snippets. This subdomain isn't publicly browsable like a profile page—instead, it's prepended to any URLs you generate when sharing saved materials. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Account`. + + + + Scroll down to the *Personal Cloud* section. + + + + Find the *Personal Cloud Domain* section, which shows your current domain status and the text input field. + + + + In the text input field, enter the custom text you want to use before `.pieces.cloud`. For example, entering "nolanworksat" will create `nolanworksat.pieces.cloud`. + + + + Your domain will update automatically. The section will show "Your domain [your_custom_url].pieces.cloud is running" when active. + + + +### Backup & Restore Data + +Create manual backups of your data for long-term storage and recovery. These backups are stored in your personal Pieces cloud and can be restored or deleted at any time. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Account`. + + + + Scroll down to the *Personal Cloud* section. + + + + In the *Backup & Restore Data* section, click the `Restore Icon` (Circular Arrow Icon) to open the *Backup & Restore Data* modal. + + + +#### Creating a Backup + +Create a manual backup snapshot of your data. Backups are stored in your personal Pieces cloud and include all your saved materials, settings, and preferences. + + + + Click your `User Profile` in the top left, hover over `Settings`, select `Account`, then scroll to the *Personal Cloud* section and click the `Restore Icon` in the *Backup & Restore Data* section. + + + + In the modal, find the *Create Backup* section, which shows "Backups will be stored in your personal Pieces cloud". + + + + Click the `Cloud Icon with Upward Arrow` to create a new backup. The backup will be created and uploaded to your personal Pieces cloud. + + + +#### Backup Contents + +A Pieces backup contains the following data: + +| **Data Type** | **Summary** | +| ----------------------- | ----------------------------------------------------------------- | +| *Snippets* | All saved code snippets and related metadata. | +| *Pieces Drive Files* | Any files stored in Pieces Drive. | +| *User Preferences* | Theme, UI settings, and personalization options. | +| *Pieces Copilot Data* | Recent chat history and AI context for Pieces Copilot. | +| *Search & Tagging Data* | User-defined tags and previous searches for quick retrieval. | +| *Account Connections* | Linked GitHub, Google, or Microsoft accounts (without passwords). | + + + Backups *do not include* Pieces Cloud data that is already synced or external files which are not explicitly stored in Pieces Drive. + + +#### Viewing Your Backups + +See all of your available backups with details about when they were created, their size, the device they were created on, and the PiecesOS version at the time of backup. + + + + Click your `User Profile` in the top left, hover over `Settings`, select `Account`, then scroll to the *Personal Cloud* section and click the `Restore Icon` in the *Backup & Restore Data* section. + + + + Scroll down to the *Backups* section, which shows the total number of backups and lists each backup with: + * **Date and time**: When the backup was created (e.g., "Mon, Dec 8, 2025 9:41 AM") + * **Size**: The backup file size (e.g., "342.85 MB") + * **Device**: The device name where the backup was created (e.g., "Judsons MacBook Air") + * **OS Version**: The PiecesOS version at the time of backup (e.g., "PiecesOS v12.3.3") + + + +#### Restoring a Backup + +Restore a previous backup to recover all saved materials, settings, and preferences. This will return Pieces Drive and the Pieces Desktop App to the state captured in that backup. + + + + Click your `User Profile` in the top left, hover over `Settings`, select `Account`, then scroll to the *Personal Cloud* section and click the `Restore Icon` in the *Backup & Restore Data* section. + + + + In the *Backups* section, find the backup you want to restore from the list. + + + + Click the `Restore Icon` (Refresh/Circular Arrow Icon) on the right side of the backup entry to restore that backup. + + + + Confirm the restoration when prompted. All saved materials, settings, and preferences will be restored to the state captured in that backup. + + + +#### Deleting a Backup + +Remove old backups that you no longer need. Deleted backups cannot be restored—this is a permanent deletion. + + + + Click your `User Profile` in the top left, hover over `Settings`, select `Account`, then scroll to the *Personal Cloud* section and click the `Restore Icon` in the *Backup & Restore Data* section. + + + + In the *Backups* section, find the backup you want to delete from the list. + + + + Click the `Trash Icon` on the right side of the backup entry to delete that backup. + + + + Confirm the deletion when prompted. The backup will be permanently removed and cannot be restored. + + + +### Cloud Syncing + +Cloud syncing is optional—you can use Pieces entirely offline if you prefer. Once connected, syncing happens automatically in real time, keeping your data synchronized across all your devices. The only way to disable syncing is by disconnecting from Pieces Cloud. + +When connected, your data is automatically synchronized in real time across all devices where you're signed in. This includes snippets, Pieces Drive files, settings, and workflow history. + +## Privacy + +Configure telemetry and diagnostics settings to help improve Pieces. Share anonymous telemetry and crash data to help the Pieces team build better developer tools across macOS, Linux, and Windows. + +### Telemetry & Diagnostics + +Enable or disable anonymous telemetry and crash data collection. Building next generation Developer Tools across macOS, Linux, and Windows is hard! Share anonymous telemetry and crash data to help improve Pieces. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Account`. + + + + Scroll down to the *Privacy* section. + + + + Find the "Telemetry & Diagnostics" option with a checkbox. + + + + Check or uncheck the `Checkbox` next to "Telemetry & Diagnostics" to enable or disable anonymous telemetry and crash data collection. + + + + + Participating in telemetry helps Pieces evolve more effectively, but you can opt out for greater privacy. Read more about compliance, privacy, and security [here](/products/privacy-security-your-data), and as always feel free to reach out to our team on [Discord](https://discord.gg/getpieces), [GitHub](https://github.com/pieces-app), or at support@pieces.app. + + +*** + +## Next Steps + +Now that you understand how to manage your account, learn about [Long-Term Memory](/products/desktop/configuration/long-term-memory) to configure memory preferences, or explore [Models](/products/desktop/configuration/models) to manage AI models and model preferences. diff --git a/public/content/desktop/configuration/appearance.md b/public/content/desktop/configuration/appearance.md new file mode 100644 index 0000000..2e52e91 --- /dev/null +++ b/public/content/desktop/configuration/appearance.md @@ -0,0 +1,168 @@ +--- +title: Appearance +path: /desktop/configuration/appearance +visibility: PUBLIC +status: PUBLISHED +description: Customize theme, colors, and visual appearance. +metaTitle: Appearance Settings in Pieces Desktop +metaDescription: Customize theme mode, accent colors, font settings, and visual density in Pieces Desktop. +--- + +## Appearance Settings + +Customize the visual appearance of the Pieces Desktop App, including theme mode, accent colors, font size, font weight, and visual density. Adjust these settings to match your preferences and create a comfortable work environment. + +To access Appearance settings, click your `User Profile` in the top left, then hover over `Settings` and select `Appearance`. + + + +> Appearance settings showing Theming, Fonts, and Spacing sections + + + Theme changes are automatically saved when adjusted, and settings are stored locally, not synced with Pieces Cloud. + + +## Theming + +Customize the overall theme and accent color of the Pieces interface. Choose between dark, light, or system themes, and select an accent color that matches your preferences. + +### Theme Mode + +Choose how Pieces displays its theme. You can select Dark, Light, or System mode, which automatically matches your operating system's theme preference. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Appearance`. + + + + In the *Theming* section, find the "Theme Mode" option showing your current mode (e.g., "Theme Mode: System"). + + + + Click the `Dropdown Arrow` next to the current theme mode to open the theme options. + + + + Choose from the following options: + * **Dark**: Dark theme for low-light environments + * **Light**: Light theme for bright environments + * **System**: Automatically matches your operating system's theme preference + + + +### Accent Color + +Customize the accent color used throughout the Pieces interface. The accent color affects interactive elements like buttons and highlights, but not the entire UI. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Appearance`. + + + + In the *Theming* section, find the "Accent Color" option showing your current color (e.g., "Accent Color: Blue") with a color swatch. + + + + Click the `Dropdown Arrow` next to the accent color to open the color picker, which displays a grid of available colors. + + + + Click on any color in the grid to select it. The selected color will be marked with a checkmark, and your accent color will update immediately. + + + +## Fonts + +Adjust the size and weight of text throughout the Pieces Desktop App to improve readability and match your preferences. + +### Font Size + +Adjust the size of all text in the Pieces Desktop App. This is helpful for different screen sizes, resolutions, or if you prefer larger or smaller text for readability. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Appearance`. + + + + In the *Fonts* section, find the "Font Size" option showing your current size (e.g., "Font Size: 100%"). + + + + Use the controls to change the font size: + * Click the `Minus Button` (`-`) to decrease the font size + * Click the `Plus Button` (`+`) to increase the font size + * The current percentage is displayed between the buttons + + + + + You can also use keyboard shortcuts to zoom: `⌘+,+` (macOS) or `ctrl+,+` (Windows/Linux) to zoom in, and `⌘+,-` (macOS) or `ctrl+,-` (Windows/Linux) to zoom out. + + +### Font Weight + +Adjust the thickness of text throughout the Pieces Desktop App. Choose from Thin, Normal, Medium, or Bold to match your reading preferences. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Appearance`. + + + + In the *Fonts* section, find the "Font Weight" option showing your current weight (e.g., "Font Weight: Normal"). + + + + Click the `Dropdown Arrow` next to the current font weight to open the font weight options. + + + + Choose from the following options: + * **Thin**: Lightest font weight for minimal visual weight + * **Normal**: Standard font weight (default) + * **Medium**: Slightly bolder than normal + * **Bold**: Heaviest font weight for maximum emphasis + + + +## Spacing + +Adjust the spacing and layout density of the Pieces interface. Control how much information is displayed and how much space elements take up. + +### Visual Density + +Adjust the spacing and layout density of the Pieces interface. Choose between Tight, Compact, or Standard to control how much information is displayed and how much space elements take up. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Appearance`. + + + + In the *Spacing* section, find the "Visual Density" option showing your current density (e.g., "Visual Density: Standard"). + + + + Click the `Dropdown Arrow` next to the current visual density to open the density options. + + + + Choose from the following options: + * **Tight**: Maximum density with minimal spacing, showing more content in less space + * **Compact**: Moderate density with reduced spacing + * **Standard**: Default density with comfortable spacing (default) + + + + + Controls spacing, padding, and overall compactness of the interface. Tight = minimal spacing, Compact = balanced, Standard = generous spacing. + + +*** + +## Next Steps + +Now that you understand how to customize Appearance, learn about [Models](/products/desktop/configuration/models) to configure AI models and processing modes, or explore [Troubleshooting](/products/desktop/configuration/troubleshooting) to access support resources and view app information. diff --git a/public/content/desktop/configuration/connected-applications.md b/public/content/desktop/configuration/connected-applications.md new file mode 100644 index 0000000..6902992 --- /dev/null +++ b/public/content/desktop/configuration/connected-applications.md @@ -0,0 +1,67 @@ +--- +title: Connected Applications +path: /desktop/configuration/connected-applications +visibility: PUBLIC +status: PUBLISHED +description: Access documentation and get started guides for all available Pieces integrations and extensions. +metaTitle: Connected Applications Settings in Pieces Desktop +metaDescription: Access documentation and get started guides for all available Pieces integrations and extensions. +--- + +## Connected Applications Settings + +Access documentation and get started guides for all available Pieces integrations and extensions. Connect Pieces with your favorite IDEs, editors, and development tools to enhance your workflow with AI-powered assistance. + +To access Connected Applications settings, click your `User Profile` in the top left, then hover over `Settings` and select `Connected Applications`. + + + +> Connected Applications settings showing list of available integrations with links to documentation + +## Available Applications + +The Connected Applications page displays all available Pieces integrations and extensions. Each application includes a link to its documentation and get started guide. + + + + Get started with the Pieces JetBrains plugin for IntelliJ IDEA, PyCharm, and other JetBrains IDEs. + + + + Get started with the Pieces extension for Visual Studio. + + + + Get started with the Pieces plugin for Sublime Text. + + + + Get started with the Pieces extension for Visual Studio Code. + + + + Access comprehensive documentation for the Pieces Command Line Interface. + + + + Access comprehensive documentation for the Pieces Desktop App. + + + + Get started with the Pieces plugin for Obsidian. + + + + Access comprehensive documentation for the Pieces JupyterLab extension. + + + + Access comprehensive documentation for the Pieces Raycast extension. + + + +*** + +## Next Steps + +Now that you've explored the available integrations, choose an application to get started. Most integrations require [PiecesOS](/products/core-dependencies/pieces-os) to be installed, and we recommend the [Pieces Desktop App](/products/desktop) for enhanced functionality. diff --git a/public/content/desktop/configuration/copilot-chats.md b/public/content/desktop/configuration/copilot-chats.md new file mode 100644 index 0000000..384ecb3 --- /dev/null +++ b/public/content/desktop/configuration/copilot-chats.md @@ -0,0 +1,85 @@ +--- +title: Copilot Chats +path: /desktop/configuration/copilot-chats +visibility: PUBLIC +status: PUBLISHED +description: Customize your Pieces Copilot chat appearance and manage your chat history. +metaTitle: Copilot Chats Settings in Pieces Desktop +metaDescription: Customize your Pieces Copilot chat accent color and manage your chat history by deleting all chats. +--- + +## Copilot Chats Settings + +Customize your Pieces Copilot chat appearance and manage your chat history. Configure the accent color for your chats and delete all chats when needed. + +To access Copilot Chats settings, click your `User Profile` in the top left, then hover over `Settings` and select `Copilot Chats`. + + + +> Copilot Chats settings showing accent color option and delete all chats option + +## Accent Color + +Change the accent color used in your Pieces Copilot chats. The accent color affects the visual appearance of chat elements and helps personalize your chat interface. + +### Changing Accent Color + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Copilot Chats`. + + + + At the top of the Copilot Chats settings, you'll see the "Accent Color" option showing your current color (e.g., "Accent Color: Blue") with a color swatch and Dropdown Arrow. + + + + Click the `Dropdown Arrow` next to the accent color to open the color picker, which displays a grid of 36 available colors. + + + + Click on any color in the grid to select it. The selected color will be marked with a checkmark, and your accent color will update immediately. + + + + + +> Color picker showing grid of 36 colors with selected color marked with Checkmark + +## Delete All Copilot Chats + +Remove all of your Pieces Copilot chat history at once. This action permanently deletes all chats and cannot be undone. + +### Understanding Chat Deletion + +Deleting all Copilot chats permanently removes your entire chat history. This includes all conversations, messages, and context from previous chats. The total number of chats is displayed below the delete option (e.g., "45 Total Copilot Chats"). + +### Deleting All Chats + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Copilot Chats`. + + + + Scroll down to find the "Delete All Copilot Chats..." option, which displays a red Trash Icon to the right. + + + + Click the `Trash Icon` to delete all of your Copilot chats. + + + + Confirm the deletion when prompted. All chats will be permanently removed and cannot be restored. + + + + + Deleting all Copilot chats is a permanent action that cannot be undone. All chat history, conversations, and context will be permanently removed. + + +*** + +## Next Steps + +Now that you understand how to customize Copilot Chats, learn about [Models](/products/desktop/configuration/models) settings to configure processing modes and manage AI models, or explore [Model Context Protocol (MCP)](/products/desktop/configuration/mcp) to integrate Pieces with other tools. diff --git a/public/content/desktop/configuration/long-term-memory.md b/public/content/desktop/configuration/long-term-memory.md new file mode 100644 index 0000000..d11b60e --- /dev/null +++ b/public/content/desktop/configuration/long-term-memory.md @@ -0,0 +1,155 @@ +--- +title: Long-Term Memory +path: /desktop/configuration/long-term-memory +visibility: PUBLIC +status: PUBLISHED +description: Manage long-term memory preferences and data. +metaTitle: Long-Term Memory Settings in Pieces Desktop +metaDescription: Manage long-term memory preferences, app access control, system permissions, and stored data. +--- + +## Long-Term Memory Settings + +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. + +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 showing Memory Formation, Performance, and Stored Data sections + +## Memory Formation + +Configure how the Long-Term Memory Engine captures and processes your workflow context. The Long-Term Memory (LTM-2.7) Engine uses on-device machine learning to auto-generate Workstream Activities and provide temporal context for your Conversational Search. + +### Long-Term Memory Engine + +Toggle the Long-Term Memory Engine on or off to control whether Pieces captures and uses your workflow context. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Long-Term Memory`. + + + + In the *Memory Formation* section, find the "Long-Term Memory Engine" option showing your current status (e.g., "Long-Term Memory Engine: On" with a green indicator). + + + + Click the toggle or button to enable or disable the Long-Term Memory Engine. When enabled, it uses on-device machine learning to auto-generate Workstream Activities and provide temporal context for your Conversational Search. + + + + + The Long-Term Memory Engine helps Pieces understand your workflow patterns and provide more contextual suggestions in Conversational Search. When disabled, Pieces won't capture or use workflow context. + + +### App Access Control + +Manage which applications the Long-Term Memory Engine interacts with. This allows you to control what data sources Pieces uses when capturing workflow context. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Long-Term Memory`. + + + + In the *Memory Formation* section, find the "App Access Control" option with the description "Manage apps that Long-Term Memory interacts with". + + + + Click the `Dropdown Arrow` or icon next to "App Access Control" to manage which applications the Long-Term Memory Engine interacts with. + + + + Enable or disable specific applications that you want Long-Term Memory to capture data from. Applications that are enabled will have their workflow context captured and indexed. + + + +### System Permissions + +Manage accessibility and screen permissions for the Long-Term Memory Engine. If permissions are not already enabled, you can provide the necessary permissions to Pieces. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Long-Term Memory`. + + + + In the *Memory Formation* section, find the "System Permissions" option with the description "Manage accessibility and screen permissions for LTM". + + + + Click the `Permissions Icon` to open the permissions settings. If permissions are not already enabled, you'll be prompted to provide the necessary permissions to Pieces. + + + + Follow the system prompts to grant the required accessibility and screen permissions that allow the Long-Term Memory Engine to capture workflow context. + + + +## Performance + +Optimize system resources and manage memory usage for the Long-Term Memory Engine. + +### Optimize System RAM Usage + +Unload local machine learning models and resources from memory to free up system resources. This is useful if you need to reduce memory usage or free up resources for other applications. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Long-Term Memory`. + + + + Scroll down to the *Performance* section. + + + + Click the `Optimize System RAM Usage` button (CPU/Microchip Icon) to unload local machine learning models and resources from memory. + + + + + Optimizing memory usage can help free up system resources, but you may need to reload models when you next use features that require them, which may take a moment. + + +## Stored Data + +Manage and clear persisted data captured by the Long-Term Memory Engine. + +### Clearing Long-Term Memory Data + +Remove persisted data captured by the Long-Term Memory Engine for a specific time range. This allows you to clear workflow context while keeping the engine enabled. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Long-Term Memory`. + + + + Scroll down to the *Stored Data* section, find the "Clear LTM Data..." option. + + + + Click the `Trash Icon` next to "Clear LTM Data..." to open the clearing options. + + + + Choose the time range for the data you want to clear (e.g., last 7 days, last 30 days, all time). + + + + Confirm the clearing action when prompted. The selected Long-Term Memory Engine data will be permanently removed. + + + + + Clearing Long-Term Memory data is a permanent action that cannot be undone. This will remove workflow context captured during the selected time range. + + +*** + +## Next Steps + +Now that you understand how to manage Long-Term Memory settings, learn about [Models](/products/desktop/configuration/models) to configure AI models and processing modes, or explore [Conversational Search](/products/desktop/conversational-search) to query your workflow memories and get AI-powered insights. diff --git a/public/content/desktop/configuration/mcp.md b/public/content/desktop/configuration/mcp.md index a91daf9..90d318a 100644 --- a/public/content/desktop/configuration/mcp.md +++ b/public/content/desktop/configuration/mcp.md @@ -1,55 +1,100 @@ --- -title: Model Context Protocol (MCP) Servers +title: Model Context Protocol (MCP) path: /desktop/configuration/mcp visibility: PUBLIC status: PUBLISHED -description: The Model Context Protocol (MCP) settings let you configure and manage MCP integration with PiecesOS, enabling connectivity between Large Language Models (LLMs) and your personal context stored by the Long-Term Memory Engine (LTM-2.7). -metaTitle: Configure Pieces MCP Settings -metaDescription: Access the Model Context Protocol (MCP) tab within the Settings View of the Desktop App, where you can find the latest SSE URL for integrating into your favorite tools. +description: Access MCP server URLs and documentation to integrate Pieces Long-Term Memory with Cursor, GitHub Copilot, and other tools. +metaTitle: Model Context Protocol (MCP) Settings in Pieces Desktop +metaDescription: Access MCP server URLs and documentation to integrate Pieces Long-Term Memory with Cursor, GitHub Copilot, and other tools. --- -## Accessing MCP Settings +## Model Context Protocol (MCP) Settings -To access the MCP configuration screen, click the **Settings** gear icon located in the bottom-left corner of the Pieces Desktop App’s main view. +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 (LTM-2.7). -From there, navigate to **Model Context Protocol (MCP)**. +To access MCP settings, click your `User Profile` in the top left, then hover over `Settings` and select `MCP`. -Inside this tab, you can view the server URL, check the MCP server version, and quickly access MCP documentation. + - +> Model Context Protocol (MCP) settings showing server URLs and View Documentation option -### MCP Server URLs +## Available Servers -In the MCP Settings, you'll find the **Server URLs** section. +Copy the server URLs to configure MCP integrations in compatible IDEs and code editors. Multiple server URLs are available, including the latest schema version and previous versions for compatibility. -This URL is what your development tools or AI applications, such as [Cursor](/products/mcp/cursor) or [GitHub Copilot](/products/mcp/github-copilot), will use to communicate directly with your local PiecesOS MCP server. +### Understanding Server URLs -You can copy this URL by clicking the *copy* icon next to the URL text box and use it to configure integrations in compatible IDEs and code editors. +The MCP settings display server URLs that your development tools or AI applications, such as [Cursor](/products/mcp/cursor) or [GitHub Copilot](/products/mcp/github-copilot), will use to communicate directly with your local PiecesOS MCP server. -### MCP Server Version + + Copy the server URL below and paste it into your MCP client configuration. The latest schema version may not be compatible with all MCP clients yet. If you experience connection issues, try using an earlier version or restarting your MCP client. For the best results, try using with Cursor or Claude. + -The version displayed under the server URL indicates the currently running MCP protocol version. +### Copying Server URLs -Ensure your [tools and integrations](/products/mcp/get-started#getting-started) are compatible with this version to maintain smooth communication. + + + Click your `User Profile` in the top left, then hover over `Settings` and select `MCP`. + -### View MCP Documentation + + In the *Available Servers* section, you'll see server URLs displayed, each with a Copy Icon to the right. + -Click `View Documentation` to access detailed guides that explain how to leverage MCP integrations with popular development environments, such as Cursor and GitHub Copilot. + + The latest schema URL is marked with a blue "LATEST SCHEMA" badge. Click the `Copy Icon` next to the URL to copy it to your clipboard. The URL format is `http://localhost:39300/model_context_protocol/2025-03-26/mcp` with the release date displayed below it. + -This documentation covers setup instructions, example scenarios, and troubleshooting tips for efficient MCP usage. + + If you need compatibility with older MCP clients, you can copy a previous version URL (e.g., `http://localhost:39300/model_context_protocol/2024-11-05/sse`). Click the `Copy Icon` next to the URL you need. + -Here are quick examples of how MCP enhances your coding and debugging experiences: + + Paste the copied URL into your IDE or tool's MCP configuration. Use the latest schema URL for the most up-to-date features, or use an earlier version if you encounter compatibility issues. + + -* **Context-Rich Debugging**: Instantly retrieve logs, historical debugging notes, or team discussions directly from PiecesOS when troubleshooting within Cursor. + + The release date displayed under each server URL indicates when that schema version was released. The latest schema version provides the most current features, but older versions may be more compatible with certain MCP clients. + -* **Contextual Queries**: Access historical code implementations, error resolutions, or previously encountered bugs within GitHub Copilot for quicker coding solutions. +## View Documentation -For more use cases, refer to this [MCP documentation.](/products/mcp/get-started) +Access detailed guides that explain how to leverage MCP integrations with popular development environments, such as Cursor and GitHub Copilot. -*** +### Opening MCP Documentation + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `MCP`. + + + + Scroll to the *View Documentation* section, which displays: "Learn how to use Long-Term Memories with Cursor, GitHub Copilot and other tools using our MCP server." + + + + Click the `Documentation Icon` (book icon) to open the MCP documentation, which covers setup instructions, example scenarios, and troubleshooting tips for efficient MCP usage. + + + +The documentation provides comprehensive guides on: + +* **Setting Up Integrations**: Step-by-step instructions for configuring MCP in Cursor, GitHub Copilot, and other tools +* **Use Cases**: Examples of how MCP enhances your coding and debugging experiences +* **Troubleshooting**: Solutions for common integration issues and configuration problems -*Pieces MCP → Cursor* +### Example Use Cases + +MCP enhances your coding and debugging experiences in several ways: + +* **Context-Rich Debugging**: Instantly retrieve logs, historical debugging notes, or team discussions directly from PiecesOS when troubleshooting within Cursor +* **Contextual Queries**: Access historical code implementations, error resolutions, or previously encountered bugs within GitHub Copilot for quicker coding solutions + +For more use cases and detailed setup instructions, refer to the [MCP documentation](/products/mcp/get-started). + +*** - +## Next Steps -*** \ No newline at end of file +Now that you understand how to access MCP server URLs and documentation, learn how to [set up MCP with Cursor](/products/mcp/cursor) or [integrate with GitHub Copilot](/products/mcp/github-copilot) to start using Pieces Long-Term Memory in your development workflow. diff --git a/public/content/desktop/configuration/models.md b/public/content/desktop/configuration/models.md new file mode 100644 index 0000000..b32e42c --- /dev/null +++ b/public/content/desktop/configuration/models.md @@ -0,0 +1,232 @@ +--- +title: Models +path: /desktop/configuration/models +visibility: PUBLIC +status: PUBLISHED +description: Manage AI models and model preferences. +metaTitle: Models Settings in Pieces Desktop +metaDescription: Manage AI models, configure processing modes, set up local model runtime, and enable or disable specific models. +--- + +## Models Settings + +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. + +To access Models settings, click your `User Profile` in the top left, then hover over `Settings` and select `Models`. + + + +> Models settings showing Model Capabilities, Local Model Runtime, and Model Management sections + +## Model Capabilities + +Configure how Pieces processes your materials using machine learning resources. Choose between Cloud, Local, or Blended processing modes based on your performance and privacy preferences. + +### Processing Mode + +Choose how Pieces processes your materials using machine learning resources. You can select Cloud, Local, or Blended processing modes based on your performance and privacy preferences. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Models`. + + + + In the *Model Capabilities* section, find the "Processing Mode" option showing your current mode (e.g., "Processing Mode: Blended"). + + + + Click the `Dropdown Arrow` next to the current processing mode to open the mode options. + + + + Choose from the following options: + * **Cloud**: Optimized for speed, but all data gets sent to the cloud for processing + * **Local**: Most processing happens locally before reaching out to the selected model, providing better privacy + * **Blended**: Uses a combination of local and cloud resources, balancing speed and privacy + + + + + Selecting the processing mode that best fits your security and performance needs ensures that Pieces processes your materials in the most efficient or privacy-conscious way possible. + + +## Local Model Runtime + +Set up and manage Ollama for local model processing. Ollama allows you to run AI models locally on your device without sending data to the cloud. + +### Ollama Status + +Check if Ollama is installed, activated, and ready to use. Ollama must be installed and running for local model processing to work. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Models`. + + + + Scroll down to the *Local Model Runtime* section. + + + + View the Ollama status: + * **Activated and Ready**: Shows "Ollama is Activated and Ready" with a green checkmark and version number (e.g., "Version: 0.5.5") + * **Not Installed**: Shows options to install Ollama + * **Not Running**: Shows options to start Ollama + + + +### Installing Ollama + +If Ollama is not installed, you can install it directly from the Models settings page. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Models`. + + + + Scroll down to the *Local Model Runtime* section. + + + + If Ollama is not installed, click the `Install` button or link to download and install Ollama. + + + + Follow the installation prompts to complete the Ollama installation. Once installed, Ollama will automatically activate and be ready to use. + + + +## Model Management + +Enable or disable models to control which AI models are available for use in Pieces. Disabled models will not appear in chat or other features. Models disabled by an organization will not appear here. + +### Understanding Model Management + +Pieces supports a wide variety of AI models from different providers. By default, the most popular models are enabled, but you can customize which models are available based on your needs and preferences. + +### Viewing Enabled Models + +See how many models are currently enabled and which providers they belong to. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Models`. + + + + Scroll down to the *Model Management* section. + + + + At the top of the *Model Management* section, you'll see a count showing how many models are enabled out of the total available (e.g., "3 of 68 models enabled"). + + + +### Searching Models + +Search for specific models or providers to quickly find what you're looking for. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Models`. + + + + In the *Model Management* section, find the search bar with the placeholder "Search models...". + + + + Type the name of a model or provider in the search bar to filter the list of available models. + + + +### Enabling or Disabling Models + +Control which models are available by enabling or disabling them individually or by provider. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Models`. + + + + In the *Model Management* section, find the model provider you want to configure (e.g., OpenAI, Anthropic, Google, Microsoft, Meta, IBM). + + + + Click the arrow next to the provider name to expand and see all available models from that provider. + + + + Use the toggle switch on the right side of each model or provider to enable or disable it. Green indicates enabled, gray indicates disabled. + + + + + +> Models settings showing how to enable a model using the toggle switch + +### Deleting Local Models + +Remove local models that you no longer need. This frees up storage space on your device. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Models`. + + + + In the *Model Management* section, find the local model you want to delete. Local models are typically from providers like Ollama or other local runtime environments. + + + + Click the delete icon or option next to the local model to remove it from your device. + + + + + +> Models settings showing how to delete a local model + +### Enabling All Models + +Quickly enable all available models at once. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Models`. + + + + In the *Model Management* section, find the "Enable All" option with a checkmark icon. + + + + Click `Enable All` to enable all available models. This will make all models from all providers available for use. + + + +### Model Providers + +Pieces supports models from multiple providers. Each provider shows how many of its models are enabled: + +* **OpenAI**: GPT models and other OpenAI models +* **Anthropic**: Claude models +* **Google**: Gemini and other Google models +* **Microsoft**: Azure OpenAI and other Microsoft models +* **Meta**: Llama and other Meta models +* **IBM**: Watson and other IBM models + +Each provider can be expanded to see individual models, and you can enable or disable models individually or toggle the entire provider on or off. + +### Compatible Models + +For a complete list of all compatible models and their capabilities, see the [Compatible LLMs](/products/large-language-models) documentation. This page provides detailed information about cloud models, local models, and which models work best for different use cases. + +*** + +## Next Steps + +Now that you understand how to manage models, learn about [Long-Term Memory](/products/desktop/configuration/long-term-memory) to configure memory preferences, or explore [Model Context Protocol (MCP)](/products/desktop/configuration/mcp) to integrate Pieces with other tools. For a complete list of available models, see [Compatible LLMs](/products/large-language-models). diff --git a/public/content/desktop/configuration/troubleshooting.md b/public/content/desktop/configuration/troubleshooting.md new file mode 100644 index 0000000..980d0e3 --- /dev/null +++ b/public/content/desktop/configuration/troubleshooting.md @@ -0,0 +1,282 @@ +--- +title: Troubleshooting +path: /desktop/configuration/troubleshooting +visibility: PUBLIC +status: PUBLISHED +description: Get help, troubleshoot issues, view app information, and contact support. +metaTitle: Troubleshooting Settings in Pieces Desktop +metaDescription: Access support resources, documentation, feedback channels, version information, and troubleshooting help in Pieces Desktop. +--- + +## Troubleshooting Settings + +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. + +To access Troubleshooting settings, click your `User Profile` in the top left, then hover over `Settings` and select `Troubleshooting`. + + + +> Troubleshooting settings showing Online Resources, Get In Touch, PiecesOS Information, and Desktop App Information sections + +## Online Resources + +Access documentation and community resources to find answers and solutions to common issues. + +### Product Documentation + +Access Pieces' official documentation to learn how to use features, configure settings, and get the most out of Pieces. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Troubleshooting`. + + + + Scroll to the *Online Resources* section. + + + + Click the `Product Documentation` option (book icon) to open Pieces' official documentation in your browser. + + + +### GitHub Issues + +Report bugs, request features, and track known issues on GitHub. The GitHub issues page is a great place to see what others are experiencing and contribute to improving Pieces. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Troubleshooting`. + + + + Scroll to the *Online Resources* section. + + + + Click the `GitHub Issues` option (GitHub Octocat logo icon) to open the Pieces GitHub issues page in your browser. + + + +## Get In Touch + +Contact the Pieces team directly for personalized support, feedback, or additional help resources. + +### Book a Support Call + +Schedule a one-on-one support call with our team to get personalized assistance with any issues or questions you have. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Troubleshooting`. + + + + Scroll to the *Get In Touch* section. + + + + Click the `Book a Support Call` option (calendar icon) to schedule a support call with the Pieces team. + + + +### Contact Us + +Send us a message and our team will get back to you. Use this option for general questions, feedback, or issues that don't require immediate attention. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Troubleshooting`. + + + + Scroll to the *Get In Touch* section. + + + + Click the `Contact Us` option (envelope icon) to send a message to the Pieces support team. + + + +### More Options + +Visit our support hub for additional resources, FAQs, and community support. This provides access to a comprehensive knowledge base and community forums. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Troubleshooting`. + + + + Scroll to the *Get In Touch* section. + + + + Click the `More Options` option (external link icon) to visit the support hub with additional resources, FAQs, and community support. + + + +## PiecesOS Information + +View information about your installed PiecesOS version, check for updates, and see what port PiecesOS is using. PiecesOS is the core engine that powers all Pieces functionality. + +### Viewing PiecesOS Version + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Troubleshooting`. + + + + Scroll to the *PiecesOS Information* section. + + + + Find the "Version" field showing your installed PiecesOS version (e.g., "12.3.5"). + + + + Click the `Copy Icon` next to the PiecesOS version to copy the version number to your clipboard. + + + +### Viewing PiecesOS Port + +View the port number that PiecesOS is currently using. This information is useful for troubleshooting connection issues or configuring integrations. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Troubleshooting`. + + + + Scroll to the *PiecesOS Information* section. + + + + Find the "Port" field showing the current port (e.g., "39300"). + + + + Click the `Copy Icon` next to the PiecesOS port to copy the port number to your clipboard. + + + +### Checking for PiecesOS Updates + +Manually check if a new version of PiecesOS is available. Updates may include bug fixes, performance improvements, and new features. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Troubleshooting`. + + + + Scroll to the *PiecesOS Information* section. + + + + Click the `Check for PiecesOS Updates` link (server rack with refresh arrow icon) to manually trigger an update check. If an update is available, you'll be prompted to install it. + + + +## Desktop App Information + +View information about your installed Pieces Desktop App version, check for updates, and see your platform details. The Desktop App provides the user interface and features built on top of PiecesOS. + +### Viewing Desktop App Version + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Troubleshooting`. + + + + Scroll to the *Desktop App Information* section. + + + + Find the "Version" field showing your installed Desktop App version (e.g., "5.0.6-staging"). + + + + Click the `Copy Icon` next to the Desktop App version to copy the version number to your clipboard. + + + +### Viewing Platform Information + +View your operating system and platform details. This information is useful for troubleshooting or when seeking support. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Troubleshooting`. + + + + Scroll to the *Desktop App Information* section. + + + + Find the "Platform" field showing your OS version and build information (e.g., "MacOS Version 15.7.3 (Build 24G419)"). + + + + Click the `Copy Icon` next to the Platform information to copy the platform details to your clipboard. + + + +### Checking for Desktop App Updates + +Manually check if a new version of the Pieces Desktop App is available. Updates may include new features, UI improvements, and bug fixes. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Troubleshooting`. + + + + Scroll to the *Desktop App Information* section. + + + + Click the `Check for Desktop App Updates` link to manually trigger an update check. If an update is available, you'll be prompted to install it. + + + + + You can also check for Desktop App updates using the keyboard shortcut `shift+U` (macOS) or `shift+U` (Windows/Linux) from anywhere in Pieces. + + +### Keyboard Shortcuts + +View all available keyboard shortcuts for Pieces Desktop. Learn shortcuts to navigate faster, perform actions quickly, and improve your workflow efficiency. + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Troubleshooting`. + + + + Find the keyboard shortcuts option or use the keyboard shortcut `⌘+;` (macOS) or `ctrl+;` (Windows/Linux) from anywhere in Pieces. + + + +For a complete reference guide of all keyboard shortcuts, see the [Keyboard Shortcuts](/products/desktop/actions/keyboard-shortcuts) documentation. + +## Quick Links + +Access common resources and documentation quickly: + +* **[Product Documentation](/products/desktop)** - Complete Pieces Desktop documentation +* **[Keyboard Shortcuts](/products/desktop/actions/keyboard-shortcuts)** - All available keyboard shortcuts +* **[GitHub Issues](https://github.com/pieces-app)** - Report bugs and request features +* **[Discord Community](https://discord.gg/getpieces)** - Join the Pieces community for support +* **[Privacy & Security](/products/privacy-security-your-data)** - Learn about data privacy and security +* **[Support](/products/support)** - Additional support resources and FAQs + +*** + +## Next Steps + +Now that you understand how to access troubleshooting resources, learn about [Account](/products/desktop/configuration/account) settings to manage your account and cloud settings, or explore [Models](/products/desktop/configuration/models) to configure AI models and processing modes. diff --git a/public/content/desktop/configuration/views-layouts.md b/public/content/desktop/configuration/views-layouts.md new file mode 100644 index 0000000..1a80e0d --- /dev/null +++ b/public/content/desktop/configuration/views-layouts.md @@ -0,0 +1,192 @@ +--- +title: Views & Layouts +path: /desktop/configuration/views-layouts +visibility: PUBLIC +status: PUBLISHED +description: Customize confirmation settings, metrics summary display, and saved materials toolbar preferences. +metaTitle: Views & Layouts Settings in Pieces Desktop +metaDescription: Customize confirmation settings, metrics summary display, and saved materials toolbar preferences in Pieces Desktop. +--- + +## Views & Layouts Settings + +Customize confirmation settings, metrics summary display, and saved materials toolbar preferences. Configure when confirmation prompts appear, how metrics summaries are displayed, and which toolbar options are available for saved materials. + +To access Views & Layouts settings, click your `User Profile` in the top left, then hover over `Settings` and select `Views & Layouts`. + + + +> Views & Layouts settings showing Confirmation Settings, Metrics Summary Settings, and Default Toolbar options + +## Confirmation Settings + +Configure which confirmation menus appear when performing deletions or updates. Confirmation prompts help protect you from unintended actions by requiring an extra step before making significant changes. + +### Opening Confirmation Settings + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Views & Layouts`. + + + + In the *Views & Layouts* section, find the "Confirmation Settings" option with the description "Select which confirmation menus show or not". + + + + Click the `Settings Icon` (gear icon) to the right of the Confirmation Settings option to open the *Confirmation Menu Settings* popup. + + + + + +> *Confirmation Menu Settings* popup showing Deletions and Updates sections with checkboxes + +### Deletions + +Configure confirmation prompts for various deletion actions. When enabled, Pieces will ask for confirmation before permanently deleting items. + + + + Click the `Settings Icon` next to Confirmation Settings in Views & Layouts. + + + + In the *Confirmation Menu Settings* popup, find the *Deletions* section. + + + + Enable or disable confirmation prompts for: + * **Confirm Saved Material deletions**: Check the checkbox to require confirmation before deleting saved materials + * **Confirm Timeline Event deletions**: Check the checkbox to require confirmation before deleting Timeline Events + * **Confirm Saved Material Context deletions**: Check the checkbox to require confirmation before deleting context (tags, related links, and more). Click the `Dropdown Arrow` to access additional context deletion options + + + +### Updates + +Configure confirmation prompts for shareable link updates. When enabled, Pieces will prompt you before updating shareable links when modifying saved materials. + + + + Click the `Settings Icon` next to Confirmation Settings in Views & Layouts. + + + + In the *Confirmation Menu Settings* popup, find the *Updates* section. + + + + Enable or disable confirmation prompts for: + * **Confirm Shareable Link updates**: Check the checkbox to prompt you to update your shareable link when updating a Saved Material + * **Confirm Sensitive Shareable Link updates**: Check the checkbox to prompt you to update shareable links that have sensitive information when updating a Saved Material + + + + + +> Updates section showing Shareable Link update confirmation options + +## Metrics Summary Settings + +Customize when and how the Metrics Summary displays in Gallery View. Control the visibility of context summaries to keep your interface clean while still providing information when needed. + +### Opening Metrics Summary Settings + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Views & Layouts`. + + + + In the *Views & Layouts* section, find the "Metrics Summary Settings" option with the description "Customize when the Metrics Summary shows". + + + + Click the `Hamburger Icon` (three horizontal lines) to the right of the Metrics Summary Settings option to open the *Metrics Settings* popup. + + + + + +> *Metrics Settings* popup showing Mode and Visibility options + +### Mode + +Configure how the Metrics Summary behaves in Gallery View. + + + + Click the `Hamburger Icon` next to Metrics Summary Settings in Views & Layouts. + + + + In the *Metrics Settings* popup, find the *Mode* section. + + + + Check the "Smart Layout" checkbox to show Context Summary automatically for small snippets while browsing the Gallery View. When enabled, summaries appear automatically for smaller snippets without requiring hover or navigation. + + + +### Visibility + +Configure when the Metrics Summary is visible in Gallery View. You can choose to show summaries when navigating, hovering, or both. + + + + Click the `Hamburger Icon` next to Metrics Summary Settings in Views & Layouts. + + + + In the *Metrics Settings* popup, find the *Visibility* section. + + + + Enable one or more visibility options: + * **All**: Check the checkbox to show when navigating and hovering + * **Navigating**: Check the checkbox to show when navigating the Gallery View + * **Hovering**: Check the checkbox to show when hovering the context icon + + + + + You can enable multiple visibility options simultaneously. For example, enabling both "Navigating" and "Hovering" will show summaries in both scenarios, while enabling "All" covers both cases automatically. + + +## Saved Materials Action Toolbar + +Configure the default toolbar that appears for saved materials. Choose between Default, Suggested, or Custom toolbar options to match your workflow preferences. + +### Changing Default Toolbar + + + + Click your `User Profile` in the top left, then hover over `Settings` and select `Views & Layouts`. + + + + In the *Saved Materials Action Toolbar* section, find the "Default Toolbar: Default" option. + + + + Click the `Dropdown Arrow` next to the current toolbar selection to open the toolbar options. + + + + Choose from the following options: + * **Default**: Standard toolbar with common actions + * **Suggested**: Toolbar with AI-suggested actions based on your workflow + * **Custom**: Customized toolbar with your preferred actions + + + + + +> Default Toolbar dropdown showing Default, Suggested, and Custom options + +*** + +## Next Steps + +Now that you understand how to configure Views & Layouts, learn about [Appearance](/products/desktop/configuration/appearance) settings to customize the visual appearance of Pieces, or explore [Account](/products/desktop/configuration/account) settings to manage your account and privacy preferences. diff --git a/public/content/desktop/conversational-search.md b/public/content/desktop/conversational-search.md new file mode 100644 index 0000000..9bafd5a --- /dev/null +++ b/public/content/desktop/conversational-search.md @@ -0,0 +1,81 @@ +--- +title: Introduction to Conversational Search +path: /desktop/conversational-search +visibility: PUBLIC +status: PUBLISHED +description: Conversational Search is the ability to talk with your memories. Have conversations with your captured workflow context with LTM-2.7. +metaTitle: Introduction to Conversational Search | Pieces Docs +metaDescription: Conversational Search is the ability to talk with your memories. Have conversations with your captured workflow context with LTM-2.7. +--- + + + +*** + +## What Is Conversational Search? + +**Conversational Search** is the ability to talk with your memories. It's your AI-powered interface for having conversations with your captured workflow context—including code you've written, conversations you've had, and decisions you've made. + +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. + + + +> Homepage showing Conversational Search section with suggested prompts and Start New Chat button + +## Two Ways to Use Conversational Search + +### Conversational Search + +Ask questions across your entire workflow history or filter by specific apps and time ranges. Access it directly from the homepage. + +**Use Cases:** + +* **Asking specific questions** - Ask targeted questions about your memories to find specific information quickly +* **Searching across workflow** - Search across your entire workflow context to discover patterns and connections +* **Filtering by apps or dates** - Narrow down results using Sources and Time Ranges filters for more focused answers +* **Having conversations** - Have natural conversations about your past work to understand decisions and context + + + Learn how to talk with your memories, filter searches, switch models, and work with responses. + + +### Starting a conversation with a Timeline Event + +Ask questions about one specific memory or Timeline Event with pre-loaded context. Perfect for drilling into details of a particular workflow moment. + +**Use Cases:** + +* **Understanding specific decisions** - Review why specific past decisions were made by asking questions about the context and reasoning +* **Reviewing work sessions** - Understand what happened during a particular work session by diving deep into a specific Timeline Event +* **Asking about Timeline Events** - Get detailed information about a specific Timeline Event, including what was discussed, what code was written, or what decisions were made + + + Learn how to start context-specific conversations directly from your workflow memories. + + +*** + +## Learn More About Conversational Search + +Explore these guides to master Conversational Search: + + + + Learn how to talk with your memories, filter searches, switch models, and work with responses. + + + + Add folders, files, and LTM context to your conversations for more accurate, relevant responses. + + + + Start context-specific conversations directly from Timeline Events with pre-loaded context. + + + +*** + +If Conversational Search isn't what you're looking for, check out [Pieces Timeline](/products/desktop/timeline)—your central workspace for viewing [timeline events](/products/desktop/timeline/timeline-events) and generating [summaries](/products/desktop/single-click-summaries). diff --git a/public/content/desktop/conversational-search/chat-with-timeline-events.md b/public/content/desktop/conversational-search/chat-with-timeline-events.md new file mode 100644 index 0000000..554d09c --- /dev/null +++ b/public/content/desktop/conversational-search/chat-with-timeline-events.md @@ -0,0 +1,77 @@ +--- +title: Starting a conversation with a Timeline Event +path: /desktop/conversational-search/chat-with-timeline-events +visibility: PUBLIC +status: PUBLISHED +description: Start context-specific conversations directly from Timeline Events in the memories sidebar with pre-loaded context. +metaTitle: Starting a conversation with a Timeline Event | Conversational Search +metaDescription: Start context-specific conversations directly from Timeline Events in the memories sidebar with pre-loaded context. +--- + +## Starting a conversation with a Timeline Event + +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 view showing a Timeline Event card with pre-loaded context and input field ready for questions + +## How to Start a Conversation + +Start a context-specific conversation from any Timeline Event using the `Start Related Chat` button in the Timeline Event detail view. + + + + Click any event in the Pieces Timeline to view its summary in the *main panel*. + + + + Click `Start Related Chat` in the bottom right of the Timeline Event detail view to open Conversational Search with that event's context loaded. + + + + + +> Conversational Search showing memory, Timeline Event, Start Related Chat, and Conversational Search open with Timeline Event card displayed + +### Asking Questions with Pre-Loaded Context + +When Conversational Search opens with a Timeline Event, you'll see an information card displaying the event's details, including its title, description, timestamp, and related participants. The input field will show a placeholder like "Ask about '[Event Name]'..." indicating that the conversation is scoped to that specific event. Type your question or click any suggested prompts that appear. The conversation already has full context from that Timeline Event, including core tasks, key decisions, documents reviewed, and follow-up actions. + +**Example questions:** +* "Why did we make that decision?" +* "What were the main blockers in this session?" +* "Summarize the key outcomes from this work" +* "What happened next?" + + + +> Conversational Search interface showing Timeline Event information card with event details, input field with placeholder text, and bottom toolbar with model selection and filters + +## Working with Responses + +You can copy, export, regenerate, or convert responses just like in regular Conversational Search. Responses are scoped to that specific Timeline Event's context. You can also click the `Relevant Summaries` button at the bottom of any response to see which Timeline Events were used to generate the answer, though typically only the event you're discussing will appear since the conversation is already scoped to that single Timeline Event. + +## Differences from Conversational Search + +Starting a conversation with a Timeline Event focuses on a single Timeline Event, while Conversational Search can access all your memories or a filtered subset. Here's how they compare: + +**Starting a conversation with a Timeline Event:** +* **Context** - One specific memory with pre-loaded context +* **Filters** - Not available (context is already scoped to that memory) +* **Best for** - Questions about specific moments, understanding particular decisions, or reviewing individual work sessions + +**Conversational Search:** +* **Context** - All memories or a filtered subset based on your filters +* **Filters** - Sources & Time Ranges available to narrow scope +* **Best for** - Broad workflow questions spanning multiple time periods or when you need to search across different apps + +Use starting a conversation with a Timeline Event when you want to dive deep into a specific past moment. Use Conversational Search for questions spanning multiple time periods or when you need to filter by apps or dates. + +*** + +## Next Steps + +Now that you know how to start context-specific chats from memories, learn how to use Conversational Search for broader workflow questions. + +[Using Conversational Search →](/products/desktop/conversational-search/using-conversational-search) diff --git a/public/content/desktop/conversational-search/context-integration.md b/public/content/desktop/conversational-search/context-integration.md new file mode 100644 index 0000000..8a98f9d --- /dev/null +++ b/public/content/desktop/conversational-search/context-integration.md @@ -0,0 +1,107 @@ +--- +title: Context & Project Integration +path: /desktop/conversational-search/context-integration +visibility: PUBLIC +status: PUBLISHED +description: Enable or disable Long-Term Memory context in Conversational Search to include your workflow history in conversations. +metaTitle: Context & Project Integration | Conversational Search +metaDescription: Enable or disable Long-Term Memory context in Conversational Search to include your workflow history in conversations. +--- + +## Context & Project Integration + +Control whether Conversational Search includes Long-Term Memory context in your conversations. When enabled, Conversational Search has access to 9 months of captured workflow context from your [Long-Term Memory (LTM-2.7)](/products/core-dependencies/pieces-os#ltm-27) Engine, including code you've written, conversations you've had, and decisions you've made. + +## LTM Context Toggle + +Enable or disable Long-Term Memory context for Conversational Search. When enabled, your chats automatically include workflow history context. When disabled, conversations use only the current context without historical data. + +### Enabling LTM Context + +Turn on Long-Term Memory context to include workflow history in your chats: + + + + Click your `User Profile` in the top left of the Pieces Desktop App. + + + Hover over `LTM-2.7` in the dropdown menu that appears. + + + A menu will appear with options to pause LTM-2.7 or turn it off. To enable LTM context for Conversational Search, ensure LTM-2.7 is not paused or turned off. + + + +### Disabling LTM Context + +Turn off Long-Term Memory context when you want conversations without historical workflow data: + + + + Click your `User Profile` in the top left of the Pieces Desktop App. + + + Hover over `LTM-2.7` in the dropdown menu. + + + Select a pause duration (15 minutes, 1 hour, 6 hours, 12 hours, or 24 hours) or choose `Turn Off` to disable LTM-2.7. When LTM-2.7 is paused or turned off, Conversational Search will not include workflow history context in conversations. + + + + + +> User profile menu showing LTM-2.7 hover menu with pause and turn off options + +## Understanding LTM Context + +When LTM-2.7 is enabled, Conversational Search automatically includes relevant workflow context from your Long-Term Memory. This means your conversations can reference: + +* Code you've written and changes you've made +* Conversations and decisions from your workflow history +* Activities captured by LTM-2.7 from connected applications +* Timeline Events and summaries from your workflow + +When LTM-2.7 is paused or turned off, Conversational Search operates without access to this historical context, providing responses based only on the current conversation. + +## Related Timeline Events + +View which Timeline Events were used to generate responses by opening the Relevant Summaries sidebar. + +Conversational Search draws from your LTM memories to provide accurate responses. The Relevant Summaries sidebar shows you exactly which Timeline Events were used to generate each response, helping you verify the source of information and discover related work. + +### Viewing Related Timeline Events + +Open the Relevant Summaries sidebar to see which Timeline Events were used in a response: + + + + After receiving a response in Conversational Search, look for the `Relevant Summaries` button at the bottom of the chat response. + + + Click the `Relevant Summaries` button to open the sidebar on the right side of the interface. + + + The sidebar displays a list of relevant Timeline Events that were used to generate the response. Each entry shows the Timeline Event title, description, timestamp, and related applications. + + + Click the sort dropdown in the top right of the sidebar to change how summaries are organized. Options include `Suggested`, `Recent`, and `Most Viewed`. + + + Click any Timeline Event in the sidebar to view full details about that event, including when it was captured and what specific context it contains. + + + Click the `X` icon in the top left of the sidebar to close it and return to the main chat view. + + + + + +> Relevant Summaries sidebar open showing Timeline Events used to generate the response, with sort dropdown visible in the top right + +*** + +## Next Steps + +Now that you know how to control LTM context in Conversational Search, learn how to start context-specific conversations directly from your workflow memories. + +[Starting a conversation with a Timeline Event →](/products/desktop/conversational-search/chat-with-timeline-events) diff --git a/public/content/desktop/conversational-search/using-conversational-search.md b/public/content/desktop/conversational-search/using-conversational-search.md new file mode 100644 index 0000000..55fb682 --- /dev/null +++ b/public/content/desktop/conversational-search/using-conversational-search.md @@ -0,0 +1,217 @@ +--- +title: Using Conversational Search +path: /desktop/conversational-search/using-conversational-search +visibility: PUBLIC +status: PUBLISHED +description: Learn how to talk with your memories, filter searches, switch models, and work with responses in Conversational Search. +metaTitle: Using Conversational Search | Pieces Docs +metaDescription: Learn how to talk with your memories, filter searches, switch models, and work with responses in Conversational Search. +--- + +***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). + + + +> Full Conversational Search interface on homepage showing suggested prompts, chat input, model selector, and bottom toolbar + +## Talking with Your Memories + +Have conversations with your captured workflow context. Ask specific questions about your past work, decisions, or activities. + +### Suggested Prompts + +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 a suggested prompt, showing the complete flow from click to response with Related Timeline Events cards + +### Asking Your Own Questions + +Type your own questions to have conversations with your memories about specific topics or moments. + + + + Click `Start New Chat` to begin a fresh conversation. + + + + Type your question in the input field and press Enter to send. + + + + You'll get a response powered by LTM-2.7 with context from your captured memories. + + + +**Example questions:** +* "Why did we choose PostgreSQL over MySQL for the authentication project?" +* "What was the blocker I encountered last Tuesday afternoon?" +* "Find that React performance article I read last month" +* "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 + +### Starting Fresh Chats + +Use `Start New Chat` when you want to discuss a completely different topic. Starting a new chat ensures better results when switching topics since Conversational Search uses relevant memory context across the entire conversation. + +## Filtering Your Searches + +Filter by specific apps or time ranges to narrow your search scope and get more focused answers. + +### Sources Filter + +Limit searches to memories from specific applications. Use this when you want answers based only on specific apps. + + + + Click the `Sources` button in the *bottom toolbar* to open the filter modal. + + + + Check the apps you want to include. You can select multiple apps at once. + + + + Selected sources apply to your current chat and all future messages until you change them. + + + + + +> Sources filter modal showing list of apps with checkboxes, with Chrome and VS Code selected + +### Time Ranges Filter + +Focus searches on specific time periods. Use this when you need information from a specific period. + + + + Click the `Time Ranges` button in the *bottom toolbar* to open the filter modal. + + + + Choose from 31+ preset options (e.g., "Yesterday", "This week", "Last month") or use the calendar view for custom date ranges. You can select multiple ranges at once. + + + + Selected time ranges apply to your current chat and all future messages until you change them. + + + + + +> Time Ranges modal showing preset options and calendar view + +### Combining Filters + +Use Sources and Time Ranges together for precise queries—for example, "Chrome browsing from yesterday afternoon." + +## Working with Responses + +All response actions are available in the *toolbar* below each response: + +* **Copy:** Click the `clipboard icon` to copy the entire response to your clipboard +* **Export:** Click the `export icon` to download responses as PDF (for sharing/printing), Markdown (for editing), or Plain Text +* **Regenerate:** Click the `regenerate icon` (circular arrow) to re-run the response with the same model or switch to a different one for comparison +* **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 showing Copy, Export, Regenerate, Convert to Timeline Event, and More menu buttons labeled + +### Related Timeline Events + +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 below showing memory titles and timestamps + +## Model Selection + +Switch between cloud and local models based on your needs. Use cloud models (Claude, GPT, Gemini) for faster responses and advanced reasoning. Use local models (o3, o1) for complete privacy and offline capability. + + + + Click the `model button` in the *bottom toolbar* to open the model selector. + + + + You'll see Recent models you've used, Suggested models for your current task, or click `All Models` to see everything available. + + + + When you switch models, your chat history stays intact, and new messages will use the selected model. + + + + + +> Model selector dropdown + +## Asking Effective Questions + +The more specific your questions, the better Conversational Search can find relevant memories and provide accurate answers. + +### Use Specific Keywords + +Include unique keywords related to what you're looking for—project names, ticket numbers, package names, or specific topics. + +**Good:** "What is the status of project Aurora?" + +**Bad:** "What is the status of my project?" + + + If you can't remember specific keywords, try asking: "Give me the titles of all the project documents I've been working on last month" to find keywords for more specific prompts. + + +### Include Time Ranges + +Specify when something happened to narrow down results. Conversational Search stores up to 9 months of memories. + +**Examples:** +* "What decision did we make about the database schema last week?" +* "What were the plans I received in December?" +* "What was I debugging yesterday afternoon?" + +### Mention Source Applications + +Reference specific apps to separate similar content across different sources. + +**Example:** "What did Sarah and I discuss in Teams about the deployment?" + +This separates Teams conversations from emails or document comments. + +### Combine Techniques + +Mix keywords, time ranges, and applications for the most accurate results. + +**Example:** "What is the URL for the Project Aurora document I discussed in Teams with Sarah last Thursday?" + +This combines the keyword "Project Aurora," the application "Teams," the person "Sarah," and the time "last Thursday" to narrow down results precisely. + +### Use Filters Instead of Prompts + +If you know the exact source app or time range, use the `Sources` and `Time Ranges` filters instead of describing them in your prompt. Filters are more accurate than natural language time expressions. + +## Managing Your Chat History + +All conversations automatically save to the *memories sidebar*, listed chronologically with other workflow activities. Click any saved chat to reopen it with full history and preserved filter settings. + + + Your chat history is part of your LTM memories. Conversational Search can reference previous conversations when answering new questions. + + +*** + +## Next Steps + +Now that you know how to use Conversational Search, learn how to start context-specific conversations directly from your workflow memories. + +[Starting a conversation with a Timeline Event →](/products/desktop/conversational-search/chat-with-timeline-events) diff --git a/public/content/desktop/copilot/configuration.md b/public/content/desktop/copilot/configuration.md index 493fef9..9a9dc04 100644 --- a/public/content/desktop/copilot/configuration.md +++ b/public/content/desktop/copilot/configuration.md @@ -20,12 +20,12 @@ There are dozens of local and cloud-hosted LLMs to choose from within the Pieces At the bottom left of the Pieces Copilot view is the active model. By default, this is a cloud LLM. -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/ollama#using-local-vs-cloud-models) +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) - Some cloud models are available to Pieces Pro users only (for example: OpenAI GPT-5/GPT-5 Mini, Anthropic Claude 4.1 Opus, Google Gemini 2.5 Pro). To unlock these premium models, see [Pieces Pro](/paid-plans). + 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). ### Model Selection @@ -34,11 +34,11 @@ Pieces Copilot allows you to choose between cloud-hosted models and on-device mo Each option has its benefits: -* **Cloud LLMs:** Typically offer state-of-the-art performance and are ideal for complex queries requiring deep context. Supported providers and example models include OpenAI (GPT-5, GPT-5 Mini, GPT-5 Nano, o4 Mini, o3 Pro, o3 Mini, o3, o1, GPT-4.1), Anthropic (Claude 4.1 Opus, Claude 4 Opus, Claude 4 Sonnet), and Google (Gemini 2.5 Pro, Gemini 2.5 Flash, Gemini 2.5-Flash-Lite). See the complete list on the [Cloud Models](/products/large-language-models/cloud-models) page. +* **Cloud LLMs:** Typically offer state-of-the-art performance and are ideal for complex queries requiring deep context. Supported providers and example models include OpenAI (GPT-5.2 Pro, GPT-5.2, GPT-5.1, GPT-5 Thinking, GPT-5, GPT-5 Fast, o4 Mini, o3 Pro, o3 Mini, o3, o1, GPT-4.1, GPT-4o, GPT-4o Mini), Anthropic (Claude 4.5 Opus, Claude 4.5 Sonnet, Claude 4.5 Haiku, Claude 4 Sonnet, Claude 3.7 Sonnet, Claude 3.5 Sonnet, Claude 3.5 Haiku), and Google (Gemini 3 Pro Preview, Gemini 3 Flash Preview, Gemini 2.5 Pro, Gemini 2.5 Flash, Gemini 2.5 Flash Lite, Gemini 2 Flash Lite). See the complete list on the [Cloud Models](/products/large-language-models/cloud-models) page. * **On-Device LLMs:** Ensure data privacy and are optimal for offline or air-gapped environments. -You can read this documentation containing [all local and cloud-hosted LLMs served through the Pieces Desktop App.](/products/core-dependencies/ollama/supported-models) +You can read this documentation containing [all local and cloud-hosted LLMs available through the Pieces Desktop App.](/products/core-dependencies/local-models/supported-models) ### Resetting Conversations @@ -50,30 +50,16 @@ This is particularly useful when you want to switch focus or change the conversa ### Search Functionality -A search bar labeled *Find Cloud LLMs* lets you browse available cloud-based models—then, switching to *On-Device,* you can search through the list of local models available with the [optional Ollama client.](/products/core-dependencies/ollama) - -*** - - - Ollama is required to use local LLMs with Pieces software. - - If you don’t have it installed, that’s okay—you can download and install it through the Pieces Desktop App by clicking on the `Active Model` button and switching to the `On-Device` tab. You'll be prompted to install Ollama. - - -*** - -To switch between the *Cloud* and *On-Device* model list, click the slider next to the search bar. +To browse and download local models, click the **Active Model** button and hover over **All Models**, then scroll down to find available local models. -Once toggled, the search bar updates to *Find On-Device LLMs* and shows a message either prompting you to install Ollama or indicating that Ollama is installed and ready, along with its version number. +Local models are downloaded on-demand through PiecesOS. Simply select a local model to download and use it. *** - While Ollama is required for on-device generative AI, you do not need it to use the Long-Term Memory Engine. - - This distinction ensures that you can benefit from local Long-Term Memory features even if you choose not to use on-device LLMs. + Local models run entirely on your device through PiecesOS, providing complete privacy and offline functionality without any external dependencies. *** diff --git a/public/content/desktop/copilot/integration.md b/public/content/desktop/copilot/integration.md index a84ac70..fd6cd91 100644 --- a/public/content/desktop/copilot/integration.md +++ b/public/content/desktop/copilot/integration.md @@ -13,7 +13,7 @@ metaDescription: Learn how to use Pieces Copilot within the Pieces Desktop App, Adding context to Pieces Copilot chats makes responses significantly more relevant and useful—especially when that context is pulled directly from your workflow. - Read this [LLM Prompting Guide](/products/quick-guides/ltm-prompting/tips) or learn how to use [Pieces Copilot with LTM Context](/products/quick-guides/copilot-with-context) via these helpful Quick Guides. + Check out the [LTM Prompting Guide](/products/quick-guides/ltm-prompting) or learn how to use [Pieces Copilot with LTM Context](/products/quick-guides/copilot-with-context) via these helpful Quick Guides. ## Enriching Chats with LTM-2.7 Context @@ -28,12 +28,12 @@ By including Long-Term Memory data and project-specific resources, you can impro Pieces Copilot will draw on memories and workflow context captured by the LTM engine to prepare a relevant, context-rich answer for you. -The Workstream Activity cards will display under the response with several cards linking to past *Workstream Activity Rollups* that contain the context used to create that response. +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. - Clicking one of the surfaced context cards will take you to that specific Rollup in the **Workstream Activities** view. + Clicking one of the surfaced context cards will take you to that specific Roll-Up in **Timeline**. ### LTM Context Toggle diff --git a/public/content/desktop/copilot/interaction.md b/public/content/desktop/copilot/interaction.md index 826eda6..17f1962 100644 --- a/public/content/desktop/copilot/interaction.md +++ b/public/content/desktop/copilot/interaction.md @@ -20,7 +20,7 @@ This view is the central hub from which you can start new chats, access previous The central area of the Pieces Copilot view is a blank chat where you can start a new conversation. -To get the most out of generative AI using local or cloud models through Pieces Copilot, make sure you [check out our LLM Prompting Guide.](/products/quick-guides/ltm-prompting/tips) +To get the most out of generative AI using local or cloud models through Pieces Copilot, make sure you [check out our LTM Prompting Guide.](/products/quick-guides/ltm-prompting) At the top of the window, you will see a set of three *Suggested Prompts*—these dynamic prompts adapt based on your topics common to your workflow (if captured by LTM) and serve as a quick way to begin engaging with the AI. @@ -120,14 +120,14 @@ There are several actions you can take under each generated Pieces Copilot respo 4. `Regenerate`: Use the refresh icon to re-run the response with the same model or a different one. Clicking opens a modal where you can select the model you want to use for the regeneration. -5. `Convert to Workstream Summary`: The paper icon converts this Copilot output into a Workstream Summary so you can capture and reference it later in your workflow. +5. `Convert to LTM Roll-Up`: The paper icon converts this Copilot output into an LTM Roll-Up so you can capture and reference it later in your workflow. -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. +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. - If LTM Context is enabled, you may also see related context cards surface beneath the response. These link to Workstream Activity Rollups that informed the generation. + 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. ### New Chat & Pipelines diff --git a/public/content/desktop/download.md b/public/content/desktop/download.md index 778789c..f9a9e26 100644 --- a/public/content/desktop/download.md +++ b/public/content/desktop/download.md @@ -10,7 +10,7 @@ metaDescription: Download the Pieces Desktop Application for AI-powered workflow ## Installing the Pieces Desktop App -Installation for the Pieces Desktop App and its core dependencies—[PiecesOS](/products/core-dependencies/pieces-os) and [Ollama](/products/core-dependencies/ollama)—is straightforward. +Installation for the Pieces Desktop App is straightforward. The Pieces Desktop App installs alongside its core dependency—[PiecesOS](/products/core-dependencies/pieces-os)—which is a separate component that runs in the background to power the app's features. Select the appropriate download file for your platform (macOS/Windows) or follow the CLI installation instructions for Linux. @@ -77,3 +77,7 @@ For a step-by-step terminal process using the CLI, refer to our [comprehensive L 5. Type `pieces-for-developers` to launch the application directly from your terminal. + +## Next Steps + +After installation, you'll go through an onboarding process that helps you get started with the Pieces Desktop App. The app will run in the background to generate your first LTM summary while you continue working, allowing you to return later and see insights into your workflow patterns. For details on what to expect, see our [Onboarding Guide](/products/desktop/onboarding). diff --git a/public/content/desktop/drive.md b/public/content/desktop/drive.md index 0d00012..89bf2d1 100644 --- a/public/content/desktop/drive.md +++ b/public/content/desktop/drive.md @@ -8,124 +8,24 @@ metaTitle: Introduction to Pieces Drive | Pieces Docs metaDescription: Discover Pieces Drive – your all-in-one workspace in Pieces for saving, managing, and accessing code snippets and dev materials. --- - +## Pieces Drive (Legacy) -*** +**Pieces Drive** is a legacy feature that's being integrated into the [Long-Term Memory (LTM-2.7)](/products/core-dependencies/pieces-os#ltm-27) Engine and [Timeline](/products/desktop/timeline) features. Materials and workflow context are now automatically captured and organized by the LTM system, which provides a more seamless and intelligent way to access your development materials. -## What is Pieces Drive? +The LTM-2.7 Engine automatically captures and stores your workflow context—including code snippets, documentation, and related materials—without requiring manual saving or organization. This means you'll have access to your materials through [Timeline](/products/desktop/timeline), where you can view summaries, search through captured context, and interact with your workflow data in a more intuitive way. -**Pieces Drive** is a central feature of the Pieces Desktop App—your all-in-one workspace for saving, managing, and quickly accessing code snippets and other development materials.  +You can still access Pieces Drive (Legacy) if you need it, but we recommend using the new LTM-powered features for the best experience. -## Overview +### Accessing Pieces Drive (Legacy) -Pieces Drive gives you the tools to collect and access your most valuable development assets—code snippets, notes, and more—all in one integrated interface. +To access Pieces Drive (Legacy), click your profile icon in the top-right corner, then navigate to **Settings** → `Drive (Legacy)`. This option is maintained for existing users who may need to access previously saved materials, but new workflows should use the Long-Term Memory system and Timeline features. -You can quickly add items, enrich them with tags and annotations, search using natural language or filters, transform snippets into different languages, and share links with others. +### Where to Find These Features Now -Below are quick overviews of Pieces Drive's features. For detailed information on a specific function, click the links for documentation and walkthroughs: +The functionality that Pieces Drive provided is now handled by these modern features: -* [Saving & Organizing](/products/desktop/drive/save-and-organize): Learn how to add new materials, import existing code from local files or GitHub Gists, and keep your snippets neatly structured. +* [Timeline](/products/desktop/timeline)—View incremental workflow summaries, saved context, and related information gathered by the Long-Term Memory (LTM-2.7) Engine. This is where you'll find your automatically captured materials and workflow context. -- [Searching & Filtering](/products/desktop/drive/search-and-filter): Discover how to leverage natural language queries, filters, and tags to quickly locate specific materials in Pieces Drive. +* [Long-Term Memory (LTM-2.7) Engine](/products/core-dependencies/pieces-os#ltm-27)—Learn how the LTM system automatically captures and organizes your workflow context, eliminating the need for manual material management. -- [Enrichment & Metadata](/products/desktop/drive/enrichment-and-metadata): Understand how Pieces automatically generates tags, annotations, suggested links, and captures context for each snippet, as well has how to access and update associated metadata. - -- [Transforming Code](/products/desktop/drive/transforming-code): See how you can duplicate code snippets to create more readable, more performant, or entirely different-language versions. - -- [Sharing:](/products/desktop/drive/sharing) Find out how to generate shareable links to your snippets, including managing sensitive information before sending links to colleagues. - - - Did you know that you can use *all of the data* captured by LTM, stored inside your Pieces Drive, as context for Pieces Copilot Chats? [Read more here.](/products/quick-guides/copilot-with-context) - - -## Pieces Drive | Main View - -To access the Pieces Drive view, first click the *home* icon in the top-left corner to open the [Power Menu.](/products/desktop/actions/power-menu) - -Then, select `Pieces Drive` from the list of available views. - - - -Inside the Pieces Drive view, you can: - -1. Scroll through list of saved materials, or search using Natural Language Processing (NLP) to find the materials you need. - -2. Save new materials or create materials from scratch using a range of mediums. - -3. View metadata alongside individual snippets and edit the metadata generated alongside them. - -4. Duplicate and transform snippets, or start [Pieces Copilot Chats with them.](/products/desktop/copilot/integration#enriching-chats-with-ltm-2-context) - - - -By incorporating Pieces Drive into your workflow, you can stay both efficient and organization whether you’re working in a solo capacity or as part of a larger team. - -### Saving & Organizing - -We’ll walk you through the main Pieces Drive saving workflow and touch on all the essential elements you can interact with here. - -You’ll learn how to add materials in various ways—pasting code from your clipboard, using an IDE plugin, importing GitHub Gists, or even discovering snippets in a local folder. - -Or, you can create from scratch when you need a quick note or brand-new snippet and organize your growing library with tags, annotations, and reclassification. - - - -### Searching & Filtering - -One of Pieces Drive’s major advantages is its robust search capabilities. - -By typing natural language queries or toggling filters for titles, annotations, or full snippet content, you can zero in on exactly what you need—even if you have hundreds of stored snippets. - -In this section, we’ll cover how to use natural language to find snippets by function or topic, use filters to narrow down results by language, tags or custom phrases, and save specific search filters for repeated use. - - - -### Enrichment & Metadata - -Pieces Drive automatically enriches every snippet with valuable context, making it more than just a code vault. - -This includes auto-generated titles, suggested queries, related websites, and tags that help you quickly see what a snippet does and how it might be used. - -You’ll learn how to access saved metadata for individual materials, how to manage sensitive information, view and edit automatically generated annotations and tags, and more. - - - -### Transforming Code - -Ever need a quick performance boost, a language switch, or a stripped-down boilerplate version of a saved code snippet? - -Pieces Drive’s transformation options let you duplicate snippets in a few clicks to generate more readable or performance enhanced versions, snippets in different languages, and more. - - - -### Sharing - -Collaboration often requires easily accessible code references. - -Pieces Drive allows you to create secure, shareable links for your snippets—complete with the same metadata and context found in your desktop app. - -Learn how to generate shareable links with best practices in mind for handling sensitive data, and both internal and external use cases for sharing code. - - - -### Integrating Pieces Drive & Pieces Copilot - -When you want AI-assisted code explanations, troubleshooting, or generation, Pieces Copilot can reference the snippets you have saved in Pieces Drive. - -By adding a snippet as context in a Copilot chat, the AI can read its entire content and produce more relevant, targeted answers. - -We’ll show you how to attach snippets directly from Pieces Drive into a Pieces Copilot Chat, how to navigate back and forth between different views and help you understand how snippet metadata informs AI responses. - - - -*** - -## Get Started with Pieces - -Click one of the links below to be redirected to your platform-specific (OS) download and installation Quickstart page: - -* [macOS](/products/meet-pieces/macos-installation-guide) - -* [Windows](/products/meet-pieces/windows-installation-guide) - -* [Linux](/products/meet-pieces/linux-installation-guide) \ No newline at end of file +These features provide the same capabilities that Pieces Drive offered, but with automatic capture, better organization, and seamless integration with Pieces Copilot and other Pieces tools. diff --git a/public/content/desktop/navigation.md b/public/content/desktop/navigation.md index 78febdf..fa93c02 100644 --- a/public/content/desktop/navigation.md +++ b/public/content/desktop/navigation.md @@ -38,7 +38,7 @@ There are several views available within the **Power Menu** at any given point. If you want more information, click the titles of the views below to read more specific documentation on them: -* [Pieces Copilot](/products/desktop/copilot) **/** [Pieces Drive](/products/desktop/drive)**:** Depending on which view you’re currently in, one of these buttons will display—or both, if in another view. +* [Conversational Chat](/products/desktop/conversational-chat) **/** [Pieces Drive](/products/desktop/drive)**:** Depending on which view you're currently in, one of these buttons will display—or both, if in another view. * [Settings](/products/desktop/navigation/settings)**:** The master settings window. @@ -50,9 +50,9 @@ If you want more information, click the titles of the views below to read more s From within the Power Menu, there is a search bar titled *Find Action*. -From this menu, you can either click or scroll through some of the available options, like `Manage General Copilot Settings`, `New General Copilot Conversation`, or `Refresh Selected Chat`. +From this menu, you can either click or scroll through some of the available options, like `Manage General Conversational Search Settings`, `New General Conversational Search Conversation`, or `Refresh Selected Chat`. -These actions, some of which are view-specific—like refreshing a selected Pieces Copilot Chat—are useful ways to navigate throughout the Pieces Desktop App while maintaining speed and efficiency in your workflow. +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. @@ -62,16 +62,16 @@ Included at the very end of the scrollable **Find Actions** list are links to ot The **Settings** view is the only page from which the **Power Menu** cannot be accessed. -This view contains several different buckets of configurable options, such as [Account & Cloud](/products/desktop/configuration/account-and-cloud), [Pieces Copilot & Machine Learning](/products/desktop/configuration/copilot-and-machine-learning), [Aesthetics & Layouts](/products/desktop/configuration/aesthetics-layout), and [other settings](/products/desktop/configuration/additional-settings). +This view contains several different buckets of configurable options: [Account](/products/desktop/configuration/account), [Long-Term Memory](/products/desktop/configuration/long-term-memory), [Models](/products/desktop/configuration/models), [Model Context Protocol (MCP)](/products/desktop/configuration/mcp), [Appearance](/products/desktop/configuration/appearance), and [Troubleshooting](/products/desktop/configuration/troubleshooting). ## Focus Mode **Focus Mode** allows you to concentrate on your current task by minimizing distractions. -You can toggle Focus Mode by clicking the `Focus Mode` button located in the upper left of the Pieces Copilot or Pieces Drive view, near the sidebar. +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. -When activated, it closes the sidebar, giving you an expanded view of your current Pieces Copilot conversation. +When activated, it closes the sidebar, giving you an expanded view of your current Conversational Search conversation. To exit **Focus Mode**, simply click the button again to restore the sidebar, or press `esc` (macOS/Windows/Linux). diff --git a/public/content/desktop/navigation/settings.md b/public/content/desktop/navigation/settings.md index a9c7609..e77885c 100644 --- a/public/content/desktop/navigation/settings.md +++ b/public/content/desktop/navigation/settings.md @@ -36,7 +36,7 @@ You can review each section individually or see everything at once by selecting ### Account & Integrations -In this section, you can integrate external services with Pieces and adjust your user details, beginning with [Account Information.](/products/desktop/configuration/account-and-cloud#account-management) +In this section, you can integrate external services with Pieces and adjust your user details, beginning with [Account Information.](/products/desktop/configuration/account) This area displays your email address and any linked accounts. @@ -46,13 +46,13 @@ If you’re interested in testing upcoming features, the **Early Access Program* ### Personal Cloud -The [Personal Cloud](/products/desktop/configuration/account-and-cloud#disconnecting-personal-cloud) tab controls how your snippets and materials sync across devices. +The Personal Cloud settings are now part of the [Account](/products/desktop/configuration/account) tab and control how your snippets and materials sync across devices. -You’ll see a status for your cloud connection (including the last sync time), plus options to set or modify your personal domain. +You'll see a status for your cloud connection (including the last sync time), plus options to set or modify your personal domain. -There’s also a `Backup & Restore Data` feature to preserve or retrieve your snippets from the cloud whenever needed. +There's also a `Backup & Restore Data` feature to preserve or retrieve your snippets from the cloud whenever needed. * `Status`: Check if your cloud is connected and see when it last synced. @@ -60,43 +60,35 @@ There’s also a `Backup & Restore Data` feature to preserve or retrieve your sn * `Backup & Restore Data`: Protect your snippets and data. -### Copilot Chats +### Long-Term Memory -Within [Pieces Copilot Chats](/products/desktop/configuration/copilot-and-machine-learning#copilot-chats), decide which LLM runtime powers the Pieces Copilot and manage your chat-specific settings. +The [Long-Term Memory](/products/desktop/configuration/long-term-memory) settings allow you to manage the Long-Term Memory Engine, control which applications Pieces can access, manage system permissions, optimize performance, and clear stored data. - +* `Long-Term Memory Engine`: Toggle the engine on or off to control workflow context capture. -You can [Manage Copilot LLM Runtime](/products/desktop/configuration/copilot-and-machine-learning#manage-llm-runtime) or [Hard-Reset Active Runtime](/products/desktop/configuration/copilot-and-machine-learning#reset-active-runtime) if it becomes unresponsive. You can also pick an accent color for the chat UI, and `Delete All Copilot Chats` to clear your chat history. +* `App Access Control`: Manage which applications the Long-Term Memory Engine interacts with. -* `Manage Copilot LLM Runtime`: Switch or reset your current LLM. +* `System Permissions`: Manage accessibility and screen permissions for LTM. -* `Hard-Reset Active Runtime`: Restart the runtime if it’s unresponsive. +* `Optimize System RAM Usage`: Unload local machine learning models from memory. -* `Delete All Copilot Chats`: Remove your entire chat history. +* `Clear LTM Data`: Remove persisted data captured by the Long-Term Memory Engine. -### Machine Learning +### Models -Pieces uses an on-device ML engine (with optional cloud capabilities) to enrich and tag your snippets. +The [Models](/products/desktop/configuration/models) settings allow you to configure processing modes, set up local model runtime with Ollama, and control which AI models are available for use in Pieces. -Inside the [Machine Learning](/products/desktop/configuration/copilot-and-machine-learning#machine-learning) tab, you can toggle `Auto-Generated Tags`, `Auto-Generated Websites`, `Auto-Generated Hints`, and `Auto-Generated People`. +* `Processing Mode`: Choose between Cloud, Local, or Blended processing modes. -Adjust the *Enrichment Level* (0 to 9) or choose an *Enrichment Mode* (local, cloud, or blended). The LTM captures historical data for additional context—if needed, you can clear it to start fresh. +* `Ollama Status`: Check if Ollama is installed, activated, and ready for local model processing. -* `Auto-Generated Tags`: Enable or disable automated tagging. - -* `Auto-Generated Websites`, `Auto-Generated Hints`, `Auto-Generated People`: Fine-tune which content gets generated. - -* `Enrichment Level`: Control how detailed the ML analysis should be. - -* `Enrichment Mode`: Decide between local, cloud, or blended. - -* `Long-Term Memory Engine`: Provides temporal context, with an option to clear data. +* `Model Management`: Enable or disable specific AI models from different providers (OpenAI, Anthropic, Google, Microsoft, Meta, IBM, etc.). ### Views & Layouts -[Views & Layouts](/products/desktop/configuration/aesthetics-layout#adjusting-layout) controls how you see content in Pieces. +[Views & Layouts](/products/desktop/configuration/views-layouts) controls how you see content in Pieces. You can set a `Default Layout`, choose how items are sorted in list or gallery views, and select a `Default Search Mode` like `Neural Code Search (NCS)`. @@ -112,32 +104,28 @@ You’ll also find options for `Confirmation Settings` (for specific actions), t -### Aesthetics +### Appearance -In the [Aesthetics](/products/desktop/configuration/aesthetics-layout) tab, customize the overall appearance of Pieces. +In the [Appearance](/products/desktop/configuration/appearance) tab, customize the overall appearance of Pieces. -Switch between [light or dark mode](/products/desktop/configuration/aesthetics-layout#dark--light-mode), select an accent color for UI highlights, and `Zoom In/Out` to adjust the interface scale. +Switch between light or dark mode, select an accent color for UI highlights, adjust font size and weight, and configure visual density to control spacing and layout. These controls help you create a comfortable coding environment for extended sessions. -### Other Options & Settings Pages - -[Additional preferences](/products/desktop/configuration/additional-settings) live here, including [in-app notifications](/products/desktop/configuration/additional-settings#notification-preferences) (to minimize distractions or stay fully informed), Release Notes (for the latest updates), and Power Tips (for efficiency boosts). - -You can also manage Plugins, invite colleagues via *Refer a Friend*, and control how much crash or compliance data is shared under [Telemetry & Diagnostics.](/products/desktop/configuration/additional-settings#telemetry--diagnostics) +### Troubleshooting -* `In-App Notifications`: Decide which alerts you receive. +The [Troubleshooting](/products/desktop/configuration/troubleshooting) settings provide access to support resources, documentation links, version information, and feedback channels. -* `Release Notes`: View the most recent updates. +You can view PiecesOS and Desktop App version information, check for updates, access product documentation, report issues on GitHub, book support calls, and control how much crash or compliance data is shared under Privacy settings in Account. -* `Power Tips`: Learn shortcuts and advanced capabilities. +* `Online Resources`: Access product documentation and GitHub issues. -* `Plugins`: Extend Pieces with extra functionality. +* `Get In Touch`: Book support calls, contact the team, or visit the support hub. -* `Refer a Friend`: Invite others to use Pieces. +* `PiecesOS Information`: View version, port, and check for updates. -* `Telemetry & Diagnostics`: Configure data sharing preferences. +* `Desktop App Information`: View version, platform details, and check for updates. - \ No newline at end of file +* `Privacy`: Configure telemetry and diagnostics settings (found in Account settings). \ No newline at end of file diff --git a/public/content/desktop/onboarding.md b/public/content/desktop/onboarding.md index 291eeba..ac3f85e 100644 --- a/public/content/desktop/onboarding.md +++ b/public/content/desktop/onboarding.md @@ -5,89 +5,141 @@ visibility: PUBLIC status: PUBLISHED description: The Onboarding feature guides you through the initial stages of the Pieces Desktop App and sets you on your way to using the Long-Term Memory (LTM-2.7) Engine. metaTitle: Pieces Onboarding -metaDescription: Get up and running with the Pieces Desktop App with this guided LTM + Pieces Copilot onboarding experience. +metaDescription: Get up and running with the Pieces Desktop App with this guided LTM + Conversational Search onboarding experience. --- -## First Contact +## Signing In -When you first launch the Pieces Desktop App, you can choose from `Light` or `Dark` theme modes to suit your preferences; otherwise, this mode is tied to your system's preferences and will change periodically. +When you first launch the Pieces Desktop App, you'll be prompted to sign in with GitHub, Google, or other authentication providers. Signing in enables you to store snippets and backups in *Pieces Cloud* and import code Gists. Pieces stores materials locally by default, and you can share them with anyone you'd like. -You can also decide if you want to share *anonymous crash data* to help improve the product. + + + Open the Pieces Desktop App on your device. + + + Select your preferred sign-in method from the available options (GitHub, Google, Microsoft, or other providers). + + + Follow the prompts to complete authentication with your chosen provider. + + -A `Get Started` button takes you into the onboarding process. + + +> Login page showing sign-in options including GitHub, Google, and other authentication providers + +## Setting Up Preferences + +After signing in, configure your initial preferences including theme mode and data sharing settings. These settings help personalize your Pieces experience. + + + + Select `Light` or `Dark` theme mode to suit your preferences, or choose `System` to match your operating system's theme. This mode can be changed later in [Appearance settings](/products/desktop/configuration/appearance). + + + Decide if you want to share *anonymous crash data* to help improve the product. This setting can be changed later in [Troubleshooting settings](/products/desktop/configuration/troubleshooting). + + + Click `Get Started` to begin the onboarding process and start using Pieces. + + -### Cloud Accounts & Integrations +> Theme selection screen showing Light and Dark theme options, anonymous crash data toggle, and Get Started button -This step includes an option to sign in with GitHub, Google, or another wide range of options to import code Gists and relevant data. +## Initial Memory Formation -Pieces stores materials locally and allows you to share them with anyone you'd like. +After clicking `Get Started`, you'll land on the homepage of the Pieces Desktop App. The [Long-Term Memory (LTM-2.7)](/products/core-dependencies/pieces-os#ltm-27) Engine needs to capture workflow context before you can use all features. You'll see the *Single-Click Summaries* section with six cards that are locked until memory formation completes. -Signing in enables you to store snippets and backups in **Pieces Cloud**. +The homepage displays the *Single-Click Summaries* section with six cards: `What's Top of Mind`, `Standup Update`, `Time Breakdown`, `Custom Summary`, `Day Recap`, and `Discover`. These cards are grayed out and locked until memory formation completes. Below this section, you'll see the *Forming Initial Memories* progress tracker showing how many of the 30 required memories have been captured. - +### Understanding the LTM Welcome Screen + +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. -## The Magic Moment + -Once past the **Cloud Accounts & Integrations** screen, you’ll be launched into the default Pieces Desktop App view, which is the **Workstream Activity View.** +> LTM welcome screen explaining Long-Term Memory and its benefits -From here, you can follow the guided, interactive Long-Term Memory demo and experience your first *Magic Moment.* +### Creating Initial Memories - +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. -All you need to do is proceed with your workflow for 10-15 minutes while the [Long-Term Memory Engine (LTM-2.7)](/products/core-dependencies/pieces-os#ltm-27) captures memories—then, we’ll show you how to use it with Pieces Copilot. + - +> Initial memory formation screen showing progress tracker, memory formation status, and Single-Click Summary cards -### Workstream Activity Summaries +### Capturing Workflow Context -Now that you've successfully captured over 30 memories using the LTM, it's time for you to check out your summary to see how future summaries will appear. +Continue with your normal workflow for 10-15 minutes while LTM-2.7 captures workflow context in the background. The progress tracker shows memory formation status, and you can see which memories have been formed as you work. Each memory appears with a checkmark and description once it's been captured. - + + + Use your computer normally—browse documentation, write code, use your IDE, or work in other applications. LTM-2.7 captures workflow context automatically in the background. + + + Watch the progress tracker to see memory formation status. The tracker shows "X/30" memories captured, and you can see which memories have been formed as you work. + + + Once 30 memories are captured, the *Single-Click Summaries* cards unlock and become clickable. + + -These summaries include helpful links to collaboration-focused documents, reference conversations with coworkers you've participated in, provide links to articles you've mentioned, and show GitHub PRs or Jira tickets you've opened, among other things. +### Unlocking Features -From this point, you’ll see a highlighted button in the top-right corner of the Pieces Desktop App—this is where you can control LTM Engine Access Settings, which controls what applications Pieces is allowed to pull workflow context from. +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. - + -You’ll also be introduced to the **Power Menu**, from which you can access the Pieces Copilot view—that's where you’ll be headed next. +> Pieces Timeline showing unlocked Single-Click Summary cards and workflow events -### Pieces Copilot + LTM +## Using Conversational Search -[LTM](/products/core-dependencies/pieces-os#ltm-27) captures and stores workflow context in the [Pieces Drive](/products/core-dependencies/pieces-os#pieces-drive). You can visit a site like Stack Overflow, read code explanations, and later query Pieces Copilot about what you read. +[LTM](/products/core-dependencies/pieces-os#ltm-27) captures and stores workflow context, enabling you to use [Conversational Search](/products/desktop/conversational-search) as an AI assistant trained on your personal workflow data. All data is kept on-device for privacy, so your conversations and memories stay secure. - +### Understanding Conversational Search -By enabling LTM, you can use Pieces Copilot as an AI assistant trained on your personal workflow data, all of which is kept on-device. +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 interface showing model selection dropdown and available models - Read more about [data collection and storage.](/products/core-dependencies/on-device-storage) + Read more about [data collection and storage](/products/core-dependencies/on-device-storage). -Clicking the flashing button that reads *“Generate a stand-up styled summary of my recent work”* to have Pieces Copilot use LTM data to generate an output of what you did during the memory-capturing process. +### Accessing Conversational Search + +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 prompt into Conversational Search input field + +*** - +## Next Steps -You can also see the flashing LLM selector in the bottom-left corner of the app. This is where you’ll swap between cloud-hosted LLMs and local, on-device models, powered by [Ollama](/products/core-dependencies/ollama)—an optional dependency. +You've completed the Pieces onboarding and are ready to start exploring the app. Learn more about key features and how to utilize the Pieces ecosystem in your daily workflow. -## Additional Documentation +### Explore Key Features -That’s it! You’ve completed the Pieces onboarding and are ready to start exploring the app and discovering how to utilize the features and functionalities of the Pieces ecosystem in your daily workflow. +* **[Conversational Search](/products/desktop/conversational-search)** - Ask questions about your workflow, get context-aware responses, and receive insights powered by LTM-2.7—all in a chat format you know. -If you want to read more, click the links below to jump to additional documentation: +* **[Pieces Timeline](/products/desktop/timeline)** - View incremental workflow summaries, saved context, and related information gathered by the Long-Term Memory (LTM-2.7) Engine. -* [Pieces Copilot](/products/desktop/copilot)—Ask technical questions, create code snippets, get help with debugging, and receive insights—all in a chat format you know. +* **[Single-Click Summaries](/products/desktop/single-click-summaries)** - Generate instant, contextual summaries from your workflow using preset summary types. -* [Pieces Drive](/products/desktop/drive)—Save, access, edit, and reuse materials saved to the Pieces Drive. +### Customize Your Experience -* [Workstream Activity](/products/desktop/workstream-activity)—View incremental workflow summaries, saved context, and related information gathered by the Long-Term Memory (LTM-2.7) Engine. +* **[Configuration](/products/desktop/configuration)** - Customize everything from visuals and aesthetics to Conversational Search models to fit your preferences and workflow. -* [Navigation](/products/desktop/navigation)—Learn the different views and layouts in the Pieces Desktop App and discover the Power Menu. +* **[Navigation](/products/desktop/navigation)** - Learn the different views and layouts in the Pieces Desktop App. -* [Configuration](/products/desktop/configuration)—Customize everything from visuals and aesthetics to Pieces Drive enrichment and Pieces Copilot models to fit your preferences and workflow. +* **[Actions & Keyboard Shortcuts](/products/desktop/actions)** - Use *Power Menu* Actions and Keyboard Shortcuts to perform tasks or navigate from view to view quickly. -* [Actions & Keyboard Shortcuts](/products/desktop/actions)—Use Power Menu Actions and Keyboard Shortcuts to perform tasks or navigate from view to view quickly. +### Get Help -* [Troubleshooting](/products/desktop/troubleshooting)—If the Pieces Desktop App isn't working as expected, start here. This page explains our troubleshooting documentation and guides you to the solution that best addresses your issue. \ No newline at end of file +* **[Troubleshooting](/products/desktop/troubleshooting)** - If the Pieces Desktop App isn't working as expected, start here. This page explains our troubleshooting documentation and guides you to the solution that best addresses your issue. diff --git a/public/content/desktop/single-click-summaries.md b/public/content/desktop/single-click-summaries.md new file mode 100644 index 0000000..4be08f8 --- /dev/null +++ b/public/content/desktop/single-click-summaries.md @@ -0,0 +1,283 @@ +--- +title: Single-Click Summaries +path: /desktop/single-click-summaries +visibility: PUBLIC +status: PUBLISHED +description: Generate instant, contextual summaries from your workflow using preset summary types in Timeline. +metaTitle: Single-Click Summaries | Pieces Timeline +metaDescription: Generate instant, contextual summaries from your workflow using preset summary types in Pieces Timeline. +--- + + + +## Overview + +Single-Click Summaries are quick-access actions prominently displayed when you first open the Pieces Desktop App. These summaries generate instant, contextual insights from your workflow captured by the [Long-Term Memory (LTM-2.7)](/products/core-dependencies/pieces-os#ltm-27) Engine. + +Each summary type adapts dynamically to your workflow, meaning the same summary type generates different results based on your current activities, captured memories, and work patterns. This makes Single-Click Summaries powerful tools for understanding your productivity, tracking progress, and identifying patterns in your work. + +## Generating Summaries + +Generating a single-click summary lets you quickly extract insights from your workflow without writing prompts. Click any summary card on the homepage and after a few minutes, you'll see your summary in the [Pieces Timeline](/products/desktop/timeline). + + + You can queue multiple unique summaries at once, but wait for the current one to finish before starting another of the same type. + + +### Viewing Queued Summaries + +Track your summaries as they generate in the Pieces Timeline. When you generate a summary, it appears under the current day in Pieces Timeline with a "Queued" status. Summaries are organized by day, and you can expand or collapse each day to view its contents. + + + + Click `Show Timeline` in the top left of the main view to expand Pieces Timeline if it's not already open. + + + The current day section appears at the top of Pieces Timeline, below the `Filter Timeline` search bar. It shows the date (e.g., "Today, Jan 21st") with a count of items. + + + Click on the current day section to expand it and view all summaries, timeline activities, and other events for that day. + + + Queued summaries appear under the current day with a "Queued" status indicator. You can see which summaries are waiting to be processed and their position in the queue (e.g., "Queued (#3)", "Queued (#2)", "Next in queue"). + + + Actively generating summaries display a loading indicator, while queued summaries show their position in the queue. + + + + + +> 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" + +### Canceling a Summary + +Stop any running summary generation from the Pieces Timeline. Locate the summary you want to cancel under the current day in Pieces Timeline and click the red cancel button to stop it. + + + + Click `Show Timeline` in the top left to expand the Pieces Timeline. + + + Click on the current day section to expand it and view all summaries for that day. + + + Locate the summary you want to cancel under the current day. It will show a "Queued" status indicator. + + + Click the red cancel button on the right side of the summary item (hovering shows `Stop Generating`). This stops the generation process and removes it from your queue. + + + +### Completing and Viewing Summaries + +Access your completed summaries and view the full results. When a summary finishes generating, it remains in the day section where it was queued. Click it to view detailed insights, related activities, and links to relevant documents or commits from your workflow. + + + + When a summary finishes generating, it remains in the day section where it was queued. The summary will no longer show a "Queued" status. + + + Click the completed summary in your Pieces Timeline to view the full results. Summaries include detailed insights, related activities, and links to relevant documents or commits from your workflow. + + + Scroll through the expanded day section to view all summaries, both queued and completed, organized chronologically. + + + + + +> Completed summary view showing full results with insights, related activities, and links to relevant documents + +## Using Summary Types + +Learn how to use specific summary types and customize them for your workflow. + +### Summary Types + +Single-Click Summaries include preset summary types designed for common workflow needs. Each type generates insights tailored to your specific work patterns and captured activities. + +| **Summary Type** | **Description** | +|------------------|-----------------| +| **What's Top of Mind** | Identifies recurring topics and priorities from your recent workflow, ranked by importance. | +| **Morning Brief** | Provides everything you need to kickstart your day, compiled from your recent activities. | +| **Standup Update** | Generates a three-part update: what you did, what's next, and blockers—perfect for team standups. | +| **Day Recap** | Compiles an end-of-day summary of your accomplishments, completed tasks, and overall activity. | +| **Time Breakdown** | Organizes your daily work into projects with in-depth time breakdowns, showing what you worked on per project throughout the day. | +| **Week Recap** | Provides a comprehensive overview of your week at a glance, including key activities and patterns. | +| **Custom Summary** | Generate summaries based on specific time ranges and topics you choose. | +| **AI Habits** | Analyzes how you interact with AI tools, showing patterns in questions asked and topics queried. | +| **Professional Persona** | Provides work style analysis and professional summary based on your workflow patterns. | +| **Collaboration Patterns** | Identifies who you work with and how, revealing collaboration dynamics in your workflow. | +| **Discover** | Access additional summary options and request new summary types through a popup interface. | + +### What's Top of Mind + +Identifies recurring topics and priorities from your recent workflow, ranked by importance. This summary helps you understand what's been occupying your attention and what matters most in your current work. + + + +### Standup Update + +Generates a three-part update: what you did, what's next, and blockers—perfect for team standups. Use this summary to quickly prepare for team meetings and share your progress. + + + +### Day Recap + +Compiles an end-of-day summary of your accomplishments, completed tasks, and overall activity. Review your day's work and track your productivity patterns. + + + +### Time Breakdown + +Organizes your daily work into projects with in-depth time breakdowns, showing what you worked on per project throughout the day. This summary takes all the work you've done through the day, categorizes it by project, and provides detailed time tracking for each project and activity. + + + +### Week Recap + +Provides a comprehensive overview of your week at a glance, including key activities and patterns. Get a high-level view of your weekly productivity and accomplishments. + + + +### Morning Brief + +Provides everything you need to kickstart your day, compiled from your recent activities. Start your day informed about what you've been working on and what's coming up. + + + +### Professional Persona + +Provides work style analysis and professional summary based on your workflow patterns. Understand your professional habits, strengths, and work patterns. + + + +### Collaboration Patterns + +Identifies who you work with and how, revealing collaboration dynamics in your workflow. Discover your collaboration habits and team interaction patterns. + + + +### AI Habits + +Analyzes how you interact with AI tools, showing patterns in questions asked and topics queried. Understand your AI usage patterns and how you leverage AI assistance in your workflow. + + + +### Using Custom Summary + +Generate summaries tailored to specific time periods and topics that matter to you. Custom Summary gives you full control over what gets summarized—select time ranges from your [Pieces Timeline](/products/desktop/timeline) events and optionally add a focus to narrow your summary further. + + + + + + Click the **Custom Summary** card on the homepage. + + + In the popup, choose a time range from the dropdown. Options include "Just now," "Within the last hour," "Today," or select custom dates. + + + Click `Add Focus` and type in a topic, client, project, or specific area you want the summary to emphasize. This helps generate more targeted insights for particular aspects of your work. + + + Click `Generate` to start creating your custom summary. + + + +### Using Discover + +Access additional summary options and request new summary types through Discover. Click the `Discover` summary card to open a popup displaying available summary options—you'll see the standard summary types plus additional options you haven't encountered yet, expanding your choices for generating insights. + + + +> Discover popup showing available summary options including Request a Summary + +### Requesting a New Summary Type + +Suggest new summary types to help shape future Single-Click Summary options. From the Discover popup, select `Request a Summary` to open a form where you can describe what you need. + + + + Click the `Discover` summary card on the homepage. + + + In the Discover popup, select `Request a Summary`. + + + Type an artifact name (up to 50 characters) describing the summary type you want. + + + Enter a description (up to 500 characters) explaining what this artifact should do and how it would help you. + + + Click `Submit Request` to send your suggestion to the Pieces team. + + + + + +> Request a Summary popup with Artifact Name and Description fields, and Submit Request button + +## Managing Your Summaries + +Track, view, and manage your generated summaries through the [Pieces Timeline](/products/desktop/timeline). All generated summaries appear in your Pieces Timeline, organized chronologically by day. When you generate a summary, it appears under the current day with a "Queued" status. Once complete, summaries remain in the day section where they were created, and you can browse, search, and access them anytime. + + + + Click `Show Timeline` in the top left to expand the Pieces Timeline. + + + Click on the current day section (e.g., "Today, Jan 21st") to expand it and view all summaries and activities for that day. + + + Queued summaries appear under the current day with a "Queued" status indicator, showing their position in the processing queue (e.g., "Queued (#3)", "Next in queue"). + + + Once summaries finish generating, they remain in the day section. Scroll through the expanded day section to view all summaries, both queued and completed. + + + Click any summary in your Pieces Timeline to view the full results, including detailed insights, related activities, and links to relevant documents or commits. + + + Click the `caret icon` (dropdown arrow) at the top of the day divider to collapse the section and hide its contents. + + + +*** + +If Single-Click Summaries isn't what you're looking for, check out the [Timeline](/products/desktop/timeline)—your next-best stop for learning about how Pieces [stores memories](/products/desktop/timeline/timeline-events). diff --git a/public/content/desktop/timeline.md b/public/content/desktop/timeline.md new file mode 100644 index 0000000..47fce3c --- /dev/null +++ b/public/content/desktop/timeline.md @@ -0,0 +1,178 @@ +--- +title: Pieces Timeline +path: /desktop/timeline +visibility: PUBLIC +status: PUBLISHED +description: Pieces Timeline is your central workspace for viewing all workflow events, summaries, and conversational searches captured by the Long-Term Memory (LTM-2.7) Engine. +metaTitle: Pieces Timeline | Pieces Docs +metaDescription: Access your workflow history, view summaries, and manage timeline events in Pieces Timeline—your central workspace for captured workflow context. +--- + + + +*** + +## Overview + +**Pieces Timeline** is your central workspace in the Pieces Desktop App for accessing all workflow context captured by the [Long-Term Memory (LTM-2.7)](/products/core-dependencies/pieces-os#ltm-27) Engine. Timeline displays a chronological view of your workflow events, including [timeline events](/products/desktop/timeline/timeline-events), [single-click summaries](/products/desktop/single-click-summaries), and [conversational searches](/products/desktop/conversational-search). + +All events are organized chronologically from most recent at the top to oldest at the bottom, grouped by day. Each day section can be expanded or collapsed by clicking on it or using the caret icon. You can scroll through your timeline, filter events by type or source, and click any event to view its full content in the main view. + +## Opening Pieces Timeline + +Access Pieces Timeline from the main view to see all your workflow events and summaries. + + + + Click the `Show Timeline` button in the top left of the main view if Pieces Timeline isn't already open. + + + The Pieces Timeline opens on the left side, showing all your workflow events organized chronologically. + + + Click `Show Timeline` again to close Pieces Timeline and return to the main view. + + + + + +> Main view showing `Show Timeline` button in top left, with Pieces Timeline open displaying chronological events + +## Understanding Timeline Contents + +Pieces Timeline displays three main types of events, all organized chronologically from most recent to oldest: + +* **Timeline Events** - Workflow moments captured by LTM-2.7, including code changes, document edits, and other activities from your connected applications. Timeline Events also include automatically generated summaries that capture your work patterns, such as `Day Recap`, `Morning Brief`, `Week Recap`, and `What's Top of Mind`. These events compile what you've been working on, conversations you've had, and activities you've completed. + +* **Single-Click Summaries** - [Summaries you generate on demand](/products/desktop/single-click-summaries) by clicking summary cards on the homepage, including Standup Update, Custom Summary, AI Habits, and more. Once generated, they appear as Timeline Events in your timeline. + +* **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. + + + +> Pieces Timeline showing different event types: conversational search event, standup update summary, and timeline events with app icons + +## Viewing Queued Summaries + +When you generate single-click summaries, they appear under the current day in Pieces Timeline with a "Queued" status. Summaries are organized by day, and you can expand or collapse each day to view its contents. + + + + Click `Show Timeline` in the top left of the main view to expand Pieces Timeline if it's not already open. + + + The current day section appears at the top of Pieces Timeline, below the `Filter Timeline` search bar. It shows the date (e.g., "Today, Jan 21st") with a count of items. + + + Click on the current day section to expand it and view all summaries, timeline activities, and other events for that day. + + + Queued summaries appear under the current day with a "Queued" status indicator. You can see which summaries are waiting to be processed and their position in the queue (e.g., "Queued (#3)", "Queued (#2)", "Next in queue"). + + + Click the `caret icon` (dropdown arrow) at the top of the day divider to collapse the day section and hide its contents. + + + + + +> 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" + + + Once summaries finish generating, they remain in the day section where they were queued. You can click on any summary to view its full content, whether it's queued, processing, or completed. + + +## Viewing Event Content + +Click any event in Pieces Timeline to view its full content in the main view panel. + + + + Click any event in Pieces Timeline—this can be a timeline event, summary, or conversational search. + + + The event's full content opens in the main view panel on the right, replacing the homepage view. + + + Use the left and right arrow buttons in the event header to navigate to previous or next events without returning to Pieces Timeline. + + + Click the `home` icon or close the event view to return to browsing Timeline Events. + + + + + +> Event selected in Pieces Timeline (highlighted) with its full content displayed in the main view panel on the right + +## Managing Event Groups + +Events in Pieces Timeline are automatically grouped by day, making it easy to find activities from specific time periods. + +### Understanding Day Groups + +Events are organized into collapsible groups labeled by date: +* **Today** - Events from the current day +* **Yesterday** - Events from the previous day +* **[Date]** - Older events grouped by specific dates (e.g., "Jan 14th") + +Each group header displays the date and a count of events in that group (e.g., "Today, Jan 15th (2)"). + +### Collapsing and Expanding Groups + +Organize your Timeline view by collapsing groups you don't need to see. + + + + Find the date group header you want to collapse (e.g., "Yesterday, Jan 14th"). + + + Click the group header to collapse it. The group collapses, hiding all events within it. + + + Click the collapsed group header again to expand it and view all events. + + + +### Jump to Summary in List + +Quickly navigate to a specific event's position in the Timeline sidebar when viewing its content. + + + + Click an event in Timeline to view its content in the main view. + + + Click the `Jump to Summary in List` button (target icon) next to the `Filter List` button in Pieces Timeline header. This scrolls Pieces Timeline to show where the current event appears in the chronological list. + + + Alternatively, click the `collapse` button to collapse all event groups at once, giving you a compact view of all dates. + + + + + +> Pieces Timeline showing day groups (Today expanded, Yesterday collapsed) with event counts, and `Jump to Summary in List` button visible in header + +## Filtering Timeline Events + +Filter your Timeline to focus on specific event types, sources, or applications. Use the Filter List button to access all filtering options. + + + Learn how to filter Timeline events by type, source, application, and favorites to find exactly what you need. + + +## Event Actions and Menus + +Different event types have different actions available through the three-dots menu. Conversational searches have the most options, while summaries have simpler action sets. + + + Learn how to favorite events, generate titles and summaries, delete events, and understand which actions are available for each event type. + + +*** + +If Pieces Timeline isn't what you're looking for, check out [Single-Click Summaries](/products/desktop/single-click-summaries) to learn how to generate instant summaries, or explore [Conversational Search](/products/desktop/conversational-search) to have conversations with your memories. diff --git a/public/content/desktop/timeline/conversational-chat.md b/public/content/desktop/timeline/conversational-chat.md new file mode 100644 index 0000000..d3a3a4c --- /dev/null +++ b/public/content/desktop/timeline/conversational-chat.md @@ -0,0 +1,101 @@ +--- +title: Conversational Chat +path: /desktop/timeline/conversational-chat +visibility: PUBLIC +status: PUBLISHED +description: Ask questions about your workflow with context-aware assistance powered by LTM-2.7 in Conversational Chat. +metaTitle: Conversational Chat | Timeline +metaDescription: Ask questions about your workflow with context-aware assistance powered by LTM-2.7 in Conversational Chat. +--- + +## Conversational Chat + +**Conversational Chat** is your conversational interface for asking questions about your workflow. Powered by the [Long-Term Memory (LTM-2.7)](/products/core-dependencies/pieces-os#ltm-27) Engine with access to up to 9 months of captured context, it searches your actual memories—conversations, documents, commits, and decisions. + +Unlike generic AI, responses reference your specific work. Related Roll-Ups cards below responses reveal which memories were used. + + + +> Conversational Chat section showing suggested prompts: "Explain Conversational Chat", "Summarize my memories", "Document onboarding changes", and "Start New Chat" button + +## Getting Started + +### Suggested Prompts + +Three contextual prompt buttons appear based on your recent activity. Click any prompt to instantly ask that question. + +Prompts update dynamically (e.g., "Summarize my memories", "Document onboarding changes"). Click the refresh icon next to the **CONVERSATIONAL CHAT** header for new suggestions. + +### Starting a Chat + +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. + + + +> Clicking a suggested prompt or Start New Chat, showing the chat interface opening + +## How It Works + +### Context-Aware Responses + +When you ask a question, Conversational Chat searches your captured memories for relevant context. It references your specific activities, not generic AI knowledge, providing personalized answers based on your actual work. + +It can recall specific conversations, documents, decisions, and problems you've encountered. + +### Related Roll-Ups + +Below each response, "Related Workstream Activities" cards appear showing which specific memories were used in the answer. + +Each card is clickable and takes you to full LTM Roll-Up details, providing transparency into where information came from. + + + +> Chat response with 2-3 Related Roll-Up cards below, showing user clicking a card to view full roll-up + +## Choosing Your AI Model + +### Model Selector (Bottom-Left Corner) + +The model selector shows **Recent models** and **Suggested models** sections. + +* **Cloud models** (Claude 4.1 Opus, Claude 4 Sonnet, etc.)—Faster responses and advanced reasoning. +* **Local models** (o3, o1, GPT-4, etc.)—Complete privacy and work offline. + +Click any model name to switch. Use the "All Models" button to see the complete list. + +### Additional Controls (Bottom Toolbar) + +* **Sources**—Control which data sources are used. +* **Time Ranges**—Filter memories by time period. +* **Activate DeepStudy**—Enhanced research mode for comprehensive analysis. + + + +> Model selector dropdown showing Recent and Suggested sections with available models, plus bottom toolbar with Sources, Time Ranges, and Activate DeepStudy buttons + +## Asking Effective Questions + +**Questions that work well:** + +* **Time-based**: "What did I work on yesterday afternoon?", "Summarize my week" +* **Topic-specific**: "Find conversations about the API redesign" +* **Decision recall**: "Why did we decide to use PostgreSQL?" +* **Reference finding**: "Find that link about React performance" +* **Summary requests**: "Give me a recap of client feedback" + +**Making questions more specific:** Include timeframes ("yesterday", "last week", "between Monday and Wednesday") and mention projects, people, or topics ("work on the dashboard", "conversations with Tom"). Use follow-up questions—the chat maintains conversation context. + +## Managing Chats + +Chats auto-save and appear in the [Timeline Activities](/products/desktop/timeline/timeline-activities) sidebar, listed chronologically with other workflow activities. + +Click previous chats in the sidebar to continue conversations. Use `Start New Chat` for fresh conversations on new topics. + +## Tips & Best Practices + +* Start with suggested prompts to discover what works, then adapt them to your needs. +* Be specific with timeframes: "last Tuesday" works better than "recently". +* Check Related Roll-Ups to verify information sources and access full context. +* Use follow-up questions to dig deeper—context is maintained within conversations. +* Try different models for different tasks (local for privacy, cloud for speed). +* Remember: Conversational Chat only knows about your captured workflow—not work done before you started using Pieces or in applications where LTM is disabled. diff --git a/public/content/desktop/timeline/event-actions.md b/public/content/desktop/timeline/event-actions.md new file mode 100644 index 0000000..a44622e --- /dev/null +++ b/public/content/desktop/timeline/event-actions.md @@ -0,0 +1,145 @@ +--- +title: Event Actions and Menus +path: /desktop/timeline/event-actions +visibility: PUBLIC +status: PUBLISHED +description: Learn how to favorite events, generate titles, delete events, and understand which actions are available for each event type in Pieces Timeline. +metaTitle: Event Actions and Menus | Pieces Timeline +metaDescription: Manage Timeline events with actions like favoriting, generating titles, and deleting events based on event type. +--- + +## Event Actions and Menus + +All events in Pieces Timeline—including conversational searches, Timeline Events (automatically generated summaries like `Day Recap`, `Morning Brief`, `Week Recap`, and `What's Top of Mind`), and single-click summaries—appear in your Timeline and have actions available through the `three-dots menu`. Available actions include favoriting, generating titles (for conversational searches), and deleting events. + +Understanding which actions are available helps you manage your Timeline effectively and customize events to fit your workflow needs. + + + +> Event content view showing three-dots menu icon in the header with menu options visible + +## Accessing Event Actions + +Open the action menu for any event to see available options based on the event type. + + + + Click an event in Pieces Timeline to open its content in the main view panel. + + + Find the `three-dots menu icon` (⋮) in the event header, typically located in the top-right area of the event view. + + + Click the `three-dots menu icon` to open the action menu. Available actions appear based on the event type. + + + + + +> Three-dots menu open showing available actions for a conversational search event + +## Timeline Event Actions + +All events in Pieces Timeline—conversational searches, Timeline Events (including automatically generated summaries like `Day Recap`, `Morning Brief`, `Week Recap`, and `What's Top of Mind`), and single-click summaries—share common actions available through the `three-dots menu`. + +### Favoriting Events + +Mark important events as favorites to quickly find them later. + + + + Click the `three-dots menu icon` on any event in Pieces Timeline. + + + Click `Favorite` in the menu to mark the event as a favorite. A star icon appears next to the event in Timeline. + + + Click `Favorite` again to remove the favorite status if needed. + + + + + +> Event with star icon indicating it's favorited, and three-dots menu showing Favorite option + +### Generating Titles + +Regenerate the title for conversational search events to better reflect their content or purpose. Timeline Events and single-click summaries don't have this option because their titles are already generated by the LTM-2.7 Engine. + + + + Click the `three-dots menu icon` on a conversational search event. + + + Click `Generate Title` in the menu. Pieces uses AI to analyze the conversation content and generate a new, more descriptive title that better reflects the conversation's content or main topic. + + + The event title updates in Timeline and in the event header with the new title. + + + + + Use Generate Title when the auto-generated title doesn't accurately describe the conversation, or when you want a more specific or descriptive title for easier searching later. + + +### Deleting Events + +Remove events from your Timeline. Deletion is permanent and cannot be undone. + + + + Click the `three-dots menu icon` on any event in Pieces Timeline. + + + Click `Delete` in the menu. A confirmation popup appears asking you to confirm the deletion. + + + Review the confirmation message, which shows the event title and warns that "This action cannot be undone." + + + Click the red `Delete` button in the popup to confirm deletion, or click `Cancel` or the `X` icon to close without deleting. + + + The event is permanently removed from your Timeline and cannot be recovered. + + + + + +> Delete confirmation popup showing event title with warning message and Delete/Cancel buttons + + + Deleting events is permanent. Make sure you want to remove the event before confirming deletion, as it cannot be recovered. + + +## Filtering by Favorites + +After favoriting events, use the favorites filter to view only your favorited events in Timeline. + + + + Click the `Filter List` button at the top of Pieces Timeline. + + + Look for a `Favorites` option in the filter menu, or access it through the filter options. + + + Timeline updates to show only events you've marked as favorites. All favorited events display with star icons. + + + + + +> Timeline filtered to show only favorited events, all displaying star icons + + + Use favorites to mark important conversations, summaries, or events you want to reference frequently. Then filter by favorites to quickly access your most important Timeline items. + + +*** + +## Next Steps + +Now that you know how to manage Timeline events with actions, explore how to filter your Timeline to find specific events quickly. + +[Filtering Timeline Events →](/products/desktop/timeline/filtering-events) diff --git a/public/content/desktop/timeline/filtering-events.md b/public/content/desktop/timeline/filtering-events.md new file mode 100644 index 0000000..c768a69 --- /dev/null +++ b/public/content/desktop/timeline/filtering-events.md @@ -0,0 +1,217 @@ +--- +title: Filtering Timeline Events +path: /desktop/timeline/filtering-events +visibility: PUBLIC +status: PUBLISHED +description: Learn how to filter Pieces Timeline events by type, source, application, and favorites to find exactly what you need. +metaTitle: Filtering Timeline Events | Pieces Timeline +metaDescription: Filter Timeline events by type, source, application, and favorites to focus on specific workflow moments and activities. +--- + +## Filtering Timeline Events + +Filter your Pieces Timeline to focus on specific event types, sources, or applications. Filtering helps you quickly find conversations, summaries, or activities from particular apps or time periods without scrolling through your entire timeline. + +Use the `Filter List` button to access all filtering options, or hover over summaries to filter by specific applications that contributed to those summaries. + + + +> Pieces Timeline with Filter List menu open showing filter options for event types, work summaries, and sources + +## Accessing Filter List + +Open the Filter List menu to access all filtering options for your Timeline events. + + + + Click `Show Timeline` in the top left of the main view to expand Pieces Timeline if it's not already open. + + + Click the `Filter List` button (three horizontal lines icon) at the top of Pieces Timeline. + + + The Filter List menu opens, displaying all available filter categories including Chats, Work Summaries, single-click summary types, and Sources. + + + + + +> Filter List button in Timeline header with menu open showing filter categories + +## Filtering by Event Type + +Filter Timeline events by their type to focus on specific kinds of activities. + +### Filtering by Chats + +Show only conversational search events in your Timeline. + + + + Click the `Filter List` button at the top of Pieces Timeline. + + + Click `Chats` in the filter menu. Pieces Timeline updates to show only conversational search events, hiding other event types. + + + Scroll through the filtered Timeline to see only chat conversations. + + + +### Filtering by Work Summaries + +Show only Timeline Events—workflow moments captured by LTM-2.7, including automatically generated summaries based on your workflow patterns. + + + + Click the `Filter List` button at the top of Pieces Timeline. + + + Click `Work Summaries` in the filter menu. The menu expands to show individual work summary types. + + + Select a specific work summary type, or leave `Work Summaries` selected to show all work summary types: + * **Day Recap** - End-of-day summaries + * **Morning Brief** - Daily morning summaries + * **Standup Update** - Standup-style updates + * **Week Recap** - Weekly overviews + * **What's Top of Mind** - Priority-focused summaries + + + Pieces Timeline updates to show only the selected work summary types. + + + + + +> Filter List menu with Work Summaries expanded showing individual summary type options + +### Filtering by Single-Click Summary Types + +Filter to show only specific single-click summary types you've generated. + + + + Click the `Filter List` button at the top of Pieces Timeline. + + + Under `Work Summaries`, click a specific single-click summary type: + * **Day Recap** + * **Morning Brief** + * **Standup Update** + * **Week Recap** + * **What's Top of Mind** + * **Custom Summary** + * **AI Habits** + * **Discover** + + + Timeline updates to show only events matching the selected summary type. + + + +## Filtering by Sources + +Filter Timeline events by the applications or sources that captured them. + + + + Click the `Filter List` button at the top of Pieces Timeline. + + + Click `Sources` in the filter menu. The menu expands to show a list of all applications that have captured events. + + + Check the applications you want to include. You can select multiple applications at once. Available sources include Activity Monitor, Chrome, VS Code, Cursor, Calendar, Claude, and more based on your connected applications. + + + Pieces Timeline updates to show only events captured from the selected applications. + + + + + +> Filter List menu with Sources expanded showing list of applications with checkboxes + +## Filtering by Applications + +When viewing summaries in Timeline, you can filter by specific applications that contributed to those summaries by hovering over the summary. + + + + Find a summary in your Timeline that has application icons displayed (small colorful icons showing which apps contributed to the summary). + + + Hover your cursor over the summary card. Application icons become interactive. + + + Click on a specific application icon to filter Pieces Timeline to show only events that used that application to generate summaries or capture activities. + + + Pieces Timeline updates to show only events related to the selected application. + + + + + +> Hovering over a summary showing interactive application icons (Chrome, Cursor, etc.) that can be clicked to filter + + + Filtering by applications from summaries helps you understand which tools contributed to specific summaries and find related activities from those same applications. + + +## Filtering by Favorites + +Show only events you've marked as favorites in your Timeline. + + + + Click the `Filter List` button at the top of Pieces Timeline. + + + Look for a `Favorites` option in the filter menu (if available) or use the favorites filter from the event actions menu. + + + Pieces Timeline updates to show only events you've favorited. Events with a star icon appear in the filtered view. + + + + + To favorite an event, open the event's `three-dots menu` and select "Favorite." Learn more about favoriting events in [Event Actions and Menus](/products/desktop/timeline/event-actions). + + +## Clearing Filters + +Reset your Timeline view to show all events without any filters applied. + + + + Click the `Filter List` button at the top of Pieces Timeline. + + + Click the `X` icon next to "Filter List" or deselect all active filter options to clear filters. + + + Pieces Timeline returns to showing all events chronologically, with all filters cleared. + + + + + +> Filter List menu with `X` icon visible to close/clear filters + +## Combining Filters + +You can combine multiple filters to create precise views of your Timeline. For example, filter by "Standup Update" summaries from "VS Code" to see only standup summaries that included VS Code activities. + + + Combining filters helps you find very specific workflow moments. Start with a broad filter (like event type) and then narrow it further with source or application filters. + + +*** + +## Next Steps + +Now that you know how to filter Timeline events, learn how to manage individual events with actions like favoriting, generating titles, and deleting events. + +[Event Actions and Menus →](/products/desktop/timeline/event-actions) diff --git a/public/content/desktop/timeline/ltm-rollups.md b/public/content/desktop/timeline/ltm-rollups.md new file mode 100644 index 0000000..1d99968 --- /dev/null +++ b/public/content/desktop/timeline/ltm-rollups.md @@ -0,0 +1,135 @@ +--- +title: LTM Roll-Ups & Managing +path: /desktop/timeline/ltm-rollups +visibility: PUBLIC +status: PUBLISHED +description: Comprehensive guide to viewing, editing, exporting, and managing LTM Roll-Ups—detailed workflow summaries generated by LTM-2.7. +metaTitle: LTM Roll-Ups & Managing | Timeline +metaDescription: Comprehensive guide to viewing, editing, exporting, and managing LTM Roll-Ups—detailed workflow summaries generated by LTM-2.7. +--- + +## LTM Roll-Ups + +View detailed summaries of workflow periods automatically generated by LTM-2.7. + +LTM Roll-Ups are detailed summaries of your workflow periods, automatically generated approximately every 30 minutes by the [Long-Term Memory (LTM-2.7)](/products/core-dependencies/pieces-os#ltm-27) Engine. View them by clicking any activity in the [Timeline Activities](/products/desktop/timeline/timeline-activities) sidebar. Each roll-up includes tasks, decisions, documents, and follow-ups from that time period. You can edit, export, or delete them as needed. + +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. + + + +> Complete roll-up displayed in the main panel showing all sections + +## Roll-Up Structure + +Understand what information is included in each roll-up. + +Each roll-up contains structured information about your workflow period, organized into clear sections that make it easy to understand what happened and what's important. + +Each roll-up includes: + +* **Core Tasks & Projects**—What you worked on and problems solved +* **Key Decisions & Discussions**—Important conversations and choices made +* **Documents & Code Reviewed**—Files and links you accessed (with deep links) +* **Follow-Up Actions**—What still needs attention + +Roll-ups created through Model Context Protocol (MCP) integrations display a "Formed with MCP" indicator. + + + +> Roll-up sections with annotations showing Core Tasks, Key Decisions, Documents, and Follow-Up Actions + +## Viewing Roll-Ups + +Open and navigate roll-ups from the Timeline Activities sidebar. + +#### Opening a Roll-Up + +Click an activity to view its full roll-up details: + + + + Click any activity in Pieces Timeline. + + + The full roll-up displays in the main panel with all sections. Deep links open resources directly in your browser. + + + Use the `Jump to Summary In List` button in the roll-up header to scroll Pieces Timeline back to that activity's position. + + + + + +> Roll-up displayed with the corresponding activity highlighted in the Timeline Activities sidebar + +## Roll-Up Actions + +Use toolbar actions to interact with roll-ups. + +From the toolbar, you can: + +* **Start Copilot Chat**—Ask questions with roll-up context loaded +* **Export**—Download as `PDF`, `Markdown`, or `Plain Text` +* **Edit**—Open markdown editor to customize content +* **More menu**—Copy or Delete +* **macOS Share**—Share to AirDrop, Mail, Messages, etc. + + + +> Toolbar with all action buttons labeled + +## Editing Roll-Ups + +Customize roll-up content using the markdown editor. + +#### Editing a Roll-Up + +Modify roll-up content using the built-in markdown editor: + + + + Click the `Edit` button in the roll-up toolbar. + + + Use the markdown editor toolbar for formatting: **Bold**, *Italic*, Link, Code Block. + + + Click `Save and Exit` to apply changes or `Cancel and Exit` to discard them. + + + + + +> Markdown editor interface showing formatting toolbar and editable content + +## Privacy Control + +Control which applications LTM captures context from. + +Privacy Control lets you choose which applications contribute to your roll-ups. This helps you maintain privacy by excluding sensitive applications or focusing roll-ups on specific types of work. + +#### Managing Privacy Settings + +Configure which applications LTM captures from: + + + + Click the grid icon in Timeline or access through the PiecesOS taskbar. + + + Toggle sources on or off anytime—disabled sources are removed from existing and future roll-ups. + + + + + +> LTM Access Control modal showing toggle switches for different application sources + +*** + +## Next Steps + +Now that you know how to view and manage LTM Roll-Ups, learn how to browse and search your workflow activities. + +[Timeline Activities →](/products/desktop/timeline/timeline-activities) diff --git a/public/content/desktop/timeline/timeline-events.md b/public/content/desktop/timeline/timeline-events.md new file mode 100644 index 0000000..d65fca8 --- /dev/null +++ b/public/content/desktop/timeline/timeline-events.md @@ -0,0 +1,148 @@ +--- +title: Timeline Events +path: /desktop/timeline/timeline-events +visibility: PUBLIC +status: PUBLISHED +description: Browse and search your chronological list of captured activities and conversations in the Timeline Events sidebar. +metaTitle: Timeline Events | Timeline +metaDescription: Browse and search your chronological list of captured activities and conversations in the Timeline Events sidebar. +--- + +## Timeline Events + +Timeline Events is the chronological sidebar that displays all activities and conversations captured by the [Long-Term Memory (LTM-2.7)](/products/core-dependencies/pieces-os#ltm-27) Engine. Located on the left side of Timeline, it serves as your navigation hub for accessing any past workflow context. The sidebar organizes your activities by date, making it easy to find specific items whether they happened today or months ago. + +Click the `Show Timeline` button in the top-left corner of the main view to open or close Pieces Timeline. + + + +> 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 + +## Understanding Activity Items + +Each item in Timeline Events contains information about a specific captured activity or conversation from your workflow. + +Each memory item displays: + +* **Title/Description:** A concise summary of the activity (e.g., "Desktop App Documentation Updates", "SDK, Docs, & Work Ledger"). +* **Timestamp:** When the activity occurred (e.g., "10 minutes ago - 2:24pm", "Half an hour ago - 2:04pm"). +* **Date Group:** Memories are grouped by date (Today, Yesterday, Last Saturday, Last Sunday, etc.). +* **Emoji/Icon Indicators:** Visual indicators showing the type of activity or associated apps (e.g., 😊 for conversations, 💻 for code, 📄 for documents). +* **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. + + + +> Showing current day dropdown in Timeline + +## Navigating Timeline Events + +The Timeline Events sidebar provides multiple ways to find and access specific workflow moments. + +### Browsing by Date + +Browse activities organized by date groups for easy navigation. + +The sidebar automatically groups activities by date, with the most recent items at the top. Date groups include Today, Yesterday, and then specific dates for older activities (e.g., "Last Saturday, Jan 3rd"). Each day section can be expanded or collapsed to show or hide its contents. Scroll down through the sidebar to browse older activities—LTM-2.7 retains your workflow context for up to 9 months. + +#### Expanding and Collapsing Day Sections + +Each day section in Timeline Events can be expanded to view its contents or collapsed to hide them: + + + + Click the `Show Timeline` button in the top-left corner of the main view to open Pieces Timeline if it's not already open. + + + Click on a day section (e.g., "Today, Jan 21st") to expand it and view all activities, summaries, and events for that day. + + + When expanded, you can see all items for that day, including timeline activities, summaries (queued, processing, or completed), and conversational searches. + + + Click the `caret icon` (dropdown arrow) at the top of the day divider to collapse the section and hide its contents. + + + Click any activity item within an expanded day section to view its full roll-up in the main panel. + + + +### Searching & Filtering + +Search and filter activities to find specific workflow moments quickly. + +#### Searching Activities + +Use the search bar to find activities by keyword or topic: + + + + Click in the search field at the top of Pieces Timeline. + + + Type keywords, project names, or topics you're looking for. The search uses neural search, meaning it understands context and can find relevant activities even if your search terms don't match exactly. + + + View filtered results that update in real-time as you type. + + + Click the `Filter List` button (icon with three horizontal lines) to access additional filtering options. + + + + + +> 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 + +## Viewing Activity Details + +View full roll-up details for any activity item in the sidebar. + +#### Viewing a Roll-Up + +Click an activity to view its complete roll-up details: + + + + Click any activity item in Pieces Timeline. + + + The full LTM Roll-Up displays in the main panel with detailed information including core tasks, key decisions, documents reviewed, and follow-up actions. + + + You can start a Conversational Chat conversation with that context, export it, edit it, or share it. + + + Use the `Jump to Summary In List` button (target icon) in the roll-up header to scroll back to the activity's position in Pieces Timeline if you've navigated away. + + + + + +> 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 + +## Activity Retention + +Understand how long your workflow activities are retained. + +LTM-2.7 retains your captured workflow context for up to 9 months. This gives you access to a substantial history of your work, allowing you to reference past projects, conversations, and decisions long after they occurred. Activities older than 9 months are automatically removed to ensure optimal performance. + +## Tips for Using Timeline Events + +Best practices for navigating and using Timeline Events effectively. + +Following these tips helps you find and access workflow activities more efficiently. + +* Use the search function when you remember specific keywords but not the exact date of an activity +* Date groups make it easy to find activities from "that meeting yesterday" or "the work I did last week" +* The emoji and app icons help you quickly scan the list visually—look for specific patterns that match what you're searching for +* If you're looking at a roll-up and want to see where it is in your chronological history, use the `Jump to Summary In List` button +* Keep the Timeline Events sidebar open while working to quickly reference past context without losing your place + +*** + +## Next Steps + +Now that you know how to browse and search Timeline Events, learn how to generate instant summaries from your workflow. + +[Single-Click Summaries →](/products/desktop/single-click-summaries) diff --git a/public/content/desktop/timeline/your-memories.md b/public/content/desktop/timeline/your-memories.md new file mode 100644 index 0000000..de4e2d4 --- /dev/null +++ b/public/content/desktop/timeline/your-memories.md @@ -0,0 +1,146 @@ +--- +title: Timeline Activities +path: /desktop/timeline/timeline-activities +visibility: PUBLIC +status: PUBLISHED +description: Browse and search your chronological list of captured activities and conversations in the Timeline Activities sidebar. +metaTitle: Timeline Activities | Timeline +metaDescription: Browse and search your chronological list of captured activities and conversations in the Timeline Activities sidebar. +--- + +## Timeline Activities + +Browse and search your chronological list of captured activities and conversations in the sidebar. + +Timeline Activities is the chronological sidebar that displays all activities and conversations captured by the [Long-Term Memory (LTM-2.7)](/products/core-dependencies/pieces-os#ltm-27) Engine. Located on the left side of Timeline, it serves as your navigation hub for accessing any past workflow context. The sidebar organizes your activities by date, making it easy to find specific items whether they happened today or months ago. + +Click the `Show Timeline` button in the top-left corner of the main view to open or close Pieces Timeline. + + + +> 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 + +## Understanding Activity Items + +Each item in Timeline Activities contains information about a specific captured activity or conversation from your workflow. + +Each memory item displays: + +* **Title/Description:** A concise summary of the activity (e.g., "Desktop App Documentation Updates", "SDK, Docs, & Work Ledger"). +* **Timestamp:** When the activity occurred (e.g., "10 minutes ago - 2:24pm", "Half an hour ago - 2:04pm"). +* **Date Group:** Memories are grouped by date (Today, Yesterday, Last Saturday, Last Sunday, etc.). +* **Emoji/Icon Indicators:** Visual indicators showing the type of activity or associated apps (e.g., 😊 for conversations, 💻 for code, 📄 for documents). +* **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. + + + +> Close-up screenshot of 2-3 individual memory items showing all the components clearly labeled: title, timestamp, emoji indicator, app icons, and count badge + +## Navigating Timeline Activities + +The Timeline Activities sidebar provides multiple ways to find and access specific workflow moments. + +### Browsing by Date + +Browse activities organized by date groups for easy navigation. + +The sidebar automatically groups activities by date, with the most recent items at the top. Date groups include Today, Yesterday, and then specific dates for older activities (e.g., "Last Saturday, Jan 3rd"). Scroll down through the sidebar to browse older activities—LTM-2.7 retains your workflow context for up to 9 months. + +#### Browsing Activities + +Navigate through date groups to find activities from specific time periods. + + + + Click the `Show Timeline` button in the top-left corner of the main view to open Pieces Timeline if it's not already open. + + + Scroll down through Pieces Timeline to browse activities grouped by date. + + + Click any activity item to view its full roll-up in the main panel. + + + +### Searching & Filtering + +Search and filter activities to find specific workflow moments quickly. + +At the top of the Timeline Activities sidebar, you'll find a search and filter bar. Use the search field to find activities by keyword—search for project names, topics, document titles, or any text you remember from the activity. The filter functionality uses neural search, meaning it understands context and can find relevant activities even if your search terms don't match exactly. + +Results update in real-time as you type, filtering the sidebar to show only matching activities. Click the `Filter List` button (icon with three horizontal lines) to access additional filtering options. + +#### Searching Activities + +Use the search bar to find activities by keyword or topic. + + + + Click in the search field at the top of Pieces Timeline. + + + Type keywords, project names, or topics you're looking for. The search uses neural search, meaning it understands context and can find relevant activities even if your search terms don't match exactly. + + + View filtered results that update in real-time as you type. + + + + + +> 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 + +## Viewing Activity Details + +View full roll-up details for any activity item in the sidebar. + +When you click on any activity item in the sidebar, the full LTM Roll-Up for that activity displays in the main panel. The roll-up provides detailed information including core tasks, key decisions, documents reviewed, and follow-up actions. You can interact with the roll-up in multiple ways: start a Conversational Chat conversation with that context, export it, edit it, or share it. + +Use the `Jump to Summary In List` button (target icon) in the roll-up header to scroll Pieces Timeline back to that activity's position if you've navigated away. + +#### Viewing a Roll-Up + +Click an activity to view its complete roll-up details. + + + + Click any activity item in Pieces Timeline. + + + The full LTM Roll-Up displays in the main panel with all details. + + + Use the `Jump to Summary In List` button to scroll Pieces Timeline back to the activity's position. + + + + + +> 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 + +## Activity Retention + +Understand how long your workflow activities are retained. + +LTM-2.7 retains your captured workflow context for up to 9 months. This gives you access to a substantial history of your work, allowing you to reference past projects, conversations, and decisions long after they occurred. Activities older than 9 months are automatically removed to ensure optimal performance. + +## Tips for Using Timeline Activities + +Best practices for navigating and using Timeline Activities effectively. + +Following these tips helps you find and access workflow activities more efficiently. + +* Use the search function when you remember specific keywords but not the exact date of an activity +* Date groups make it easy to find activities from "that meeting yesterday" or "the work I did last week" +* The emoji and app icons help you quickly scan the list visually—look for specific patterns that match what you're searching for +* If you're looking at a roll-up and want to see where it is in your chronological history, use the `Jump to Summary In List` icon +* Keep the Timeline Activities sidebar open while working to quickly reference past context without losing your place + +*** + +## Next Steps + +Now that you know how to browse and search Timeline Activities, learn how to generate instant summaries from your workflow. + +[Single-Click Summaries →](/products/desktop/single-click-summaries) diff --git a/public/content/desktop/troubleshooting.md b/public/content/desktop/troubleshooting.md index 8b677ab..a5e2574 100644 --- a/public/content/desktop/troubleshooting.md +++ b/public/content/desktop/troubleshooting.md @@ -12,11 +12,23 @@ metaDescription: If the Pieces Desktop App isn't working as expected, start here Click one of the links below to get started troubleshooting on your device—or [browse the cross-platform troubleshooting documentation](/products/desktop/troubleshooting/cross-platform) for more general fixes. -*** - -| [Cross-Platform](/products/desktop/troubleshooting/cross-platform) | [macOS](/products/desktop/troubleshooting/macos) | -| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | -| [Windows](/products/desktop/troubleshooting/windows) | [Linux](/products/desktop/troubleshooting/linux) | + + + Troubleshooting guides for all platforms + + + + macOS-specific troubleshooting guides + + + + Windows-specific troubleshooting guides + + + + Linux-specific troubleshooting guides + + *** diff --git a/public/content/desktop/troubleshooting/linux.md b/public/content/desktop/troubleshooting/linux.md index b11f382..cd1e98c 100644 --- a/public/content/desktop/troubleshooting/linux.md +++ b/public/content/desktop/troubleshooting/linux.md @@ -123,4 +123,4 @@ If you encounter persistent installation issues, consult online forums or commun If you've updated components, checked the hardware, and adjusted configurations without success, try restarting your machine and then try again. -If the problem persists, please open a **GitHub issue** for further assistance or book a call with our engineers. \ No newline at end of file +If the problem persists, please open a **GitHub issue** for further assistance or book a call with our engineers. \ No newline at end of file diff --git a/public/content/desktop/troubleshooting/macos.md b/public/content/desktop/troubleshooting/macos.md index b2d80c6..400c7a2 100644 --- a/public/content/desktop/troubleshooting/macos.md +++ b/public/content/desktop/troubleshooting/macos.md @@ -53,11 +53,11 @@ If you're having trouble installing PiecesOS or the Pieces Desktop App, you can Many issues can stem from out-of-date plugins, extensions, PiecesOS, or the desktop app itself. - + ### Updating the Pieces Desktop App -Update the Pieces Desktop App on macOS by clicking the `User Icon` next to the **search bar** at the top of the Pieces Desktop Window. Then, click `Check for Desktop App Updates` or `Check for PiecesOS Updates`. +Update the Pieces Desktop App on macOS by clicking your `User Profile` in the top left, then hovering over `Update` and selecting `Desktop App` or `PiecesOS`. To check the Pieces Desktop App for updates on macOS: @@ -66,16 +66,19 @@ To check the Pieces Desktop App for updates on macOS: Use the **Search** option or locate the Pieces Desktop App within your *Applications* folder - - Click the `User Icon` to the right of the **Search Bar** at the top of the main app view + + Click your `User Profile` in the top left of the main app view - - Click the `Check for Desktop App Updates` option + + Hover over `Update` in the dropdown menu that appears + + + + Click on either `Desktop App` or `PiecesOS` from the Update submenu to check for and install updates for that component - You can also click `Check for PiecesOS Updates` as an alternative to doing so in from the PiecesOS system window in your taskbar. @@ -131,4 +134,4 @@ To determine what CPU architecture your Apple device utilizes: If the installation fails because your macOS version is outdated or you installed the wrong package for your device's architecture, restart your machine and try the installation again from the beginning. -If the problem persists, please open a GitHub issue for further assistance, or book a call with our engineers. \ No newline at end of file +If the problem persists, please open a GitHub issue for further assistance, or book a call with our engineers. \ No newline at end of file diff --git a/public/content/desktop/troubleshooting/windows.md b/public/content/desktop/troubleshooting/windows.md index dcacc69..141cd0f 100644 --- a/public/content/desktop/troubleshooting/windows.md +++ b/public/content/desktop/troubleshooting/windows.md @@ -58,12 +58,16 @@ Updating the Pieces Desktop App on Windows (and macOS) can be done directly with Press the `Windows Icon` and search for Pieces Desktop, open it - - Click the `User Icon` to the right of the **Search Bar** at the top of the main app view + + Click your `User Profile` in the top left of the main app view - - Select `Check for Desktop App Updates` + + Hover over `Update` in the dropdown menu that appears + + + + Click on either `Desktop App` or `PiecesOS` from the Update submenu to check for and install updates for that component @@ -193,4 +197,4 @@ After trying any of the fixes above, it’s recommended that you restart your de This ensures all caches are clean and the computer is refreshed. -If the problem persists, please open a **GitHub issue** for further assistance or book a call with our engineers. \ No newline at end of file +If the problem persists, please open a **GitHub issue** for further assistance or book a call with our engineers. \ No newline at end of file diff --git a/public/content/extensions-plugins/visual-studio-code/copilot/llm-settings.md b/public/content/extensions-plugins/visual-studio-code/copilot/llm-settings.md index 8526672..bea7165 100644 --- a/public/content/extensions-plugins/visual-studio-code/copilot/llm-settings.md +++ b/public/content/extensions-plugins/visual-studio-code/copilot/llm-settings.md @@ -38,10 +38,10 @@ How to change your LLM: -From here, you can browse and select from a variety of available models, such as the local and cloud-based models listed [in the tables on this page.](/products/core-dependencies/ollama/supported-models) +From here, you can browse and select from a variety of available models, such as the local and cloud-based models listed [on the supported models page.](/products/core-dependencies/local-models/supported-models) - Cloud-hosted models offer access to the latest AI capabilities, while on-device models ensure offline functionality, making Pieces Copilot adaptable to your specific workflow and environment. + Cloud-hosted models offer access to the latest AI capabilities, while local models run entirely on your device through PiecesOS, ensuring complete privacy and offline functionality. Once you’ve chosen a new model, the switch is instant, allowing you to continue your work seamlessly with the selected model's capabilities—*no need to restart or refresh anything.* diff --git a/public/content/extensions-plugins/visual-studio/copilot/llm-settings.md b/public/content/extensions-plugins/visual-studio/copilot/llm-settings.md index 6018344..67fcfb4 100644 --- a/public/content/extensions-plugins/visual-studio/copilot/llm-settings.md +++ b/public/content/extensions-plugins/visual-studio/copilot/llm-settings.md @@ -38,10 +38,14 @@ How to change your LLM: -You can also use Ollama as your LLM runtime, which you can [read more about here](/products/core-dependencies/ollama). +You can use local models for on-device AI inference, which you can [read more about here](/products/core-dependencies/local-models). From here, you can browse and select from various available models, such as the local and cloud-based models listed [in the table at the top of this page.](/products/extensions-plugins/visual-studio/configuration#supported-llms) + + Local models run entirely on your device through PiecesOS, ensuring complete privacy and offline functionality without any external dependencies. + + Once you’ve chosen a new model, the switch is instant, allowing you to continue your work seamlessly with the selected model's capabilities—*no need to restart or refresh anything.* diff --git a/public/content/large-language-models.md b/public/content/large-language-models.md index 50d0ef3..e08f571 100644 --- a/public/content/large-language-models.md +++ b/public/content/large-language-models.md @@ -17,7 +17,7 @@ ogImage: "https://storage.googleapis.com/hashnode_product_documentation_assets/o ## Compatible AI Models with Pieces -Pieces utilizes cloud-hosted LLMs from providers like OpenAI, Anthropic, and Google. All local models are served through [Ollama, a core dependency of PiecesOS](/products/core-dependencies/ollama) and the rest of the Pieces Suite. +Pieces utilizes cloud-hosted LLMs from providers like OpenAI, Anthropic, and Google. Local models can optionally be downloaded and served through PiecesOS and the rest of the Pieces Suite. ## Cloud-Only LLMs | Providers @@ -51,10 +51,12 @@ Read [through the list of local AI models available for use](/products/large-lan *** -### Using Ollama with Pieces +### Using Local Models with Pieces -Ollama is *required* to utilize local generative AI features. +Local models can be optionally downloaded to utilize on-device generative AI features. -It’s a lightweight system that allows for a plug-and-play experience with local models, meaning that Pieces can update the number of compatible models we serve at lightning-speeds! +PiecesOS provides a seamless experience with local models, allowing you to work entirely offline with complete privacy. -If you want to read more about installing and using Ollama with Pieces, [click here for the Ollama section of our Core Dependencies documentation.](/products/core-dependencies/ollama) \ No newline at end of file +Local models are automatically available once PiecesOS is installed. Download and manage them through the Pieces Copilot LLM selector in any Pieces product. + +[Learn more about PiecesOS and local model architecture →](/products/core-dependencies/pieces-os#built-in-local-models) \ No newline at end of file diff --git a/public/content/mcp/claude-desktop.md b/public/content/mcp/claude-desktop.md index d8e3b1c..9188a21 100644 --- a/public/content/mcp/claude-desktop.md +++ b/public/content/mcp/claude-desktop.md @@ -1,11 +1,11 @@ --- -title: Pieces MCP + Claude Desktop Integration +title: Pieces MCP + Claude Integration path: /mcp/claude-desktop visibility: PUBLIC status: PUBLISHED -description: The Pieces MCP integration with Claude Desktop lets you use Pieces Long-Term Memories captured by PiecesOS without any third-party applications. -metaTitle: Integrate Pieces Model Context Protocol (MCP) with Claude Desktop -metaDescription: Discover 2 different ways to configure the Pieces MCP to provide your workflow context to Claude Desktop, allowing you to work smarter. +description: The Pieces MCP integration with Claude Desktop and Claude Code lets you use Pieces Long-Term Memories captured by PiecesOS without any third-party applications. +metaTitle: Integrate Pieces Model Context Protocol (MCP) with Claude Desktop & Claude Code +metaDescription: Discover different ways to configure the Pieces MCP to provide your workflow context to Claude Desktop and Claude Code, allowing you to work smarter. ogImage: "https://storage.googleapis.com/hashnode_product_documentation_assets/og_images/MCP/claude_desktop_mcp.jpg" --- @@ -15,13 +15,13 @@ ogImage: "https://storage.googleapis.com/hashnode_product_documentation_assets/o ## Get Started -Integrating the [Pieces MCP](/products/mcp/get-started) with Claude Desktop is a powerful way to bring your workflow context directly into your AI assistant. +Integrating the [Pieces MCP](/products/mcp/get-started) with Claude Desktop or Claude Code is a powerful way to bring your workflow context directly into your AI assistant. -With this integration, you'll have an in-Desktop Claude agent that knows more about your projects than just the files you copy and paste. +With this integration, you'll have a Claude agent that knows more about your projects than just the files you copy and paste. -You can ask questions about prior work, like *“What decision did I make in last week’s sprint review?”* and instantly reuse that context without searching through notes or commits. +You can ask questions about prior work, like *"What decision did I make in last week's sprint review?"* and instantly reuse that context without searching through notes or commits. -Learn how to integrate the Pieces MCP into Claude Desktop by following the steps below. +Learn how to integrate the Pieces MCP into Claude Desktop or Claude Code by following the steps below. It is imperative that you download and/or update Claude Desktop to the latest, most up-to-date version to ensure compatibility with Pieces MCP. @@ -29,7 +29,7 @@ Learn how to integrate the Pieces MCP into Claude Desktop by following the steps ## Prerequisites -There are **two** main things you need to do to connect Pieces with Claude Desktop as an MCP: have an active instance of PiecesOS running and and turn on the Long-Term Memory engine. +There are **two** main things you need to do to connect Pieces with Claude as an MCP: @@ -49,9 +49,9 @@ Follow the instructions below for a detailed guide on setting up and configuring -## Setting Up Claude Desktop +## Setting up Pieces MCP for Claude Desktop -There are **two methods** to set up the Pieces MCP for Claude Desktop—either configuring the server connection manually with a direct command, or using the [Pieces CLI ](/products/cli)to configure it automatically. +There are **two methods** to set up the Pieces MCP for Claude Desktop. Configure the server connection manually, or use the [Pieces CLI](/products/cli) to configure Claude Desktop automatically: ### Method 1: Manual Configuration (Direct MCP Command) @@ -132,7 +132,7 @@ This method involves editing Claude Desktop’s MCP configuration file to point - Start prompting Claude—if properly set up, you will be prompted by Claude to enable and allow (on a case-by-case basis, or via `always allow`) Claude to pass prompts through the `ask_pieces_ltm` tool. + Start prompting Claude. If properly set up, you will be prompted by Claude to enable and allow (on a case-by-case basis, or via `always allow`) Claude to pass prompts through the `ask_pieces_ltm` tool. This utility communicates with PiecesOS and your local repository of saved workflow context. @@ -177,15 +177,46 @@ This method uses the Pieces CLI to automatically set up and configure Pieces MCP -## Using Pieces MCP Server in Claude Desktop +## Adding Pieces MCP to Claude Code -Once integrated, you can utilize Pieces LTM directly in Claude Desktop. +Configure Pieces MCP for Claude Code to make it available across all your projects. -1. **Open a Claude Chat**\ - Launch a new conversation in Claude Desktop. + + This section is specifically for Claude Code and does not work with Claude Desktop. For Claude Desktop, use the methods above. + + + + + In your terminal, run the following command: + + ```bash + claude mcp add --scope user PiecesMCP --transport sse http://localhost:39300/model_context_protocol/2025-03-26/mcp + ``` + + The `--scope user` flag makes Pieces MCP available globally across all your Claude Code projects, rather than just the current directory. + + + + Open any project in Claude Code and start asking context-aware questions about your workflow, such as: + + * *"What patterns did I use in my last React component?"* + * *"Show me the authentication flow I implemented yesterday."* + + + + + Claude Code will use the `ask_pieces_ltm` tool to pull relevant context from PiecesOS. + + +## Using Pieces MCP Server + +Once integrated, you can utilize Pieces LTM directly in Claude Desktop or Claude Code. + +1. **Start a Conversation**\ + Launch a new conversation in Claude Desktop or open a project in Claude Code. 2. **Prompt with Context**\ - Ask Claude questions about prior work or files (e.g., *“What was I doing for work yesterday?”*). + Ask Claude questions about prior work or files (e.g., *"What was I doing for work yesterday?"*). @@ -196,7 +227,7 @@ Once integrated, you can utilize Pieces LTM directly in Claude Desktop. ## Troubleshooting -If you’re experiencing issues integrating [Pieces MCP](/products/mcp/get-started) with Claude Desktop: +If you're experiencing issues integrating [Pieces MCP](/products/mcp/get-started) with Claude Desktop or Claude Code: 1. **Verify PiecesOS Status**\ Ensure PiecesOS is actively running on your system. diff --git a/public/content/mcp/cursor.md b/public/content/mcp/cursor.md index fea6576..a77ac6c 100644 --- a/public/content/mcp/cursor.md +++ b/public/content/mcp/cursor.md @@ -49,23 +49,23 @@ Follow the instructions below for a detailed guide on setting up and configuring -### Getting the SSE Endpoint for PiecesOS +### Getting the MCP Endpoint for PiecesOS -To use Pieces MCP with Cursor, you'll first need the Server-Sent Events (SSE) endpoint from PiecesOS: +To use Pieces MCP with Cursor, you'll need the MCP endpoint from PiecesOS: ```markdown -http://localhost:39300/model_context_protocol/2024-11-05/sse +http://localhost:39300/model_context_protocol/2025-03-26/mcp ``` Keep in mind that the **specific port** (i.e., `39300`) PiecesOS is running on **may vary**. -To find the current SSE endpoint with the active instance of POS (including the current port number), open the PiecesOS Quick Menu and expand the **Model Context Protocol (MCP) Servers** tab. +To find the current MCP endpoint with the active instance of PiecesOS (including the current port number), open the PiecesOS Quick Menu and expand the **Model Context Protocol (MCP) Servers** tab. -There, you can click once to copy the SSE endpoint, which includes the active PiecesOS port number. +There, you can click once to copy the MCP endpoint, which includes the active PiecesOS port number. - + You can also do this in the Pieces Desktop App by opening the **Settings** view and clicking **Model Context Protocol (MCP).** @@ -95,7 +95,7 @@ To set up the Pieces MCP, you can edit the `.json` settings configuration file f { "mcpServers": { "Pieces": { - "url": "http://localhost:39300/model_context_protocol/2024-11-05/sse" + "url": "http://localhost:39300/model_context_protocol/2025-03-26/mcp" } } } @@ -157,7 +157,7 @@ If you’re experiencing issues integrating Pieces MCP with Cursor, follow these 2. **Confirm LTM Engine Activation**: Make sure the [Long-Term Memory Engine (LTM-2.7) is enabled in PiecesOS](/products/core-dependencies/pieces-os/quick-menu#ltm-2-engine), as this engine aggregates context necessary for Cursor to retrieve accurate results. -3. **Single MCP Instance:** Make sure that you aren’t testing multiple instances of the Pieces MCP server in different IDEs. This cross-contamination conflict with the SSE and several MCP instances running on the same port can cause issues in different development environments. +3. **Single MCP Instance:** Make sure that you aren't testing multiple instances of the Pieces MCP server in different IDEs. This cross-contamination conflict with several MCP instances running on the same port can cause issues in different development environments. 4. **Use Agent Mode in Chat**: Cursor must be in *Agent Mode*, not *Ask Mode*, to access the `ask_pieces_ltm` tool. Switch to Agent Mode to enable full MCP integration. @@ -167,24 +167,15 @@ If you’re experiencing issues integrating Pieces MCP with Cursor, follow these 7. **Go to** `settings.json` **in Cursor:** Confirm the MCP server status shows "running" (it may say "start" or "pause" otherwise). Restart the server if necessary and inspect terminal outputs for error messages. -8. **Review Configuration Details**: Double-check the MCP endpoint URL and the port number in Cursor settings to ensure accuracy, You can find the current SSE endpoint URL in the Pieces Desktop App under **Settings** → **Model Context Protocol (MCP)**, or in the PiecesOS Quick Menu. It is usually formatted as: +8. **Review Configuration Details**: Double-check the MCP endpoint URL and the port number in Cursor settings to ensure accuracy. You can find the current MCP endpoint URL in the Pieces Desktop App under **Settings** → **Model Context Protocol (MCP)**, or in the PiecesOS Quick Menu. It is usually formatted as: ```scss -http://localhost:{port_number}/model_context_protocol/{version}/sse +http://localhost:{port_number}/model_context_protocol/2025-03-26/mcp ``` -### JSON Blob Error in MCP Settings - -When you open **Preferences → Settings → MCP**, you may see a raw `.JSON` payload or *“unknown message ID”* error displayed beneath your enabled Pieces server—even though your tool calls work correctly. - -Cursor’s *Settings* UI currently doesn’t recognize the JSON-RPC success envelope, so it misclassifies the response as an error object and dumps the payload. - - - -This visual artifact is harmless. All genuine LTM responses still arrive properly in the Cursor chat window. - Ignore any red `.JSON` blobs in the MCP Settings view. The **Chat** pane is the source of truth—if your pieces queries return formatted summaries there, the integration is functioning normally. + Ignore any red `.JSON` blobs in the MCP Settings view. The **Chat** pane is the source of truth—if your Pieces queries return formatted summaries there, the integration is functioning normally. *** diff --git a/public/content/mcp/get-started.md b/public/content/mcp/get-started.md index 744933d..6481dbc 100644 --- a/public/content/mcp/get-started.md +++ b/public/content/mcp/get-started.md @@ -147,6 +147,8 @@ Explore how quickly MCP enhances your productivity by delivering deep, personali To begin using Pieces MCP, [install and launch PiecesOS](/products/core-dependencies/pieces-os/manual-installation) on your system, then follow our integration documentation for setting up the MCP server within your favorite IDE: +* [Pieces MCP + Claude Desktop & Claude Code Integration Guide](/products/mcp/claude-desktop) + * [Pieces MCP + Cursor Integration Guide](/products/mcp/cursor) * [Pieces MCP + GitHub Copilot Integration Guide](/products/mcp/github-copilot) diff --git a/public/content/mcp/github-copilot.md b/public/content/mcp/github-copilot.md index fe1dc64..e0f7113 100644 --- a/public/content/mcp/github-copilot.md +++ b/public/content/mcp/github-copilot.md @@ -61,7 +61,7 @@ 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. - + You can also do this in the Pieces Desktop App by opening the **Settings** view and clicking **Model Context Protocol (MCP).** diff --git a/public/content/mcp/goose.md b/public/content/mcp/goose.md index 114d227..706a0b3 100644 --- a/public/content/mcp/goose.md +++ b/public/content/mcp/goose.md @@ -63,7 +63,7 @@ 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. - + You can also find this in the Pieces Desktop App by opening the [Settings](/products/desktop/configuration) view and clicking **Model Context Protocol (MCP)**. diff --git a/public/content/meet-pieces.md b/public/content/meet-pieces.md index dfa2030..06f7853 100644 --- a/public/content/meet-pieces.md +++ b/public/content/meet-pieces.md @@ -3,7 +3,7 @@ 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 and integrations with many popular IDEs. +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. 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" @@ -21,15 +21,15 @@ Let’s answer a few basic questions: ### What is Pieces? -At its core, Pieces is an all-in-one productivity tool that helps developers work *smarter*, not harder, by anchoring engineers to their workflow with the power of the **Long-Term Memory Engine, Pieces Drive,** and the **Pieces Copilot.** +At its core, Pieces is an all-in-one productivity tool that helps you work *smarter*, not harder, by keeping track of your activities, important information, and conversations—all in one place, with features like Long-Term Memory, Timeline, and Conversational Chat. There are **\[3]** core pillars of Pieces functionality: 1. [Long-Term Memory Engine (LTM-2.7)](/products/meet-pieces/fundamentals#ltm-27): A powerful, AI-powered live context framework that understands what you’re working on across your entire development workflow. The LTM-2.7 helps by outsourcing the burden of memory and retrieval from the developer to AI to maximize space for creativity driven by human intent. -2. [Pieces Drive](/products/meet-pieces/fundamentals#pieces-drive): The ability to save, search, reference, reuse, and share small developer resources like code snippets, screenshots, links, and text notes. +2. [Pieces Timeline](/products/desktop/timeline): Your central workspace for accessing workflow context captured by Long-Term Memory. Generate summaries, review past activities, browse captured memories, and interact with your workflow history—all in one place. -3. [Pieces Copilot](/products/meet-pieces/fundamentals#pieces-copilot): An intelligent assistant that helps with generating code, answering questions, and adding code comments while utilizing a LLM of your choice—featuring an adjustable context window ranging from conversation-only to entire project repositories. +3. [Conversational Search](/products/meet-pieces/fundamentals#pieces-copilot): An intelligent assistant that helps with answering questions, generating content, and providing guidance while utilizing a LLM of your choice—with an adjustable context window ranging from conversation-only to entire project folders. ### Who is Pieces For? @@ -184,27 +184,27 @@ By installing PiecesOS, you enable the full functionality of the desktop app and Select the applications and integrations that fit your workflow: - - **Your central hub** — Manage memories, chat with Copilot, and access all Pieces features + + **Your central hub** — Manage memories, chat with Pieces Copilot, and access all Pieces features - - **Deep integration** — [VS Code](https://docs.pieces.app/products/extensions-plugins/visual-studio-code), [JetBrains](https://docs.pieces.app/products/extensions-plugins/jetbrains), [Sublime Text](https://docs.pieces.app/products/extensions-plugins/sublime), [Visual Studio](https://docs.pieces.app/products/extensions-plugins/visual-studio), and more + + **Command-line power** — Access Pieces from your terminal - - **Capture from the web** — Save content, research, and context from any website + + **Connect AI tools** — [Cursor](/products/mcp/cursor), [GitHub Copilot](/products/mcp/github-copilot), [Goose](/products/mcp/goose), and [Claude Desktop](/products/mcp/claude-desktop) - - **Command-line power** — Access Pieces from your terminal + + **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. - - **Enhanced workflow** — [Raycast](https://docs.pieces.app/products/raycast), [Obsidian](https://docs.pieces.app/products/obsidian), and more productivity integrations + + **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 954814f..d1d8ba6 100644 --- a/public/content/meet-pieces/fundamentals.md +++ b/public/content/meet-pieces/fundamentals.md @@ -11,96 +11,80 @@ ogImage: "https://storage.googleapis.com/hashnode_product_documentation_assets/o ## The Pillars -Pieces powers developers to new levels of productivity by introducing the **\[1] Long-Term Memory Engine (LTM-2.7)**, a powerful “artificial memory” that remembers your workflow and automatically saves context for future use. +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. -Next, Pieces offers the **\[2] Pieces Copilot**, assisting with day-to-day tasks like debugging code, generating comments, and answering questions—with as much or as little workflow context as you need. +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. -Finally, Pieces provides the **\[3] Pieces Drive**, an intelligent and enriched material management experience that ensures your most important code—and other useful materials—are always at hand. +Finally, **\[3] Timeline** is your main workspace for everything Long-Term Memory captures. You can create summaries, look back at past work, and explore your workflow history. ## LTM-2.7 -The Long-Term Memory Engine (LTM-2.7) captures live context from your workflow over a 7-day period, enhancing your ability to recall and access past materials. +The Long-Term Memory Engine (LTM-2.7) captures what you're working on, so you can easily find past activities, conversations, and materials. *** -*Pieces Copilot with LTM-2.7 Context* +*Conversational Search with LTM-2.7 Context* *** -You can ask questions like, “*Can you provide me with the link to the Firestore database I was working in last week?”* or “*Summarize the contents of the brief on plugin updates in the Google doc Tim shared”* for game-changing productivity enhancement. +You can ask questions like, "*What was the link to that document I worked on last week?"* or "*Summarize the brief from the meeting"* to get quick answers with game-changing context enhancements. Here are some ways to take advantage of the LTM-2.7: -* `Contextual Recall`: LTM-2.7 remembers the websites you visit, the code you work on, and the snippets you save. This context can be accessed via the Pieces Desktop App or within Copilot Chats inside your favorite IDE—with the relevant Pieces extension or plugin installed. +* `Contextual Recall`: LTM-2.7 remembers the websites you visit, the work you do, and what you save. You can access this from the Pieces Desktop App or in Conversational Search inside of your IDE—just install the Pieces extension or plugin. -* `Natural Language Queries`: Ask contextual questions about your previous workflow, and LTM-2.7 will source the relevant anchor and provide you with a clickable URL or path to a file on your device—or try asking it to summarize the contents of a webpage you visited earlier in the day. +* `Natural Language Queries`: Ask questions about your past work, and LTM-2.7 will find the right link or file path for you. You can also ask it to summarize a webpage you visited earlier. -* `Integrated Access`: Utilize LTM-2.7 through the Pieces Desktop App or within your favorite development tools via browser or IDE integrations. +* `Integrated Access`: Use LTM-2.7 in the Pieces Desktop App or in your favorite tools through browser or IDE integrations. -### Workstream Activity - -Pieces has just launched a new flagship feature called [Workstream Activity](/products/desktop/workstream-activity). - -The Workstream Activity view in the [Pieces Desktop App](/products/desktop) uses the advanced Long-Term Memory (LTM-2.7) Engine to collect and summarize your recent tasks, discussions, code reviews, and more. - -*** - -*Workstream Activity in the Pieces Desktop App* - - *** -[PiecesOS](/products/core-dependencies/pieces-os) collects the LTM data and provides a concise roll-up of that data *every 20 minutes,* drastically reducing the repetitive context-setting typical of many AI tools. +[PiecesOS](/products/core-dependencies/pieces-os) collects LTM data and creates a summary *every 20 minutes,* so you don't have to keep explaining context like you do with other AI tools. -Each roll-up is a snapshot that includes details on main tasks, projects, issues resolved, key decisions, discussions, documents, and code you’ve reviewed—often with helpful links included! -You can also start Pieces Copilot chats with individual roll-ups, eliminating the need to manually enter context. +## Conversational Search -## Pieces Copilot - -Pieces Copilot leverages advanced Large Language Models (LLMs) to assist you in understanding and generating code, accessible through your IDEs, editors, and the Desktop App. +Conversational Search uses Large Language Models (LLMs) to help answer questions, create content, and give guidance. You can use it in your IDE, editor, or the Desktop App. *** -*Pieces Copilot for Code Generation* +*Conversational Search for Content Generation* *** -The Pieces Copilot, accessible via the Pieces Desktop App or any of our IDE or browser integrations, helps with: +Conversational Search, available in the Pieces Desktop App, any IDE, or browser integration, helps with: -* `Understanding Code`: Get explanations of complex code snippets, learn how a particular function works, or explore alternative implementations. +* `Answering Questions`: Get explanations of complex topics, learn how things work, or explore different approaches. -* `Code Generation`: Generate code or code comments based on specific requirements, either from raw prompting or in-environment contextual understanding. +* `Content Generation`: Create content based on what you need, either by asking directly or using context from your current work. -* `LLM Flexibility`: Switch between local models for privacy and speed, or cloud-hosted models for more advanced capabilities. +* `LLM Flexibility`: Switch between local models for privacy and speed, or cloud models for more advanced features. -## Pieces Drive +## Timeline -Saving and managing code and other materials is effortless and efficient with Pieces Drive. +Timeline is your central workspace in the Pieces Desktop App. It shows summaries of everything Long-Term Memory (LTM-2.7) captures. You can create summaries, look at past work, chat with Conversational Chat, and manage your memories. *** -*Viewing Saved Materials with Pieces Drive* +*Timeline Interface* *** -The Pieces Drive lets you save important developer resources, like notes, useful code, links, and more to your personal Local Repository—from which you can then view, edit, re-use, and share these materials via Pieces Shareable Links. - -Intended recipients are not required to have a Pieces account, so cross-platform collaboration is exceptionally easy. +Timeline has four main features that help you use your workflow context: -With Pieces, you’ll find Pieces Drive integrated into your favorite: +* `Single-Click Summaries`: Create quick summaries from your workflow with one click. Choose from preset types like Standup Updates, Day Recaps, and more. -* `IDEs and Editors`: Extensions for [VS Code](/products/extensions-plugins/visual-studio-code), [JetBrains IDEs](/products/extensions-plugins/jetbrains), [Sublime Text](/products/extensions-plugins/sublime), and more enable you to save snippets without leaving your coding environment. +* `Timeline Activities`: Browse a timeline of all your activities and conversations in the sidebar. Search, filter, and find any activity from your workflow history. -* `Web Browsers`: The Pieces Web Extension let you capture code from documentation sites, forums, or any web page using your favorite browsers. +* `Conversational Chat`: Ask questions about your workflow and get answers powered by LTM-2.7. The chat knows your memories and gives relevant answers. -* `Collaboration Tools`: Integrations with tools like [Obsidian](/products/obsidian) help you save code from notes and shared documents. \ No newline at end of file +Everything you need to understand and use your captured workflow context is in Timeline. [Learn more about Timeline](/products/desktop/timeline). \ No newline at end of file diff --git a/public/content/meet-pieces/linux-installation-guide.md b/public/content/meet-pieces/linux-installation-guide.md index b840c66..3a26c91 100644 --- a/public/content/meet-pieces/linux-installation-guide.md +++ b/public/content/meet-pieces/linux-installation-guide.md @@ -19,7 +19,7 @@ Follow the steps below to download and install Pieces for Linux using the Comman ### Requirements -There are several requirements that your Linux device must meet to download and install the Pieces Desktop App, PiecesOS, and *ensure LTM-2 compatibility.* +There are several requirements that your Linux device must meet to download and install the Pieces Desktop App, PiecesOS, and *ensure LTM-2.7 compatibility.* * **Snap Support:** Ensure `snapd` is installed and enabled on your system. Most recent Ubuntu releases include `snapd` by default. If needed, install `snapd` by following the official `snapd` documentation. @@ -65,7 +65,7 @@ Read the documentation below for tips and information to ensure you’re up and 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 clicking the profile icon nested in the search bar at the top of your Pieces Desktop App view, then selecting `Check for Desktop App Updates` or `Check for PiecesOS 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`. diff --git a/public/content/meet-pieces/macos-installation-guide.md b/public/content/meet-pieces/macos-installation-guide.md index b66324b..064ed00 100644 --- a/public/content/meet-pieces/macos-installation-guide.md +++ b/public/content/meet-pieces/macos-installation-guide.md @@ -148,7 +148,7 @@ Read the documentation below for some tips and information to make sure you’re 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 clicking the `Profile` icon nested in the **Search Bar** at the top of your Pieces Desktop App view, then selecting `Check for Desktop App Updates` or `Check for PiecesOS 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`. diff --git a/public/content/meet-pieces/sign-into-pieces.md b/public/content/meet-pieces/sign-into-pieces.md index d5548f3..96c570b 100644 --- a/public/content/meet-pieces/sign-into-pieces.md +++ b/public/content/meet-pieces/sign-into-pieces.md @@ -3,30 +3,22 @@ title: Getting Started with Sign-In path: /meet-pieces/sign-into-pieces visibility: PUBLIC status: PUBLISHED -description: Everything you need to know about signing in to Pieces, including step-by-step instructions for new and existing users, troubleshooting common issues, and understanding our new security requirements. +description: Everything you need to know about signing in to Pieces, including step-by-step instructions, troubleshooting common issues, and understanding our new security requirements. metaTitle: "Sign In to Pieces: Authentication Guide & Troubleshooting" metaDescription: Learn how to sign in to Pieces Desktop App. Step-by-step guide for new and existing users, platform instructions, and troubleshooting common sign-in issues. --- -# Sign-In to the Pieces Suite +## Signing In to Pieces - - - - **Important Security Update** - - Starting with version 12.0.0, all users must sign in to use Pieces. This change helps us prevent misuse and discourage bad actors from abusing our infrastructure. Previous versions will no longer work after this update. - - -## What's Changing +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. -You'll need to sign in to use Pieces - no more anonymous usage. This applies to everyone, whether you're new to Pieces or have been using it for years. + -## For New Users +> The Pieces sign-in screen -When you open Pieces for the first time, you'll see a sign-in screen right away. The option to skip sign-in has been removed. +## Sign-In Process -Here's what to do: +When you open Pieces, you'll see a sign-in screen. Both new and existing users follow the same sign-in flow. @@ -42,187 +34,88 @@ Here's what to do: - Once you're signed in, you'll continue with the setup process. + Once you're signed in, you'll continue with the setup process or return to your workspace. - - -## For Existing Users + -When you update and open Pieces, it will check if you're signed in during startup. +> The sign-in screen you'll see when opening Pieces -### What You'll See +### Accessing Sign-In -1. Pieces will start up normally +If the sign-in prompt doesn't appear automatically, you can access it from your system tray or menu bar: -2. You'll see a "Sign In to use Pieces" step + -3. If you're not signed in, you'll see a prompt to sign in - - - - - We're requiring sign-in to use Pieces as of the PiecesOS 12.0.0 release to enhance security and enable new features - - -## How to Sign In - -### On Mac - -If the sign in prompt doesn't appear automatically: +> If you're not signed in, you'll see a prompt to sign in + + - Click the **Pieces** icon in your menu bar (top of screen). + Click the Pieces icon in your menu bar (top of screen). - - + Click `Sign In` when the Pieces app opens. - + + + > Pieces menu bar dropdown showing Sign In option + + + + + + + + Click the Pieces icon in your system tray (near the clock). + + + Click `Sign In` when the Pieces app opens. + + + + + + + + Click the Pieces icon in your system tray. + + + Click `Sign In` when the Pieces app opens. - -Or open Pieces directly by typing this in Terminal: - -```bash -open "pieces-for-developers://open" -``` - -### On Windows - -If the sign in prompt doesn't appear automatically: - - - - Click the **Pieces** icon in your system tray (near the clock). - - - - Click `Sign In` when the Pieces app opens. - - - -Or open Pieces directly by typing this in PowerShell or Command Prompt: - -```powershell -start "pieces-for-developers://open" -``` - -### On Linux - -If the sign in prompt doesn't appear automatically: - - - - Click the Pieces icon in your system tray. - - - - Click `Sign In` when the Pieces app opens. - - - -Or open Pieces directly by typing this in your terminal: - -```bash -xdg-open "pieces-for-developers://open" -``` + + ### Staying Signed In -Once you sign in, you should stay signed in automatically. *However*, if you sign out from another device or location, you'll need to sign in again. This keeps your account secure across all your devices. - -## Troubleshooting - -*** - - - -*** - -### Stuck at Startup - -If Pieces gets stuck at "Sign In to use Pieces" during startup, simply click the `Sign In` button that appears and complete the process in your browser. - -This is intentional, as we now require every Pieces user to be logged in to use our platform. - -### Authentication Failed - -Getting an "authentication failed" error? Make sure you're using the same account you used before with Pieces. - -### Browser Doesn't Return +Once you sign in, you should stay signed in automatically. However, if you sign out from another device or location, you'll need to sign in again. This keeps your account secure across all your devices. -After signing in, your browser might not automatically switch back to Pieces. That's okay - just manually switch back to the Pieces app. It should recognize that you've signed in successfully. +## Requirements and Updates -If it hasn’t, restart your Pieces and follow the sign in steps again. - -### Repeatedly Signed Out - -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. - -*** - -## What's New with Sign-In - -We've upgraded our sign-in system to make it better for you: - -* **Combine accounts easily**: If you've signed in different ways before, you can now merge those accounts - -* **More sign-in options**: Choose from more providers than ever before - -* **Better security**: Enhanced protection against threats and abuse - - - Your existing account works exactly the same - just sign in like you normally would - - -## How This Affects Your Daily Work - -### Right Now - -* You must update to the latest version to keep using Pieces - -* You need to sign in before you can access your snippets and tools +To use the new sign-in features, you must update both PiecesOS and the Pieces Desktop app to version 15.0.0 or later. Older versions of Pieces Desktop and PiecesOS will be deprecated and will not work anymore. - Older versions of Pieces Desktop and PiecesOS will be depreciated and will not work anymore. You must update to version 12.0.0 to use the Pieces Suite. + You must update to version 15.0.0 or later to use the Pieces Suite. Both PiecesOS and the Desktop App must be updated for sign-in to work properly. -## Keeping Your Account Safe - -Here are simple ways to protect your Pieces account: - -1. Use a strong password if signing in with email. - -2. Turn on two-factor authentication with your sign-in provider. - -3. Sign out when using shared computers. - -4. Let us know immediately if you see anything suspicious. - -## Updating to the Latest Version - -To use the new sign-in features, you'll need to update both PiecesOS and the Pieces Desktop app. - ### Update PiecesOS PiecesOS runs in the background and powers all Pieces features. -To update: - Check your menu bar (Mac) or system tray (Windows/Linux) for the PiecesOS icon. - Right-click the icon and select `You’re up to date`—this will trigger an automatic check for updates. + Right-click the icon and select `You're up to date`—this will trigger an automatic check for updates. - If an update is available, click "Update Now". + If an update is available, click `Update Now`. @@ -256,36 +149,83 @@ After updating PiecesOS, update the desktop app: - - Both components must be updated to version 12.0.0 or later for sign-in to work properly. If you're having issues, make sure both PiecesOS and the Desktop App are fully updated. - +## Troubleshooting -*** +If you encounter issues while signing in, try these solutions: -## Need Help? +### Opening Pieces via Command Line -Having trouble signing in or have questions? We're here to help: +If the Pieces app doesn't open automatically, you can launch it directly from your terminal or command line: -## Live Support with Pieces + + + Open Terminal and run: -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. + ```bash + open "pieces-for-developers://open" + ``` + -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 PowerShell or Command Prompt and run: -## Open a GitHub Issue**​** + ```powershell + start "pieces-for-developers://open" + ``` + -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. + + Open your terminal and run: -If you would prefer not to use GitHub, you can still leave feedback or report a bug here. + ```bash + xdg-open "pieces-for-developers://open" + ``` + + -## Join our Discord Community +### Stuck at Startup + +If Pieces gets stuck at "Sign In to use Pieces" during startup, simply click the `Sign In` button that appears and complete the process in your browser. This is intentional, as we now require every Pieces user to be logged in to use our platform. -We have a strong community presence on our Discord channel, so feel free to reach out to other users or members of the Pieces team. +### Authentication Failed -You can also catch up on product updates, speak with our power users, or participate in weekly Community Events. +Getting an "authentication failed" error? Make sure you're using the same account you used before with Pieces. + +### Browser Doesn't Return + +After signing in, your browser might not automatically switch back to Pieces. That's okay—just manually switch back to the Pieces app. It should recognize that you've signed in successfully. If it hasn't, restart your Pieces and follow the sign-in steps again. + +### Repeatedly Signed Out + +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 + +## Keeping Your Account Safe + +Here are simple ways to protect your Pieces account: + +* Use a strong password if signing in with email +* Turn on two-factor authentication with your sign-in provider +* Sign out when using shared computers +* Let us know immediately if you see anything suspicious + +## Getting Help + +Having trouble signing in or have questions? We're here to help: + +* **[Live Support](https://calendar.app.google/WVUDtUfNy5Vst3sH7)**: Book a call with our Founders & Engineering Leaders +* **[GitHub Issues](https://github.com/pieces-app/support/issues)**: Report bugs, request features, and track known issues +* **[Discord Community](https://discord.com/invite/getpieces)**: Join our community for support, discussions, and direct interaction with the Pieces team +* **[Community Discussions](https://github.com/pieces-app/support/discussions)**: Create or read through existing discussions to inform our product roadmap +* **[Feedback Form](https://getpieces.typeform.com/to/mCjBSIjF#page=docs-support)**: Leave feedback or report bugs without using GitHub + +*** -## Join Community Discussions +## Next Steps -We’re active within our community and are always looking for feedback and suggestions from our power users. +Now that you're signed in, explore what Pieces can do for you. -If this is you, feel free to create or read through existing discussions on our GitHub—that way you can inform our product roadmap and contribute feature requests. +[Getting Started with Pieces →](/products/meet-pieces) diff --git a/public/content/meet-pieces/troubleshooting.md b/public/content/meet-pieces/troubleshooting.md index 9da74f1..44c16dd 100644 --- a/public/content/meet-pieces/troubleshooting.md +++ b/public/content/meet-pieces/troubleshooting.md @@ -15,15 +15,29 @@ Click one of the links below to get started troubleshooting on your device—or *** -| [Cross-Platform](/products/meet-pieces/troubleshooting/cross-platform) | [macOS](/products/meet-pieces/troubleshooting/macos) | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | -| [Windows](/products/meet-pieces/troubleshooting/windows) | [Linux](/products/meet-pieces/troubleshooting/linux) | + + + General troubleshooting for all platforms + + + + macOS-specific troubleshooting + + + + Windows-specific troubleshooting + + + + Linux-specific troubleshooting + + *** ## Cross-Platform Issues -This cross-platform troubleshooting documentation covers the Pieces Desktop App and PiecesOS, including updates, connectivity, system requirements, best practices for running local LLMs with Ollama, model selection for your hardware, and solutions for crashes due to limited resources or GPU compatibility. +This cross-platform troubleshooting documentation covers the Pieces Desktop App and PiecesOS, including updates, connectivity, system requirements, best practices for running local LLMs, model selection for your hardware, and solutions for crashes due to limited resources or GPU compatibility. Use the Cross-Platform page if you’re not sure where to begin or if your issue isn’t clearly related to your operating system. @@ -39,7 +53,7 @@ This cross-platform troubleshooting documentation covers the Pieces Desktop App ## macOS Issues -This macOS guide helps troubleshoot installation and update issues for PiecesOS and the Pieces Desktop App on macOS, covering manual installs (`PKG`, `DMG`, Homebrew), checking macOS version and CPU type, and fixing compatibility or outdated software problems. +This macOS guide helps troubleshoot installation and update issues for PiecesOS and the Pieces Desktop App on macOS, covering manual installs (`PKG`, `DMG`, `Homebrew`), checking macOS version and CPU type, and fixing compatibility or outdated software problems. The [macOS troubleshooting guide](/products/meet-pieces/troubleshooting/macos) provides information and guides on: diff --git a/public/content/meet-pieces/troubleshooting/cross-platform.md b/public/content/meet-pieces/troubleshooting/cross-platform.md index 40aa684..807a823 100644 --- a/public/content/meet-pieces/troubleshooting/cross-platform.md +++ b/public/content/meet-pieces/troubleshooting/cross-platform.md @@ -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, Ollama, the Pieces Desktop App, or PiecesOS itself. +Many issues can stem from out-of-date plugins, extensions, the Pieces Desktop App, or PiecesOS itself. ### Updating PiecesOS @@ -87,23 +87,23 @@ Platform-specific solutions are detailed on their respective OS pages: ## Using Local Models -Running Pieces software with a local LLM through **Ollama** can offer greater privacy, faster responses (when properly configured), and independence from cloud dependencies. +Running Pieces software with local LLMs can offer greater privacy, faster responses (when properly configured), and independence from cloud dependencies. -By utilizing the Ollama framework, users can efficiently deploy and manage local language models tailored to their needs. +Local models are served directly through PiecesOS, allowing users to efficiently deploy and manage on-device language models tailored to their needs. However, local models often require robust hardware configurations and careful optimization to run smoothly. -Older devices, regardless of operating system, may struggle to meet the hardware demands of these LLMs, even with Ollama's streamlined setup. +Older devices, regardless of operating system, may struggle to meet the hardware demands of these LLMs. ### Minimum System Requirements Local models demand more from your system than their cloud-hosted counterparts. -To ensure a stable, responsive experience—make sure your device fits these general minimum device specifications, pulled from Ollama documentation and other experience-tested public sources. +To ensure a stable, responsive experience—make sure your device fits these general minimum device specifications. - Ollama is supported on macOS, Windows, and Linux devices—but you need to make sure your operating system is running at the correct minimum version to avoid compatibility issues. + Local models are supported on macOS, Windows, and Linux devices—but you need to make sure your operating system is running at the correct minimum version to avoid compatibility issues. * **macOS:** macOS 13.0 (Ventura) or higher @@ -131,17 +131,17 @@ To ensure a stable, responsive experience—make sure your device fits these gen - While you don’t need a GPU to run a local Ollama model as long as the LLM is CPU-tuned, a GPU can significantly speed up inference and the training of custom models. + While you don't need a GPU to run a local model as long as the LLM is CPU-tuned, a GPU can significantly speed up inference and the training of custom models. * **Recommended:** Any modern GPU with at least 6GB of VRAM - Local large language models can occupy significant disk space, so ensure you have enough capacity for both the core installation and any custom models you plan to download or train. + Local large language models can occupy significant disk space, so ensure you have enough capacity for both the core installation and any custom models you plan to download. - * **Minimum:** At least 12GB of free storage space for installing Ollama and other base models. + * **Minimum:** At least 12GB of free storage space for base models. - * **Additional Storage:** Required for larger models that have additional dependencies + * **Additional Storage:** Required for larger models with additional dependencies diff --git a/public/content/meet-pieces/troubleshooting/linux.md b/public/content/meet-pieces/troubleshooting/linux.md index 5af15fc..e0dac93 100644 --- a/public/content/meet-pieces/troubleshooting/linux.md +++ b/public/content/meet-pieces/troubleshooting/linux.md @@ -67,10 +67,12 @@ Snap-based installations require an up-to-date snap `daemon`: 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. +* **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. + + Restart after changing your graphics engine to ensure Pieces doesn't hit any snags on startup. - The LTM-2 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. + 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. * **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. @@ -123,4 +125,4 @@ If you encounter persistent installation issues, consult online forums or commun If you’ve updated components, checked hardware, and adjusted configurations without success, restart your machine and try again. -If the problem persists, please open a GitHub issue for further assistance, or book a call with our engineers. \ No newline at end of file +If the problem persists, please open a GitHub issue for further assistance, or book a call with our engineers. \ No newline at end of file diff --git a/public/content/meet-pieces/troubleshooting/macos.md b/public/content/meet-pieces/troubleshooting/macos.md index b6ba736..9a2f609 100644 --- a/public/content/meet-pieces/troubleshooting/macos.md +++ b/public/content/meet-pieces/troubleshooting/macos.md @@ -56,31 +56,48 @@ Many issues can stem from out-of-date plugins, extensions, the desktop app, or P ### Updating PiecesOS -To restart and check for updates to PiecesOS on macOS: + + + Make sure PiecesOS is running—look for the **Pieces Icon** in your system tray (menu bar). + + + Check for available updates and install them if prompted. + + -1. Restart PiecesOS - -2. Ensure PiecesOS is running (look for the **Pieces Icon** in your system tray) - -3. Check for and install available updates - - + ### Updating the Pieces Desktop App -Updating the **Pieces Desktop App** on Windows and macOS systems can be done by clicking the **user icon** to the right of the **search bar** at the top of the Pieces Desktop Window, then clicking `Check for Desktop App Updates` or `Check for PiecesOS Updates`. +Updating the Pieces Desktop App on macOS can be done directly from the app: + + + + Launch the Pieces Desktop App. + -To check the Pieces Desktop App for updates on macOS: + + Click your username in the top left of the app. + -1. Open the Pieces Desktop App + + Hover over `Update` in the dropdown menu. + -2. Click the **user icon** to the right of the **search bar** at the top of the main app view + + Click on either `Desktop App` or `PiecesOS` from the Update submenu to check for and install updates for that component. + -3. Click `Check for Desktop App Updates` + + Restart the app when the update completes. - + + You may also see an update notification automatically when you open either of the apps. + + + -You can also click `Check for PiecesOS Updates` as an alternative to doing so in from the PiecesOS system window in your taskbar. + ## Common Installation Issues @@ -122,4 +139,4 @@ Once you’ve determined your CPU architecture, [download the correct installati If installation fails due to having an outdated version of macOS or installing the wrong package for your device’s architecture, restart your machine and try the installation again from scratch. -If the problem persists, please open a GitHub issue for further assistance, or book a call with our engineers. +If the problem persists, please open a GitHub issue for further assistance, or book a call with our engineers. diff --git a/public/content/meet-pieces/troubleshooting/windows.md b/public/content/meet-pieces/troubleshooting/windows.md index 9b66024..8c090fb 100644 --- a/public/content/meet-pieces/troubleshooting/windows.md +++ b/public/content/meet-pieces/troubleshooting/windows.md @@ -67,13 +67,17 @@ Many issues can stem from out-of-date plugins, extensions, the desktop app, or P ### Updating PiecesOS -To restart and check for updates to PiecesOS on Windows: - -1. Locate the Pieces Icon (`P`) in your taskbar - -2. Click the icon to view your update status - -3. If an update is available, follow the on-screen prompt to download and install it. + + + Find the Pieces Icon (`P`) in your taskbar. + + + Click the icon to view your update status. + + + If an update is available, follow the on-screen prompt to download and install it. + + @@ -81,19 +85,35 @@ For standalone .EXE installations, updates are checked daily or upon application ### Updating the Pieces Desktop App -Updating the Pieces Desktop App on Windows (and macOS) can be done directly within the application: +Updating the Pieces Desktop App on Windows can be done directly from the app: -1. Open the Pieces Desktop App + + + Press the `Windows Icon` and search for Pieces Desktop, open it. + -2. Click the **User Icon** to the right of the **Search Bar** at the top of the main app view + + Click your username in the top left of the app. + -3. Select `Check for Desktop App Updates` + + Hover over `Update` in the dropdown menu. + -4. If prompted, click `Download Update` install available updates + + Click on either `Desktop App` or `PiecesOS` from the Update submenu to check for and install updates for that component. + - + + Restart the app when the update completes. -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. + + You may also see an update notification automatically when you open either of the apps. + + + + + ## Issues Launching PiecesOS @@ -139,13 +159,19 @@ Before installing, ensure your Windows system is fully updated: ## Accessing Pieces Logs -On Windows machines, Pieces writes its log files under your local AppData folder. You’ll find two separate folders depending on which component you’re using: +On Windows machines, Pieces writes its log files under your local AppData folder. You'll find two separate folders depending on which component you're using: + +* **Pieces OS (POS) logs**: + +```plaintext +C:\Users\\AppData\Local\Mesh Intelligent Technologies, Inc\Pieces OS\com.pieces.os\production\Support +``` -* **Pieces OS (POS) logs**:\ - `C:\Users\\AppData\Local\Mesh Intelligent Technologies, Inc\Pieces OS\com.pieces.os\production\Support` +- **Pieces Desktop (PFD) logs**: -- **Pieces Desktop (PFD) logs**:\ - `C:\Users\\AppData\Local\Mesh Intelligent Technologies, Inc\Pieces OS\com.pieces.pfd\production\Support` +```plaintext +C:\Users\\AppData\Local\Mesh Intelligent Technologies, Inc\Pieces OS\com.pieces.pfd\production\Support +``` Replace \ with your Windows account name @@ -189,4 +215,4 @@ A new window will open called **About Windows**, which will display your current ## Restart & Retry -If the problem persists, please open a GitHub issue for further assistance or book a call with our engineers. \ No newline at end of file +If the problem persists, please open a GitHub issue for further assistance or book a call with our engineers. \ No newline at end of file diff --git a/public/content/meet-pieces/windows-installation-guide.md b/public/content/meet-pieces/windows-installation-guide.md index 96eaca9..45bd3d6 100644 --- a/public/content/meet-pieces/windows-installation-guide.md +++ b/public/content/meet-pieces/windows-installation-guide.md @@ -138,7 +138,7 @@ Read the documentation below for some tips and information to make sure you’re 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 clicking the `Profile` nested in the **Search Bar** at the top of your Pieces Desktop App view, then selecting `Check for Desktop App Updates` or `Check for PiecesOS 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`. diff --git a/public/content/organizations-and-teams.md b/public/content/organizations-and-teams.md new file mode 100644 index 0000000..65a1533 --- /dev/null +++ b/public/content/organizations-and-teams.md @@ -0,0 +1,70 @@ +--- +title: Organizations & Teams +path: /desktop/organizations-and-teams +visibility: PUBLIC +status: PUBLISHED +description: Create and manage organizations and teams to collaborate with others, share resources, and maintain consistent settings across your team in Pieces. +metaTitle: Organizations & Teams in Pieces Desktop | Pieces Docs +metaDescription: Learn how to create organizations, invite team members, manage team settings, and collaborate effectively with your team in Pieces. +--- + + + + + +*** + +## Creating and Joining Organizations + +Create a new organization to start collaborating with your team, or accept an invitation to join an existing organization. As an organization owner, you'll have full control over team settings, member access, and shared resources. + + + +> Account settings page showing Organizations & Teams section with Create organization button + + + Learn how to create a new organization, accept invitations, and get started with team collaboration. + + +## Managing Organizations + +As an organization owner or admin, you can manage members, configure settings, control billing, and oversee all aspects of your organization. Access powerful admin features to maintain team-wide consistency and control. + + + +> Organization overview page showing updates, members, teams, billing, and settings options + + + Explore organization management features including member management, billing, teams, and settings configuration. + + +## Organization Member Guide + +As a member of an organization, you can collaborate with your team, post updates, view shared content, and participate in team activities. Understand what you can do and how your role affects your access and permissions. + + + +> Organization overview page from a member's perspective showing available features and limitations + + + Learn about member features, permissions, and how to effectively collaborate within your organization. + + +## Troubleshooting + +Resolve common issues when working with organizations, including authentication problems, workspace loading issues, and access problems. + + + +> Troubleshooting guide showing common issues and solutions + + + Find solutions to common organization access issues and authentication problems. + + +*** + +If Organizations & Teams isn't what you're looking for, check out [Account Settings](/products/desktop/configuration/account) to manage your personal account, or explore [Connected Applications](/products/desktop/configuration/connected-applications) to integrate third-party services with your organization. diff --git a/public/content/organizations-and-teams/billing.md b/public/content/organizations-and-teams/billing.md new file mode 100644 index 0000000..c853723 --- /dev/null +++ b/public/content/organizations-and-teams/billing.md @@ -0,0 +1,115 @@ +--- +title: Billing +path: /desktop/organizations-and-teams/billing +visibility: PUBLIC +status: PUBLISHED +description: Learn how to manage your organization's subscription, update seat counts, and configure billing information. +metaTitle: Billing | Pieces Docs +metaDescription: Guide to managing organization subscriptions, seat counts, billing addresses, and payment information. +--- + +## Billing + +The Billing tab allows you to manage your organization's subscription, view billing details, update seat counts, and configure billing addresses. All billing changes are processed through the *Paddle* payment system. + + + +> Billing tab showing subscription details, seat count, and billing address options + + +### Viewing Subscription Information + +Access your current subscription details, billing amounts, and important dates. + + + + From your *organization overview* page, click `Billing` in the *sidebar* navigation. + + + + The *Billing* page displays your current subscription plan (e.g., "Enterprise Seat Yearly") and subscription status (Active or Canceled). + + + + View important billing information: + * **Billing Amount**: Your subscription cost (e.g., "$275.99 / year") + * **Total for X seats**: Total cost based on current seat count + * **Subscription Started**: Date when your subscription began + * **Next Billing Date**: When your next payment will be processed + + + +### Changing Seat Count + +Update the number of seats in your subscription to accommodate more or fewer team members. + + + + In the *Billing* page, find the *seat count* field. Use the `+` and `-` buttons to increase or decrease the number of seats, or type a number directly into the field. + + + + Note the minimum seats requirement shown below the seat count (e.g., "Minimum seats: 1 (based on 1 active member)"). You cannot set seats below this minimum. + + + + Click the `Update Seats` button to proceed with the seat change. This will open the billing window where you can review the new total and complete payment for the updated subscription. + + + + In the *billing* window, review the updated subscription details and complete payment through *Paddle*. Your seat count will update immediately after payment confirmation. + + + +## Configuring Billing Address + +Configure or update your organization's billing address for invoices and payment processing. + + + +> Billing Address section showing address fields and edit button + + + + Scroll down on the *Billing* page to find the *Billing Address* section. + + + + Click the `Edit Address` button in the top right of the *Billing Address* section. + + + + Fill in all required *billing address* fields: + * *Billing Contact* + * *Billing Email* + * *Billing Phone* + * *Billing Country* + * *Billing Street Address* + * *Billing City* + * *Billing State* + * *Billing ZIP Code* + + + + Click `Save` to save your billing address. This address will be used for invoices and payment processing. + + + +## Understanding Seat Minimums + +Your organization must maintain a minimum number of seats based on your active member count. Understanding seat minimums helps you manage your subscription effectively. + +Key points about seat minimums: + +* **Active Members** - Each active member requires one seat +* **Minimum Calculation** - Minimum seats = Number of active members +* **Seat Reduction** - You can only reduce seats if you first remove members to free up seats +* **Seat Increase** - You can add seats at any time, which will be billed according to your subscription plan + +When you try to reduce seats below the minimum, you'll see a warning indicating how many active members you have and the minimum seat requirement. + +*** + +## Next Steps + +Now that you understand billing, learn about [managing members](/products/organizations-and-teams/managing-members) to track seat usage, or explore [organization settings](/products/organizations-and-teams/organization-settings) to configure team-wide settings. diff --git a/public/content/organizations-and-teams/creating-and-joining-organizations.md b/public/content/organizations-and-teams/creating-and-joining-organizations.md new file mode 100644 index 0000000..ade49ab --- /dev/null +++ b/public/content/organizations-and-teams/creating-and-joining-organizations.md @@ -0,0 +1,93 @@ +--- +title: Creating and Joining Organizations +path: /desktop/organizations-and-teams/creating-and-joining-organizations +visibility: PUBLIC +status: PUBLISHED +description: Learn how to create a new organization or accept an invitation to join an existing organization in Pieces. +metaTitle: Creating and Joining Organizations | Pieces Docs +metaDescription: Step-by-step guide to creating organizations and accepting invitations to join teams in Pieces. +--- + +## Creating and Joining Organizations + +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. + + + +> Account settings page showing Organizations & Teams section with Create organization button + +## Creating an Organization + +Set up a new organization to start collaborating with your team. The creation process includes selecting a subscription plan and configuring initial settings. + + + + + + Click your `User Profile` in the top left, then click `Settings` and select `Account`. Scroll down to the *Organizations & Teams* section and click the `+ Create an organization` button. Alternatively, you can access the creation flow from your Personal Workspace. + + + + You'll be redirected to the Pieces Auth page, where you can sign in with your account credentials. If you encounter issues, you can access the login page directly at [portal.pieces.app/auth/login](https://portal.pieces.app/auth/login). + + + + Enter your organization name in the *provided* field, then choose a name that clearly identifies your team or company. + + + + Select the number of seats for your organization using the `+` and `-` buttons or by typing a number. The number of seats determines how many team members can be invited. + + You can adjust this later from the *billing* page. + + + + + Choose your subscription plan: + * **Enterprise Seat Yearly**: $275.99/seat/yr + * **Enterprise Seat Quarterly**: $69.99/seat/quarter + * **Enterprise Seat Monthly**: $22.99/seat/mo + + + + Click `Checkout` to proceed to the payment screen. Complete the payment process using PayPal, G Pay, or credit card through the *Paddle* payment system. + + + + After completing payment, you'll see a success screen and receive a confirmation email. Click the `X` in the top right of the *success popup* to proceed to the next step. + + + + You can invite team members by entering their email addresses and selecting roles (Owner, Admin, Write, or Read). Click `Send Invites & Finish` to complete setup, or click `Skip for Now` to invite members later. + + + + + If you encounter a "Loading your workspace..." issue that prevents you from accessing your organization, you can resolve it by navigating to [portal.pieces.app/auth/logout](https://portal.pieces.app/auth/logout) to forcefully sign out, then sign back in to access your workspace. + + +## Joining an Organization + +Accept an invitation to join an existing organization and start collaborating with your team. + + + + + + You'll receive an email invitation from the organization owner or admin. The email will contain details about the organization and your assigned role. + + + + Click the invitation link in the email to accept the invitation. You'll be immediately redirected to authenticate if needed. + + + + After accepting the invitation, you can access the organization from your Personal Workspace by clicking the *organization dropdown* in the *sidebar* to select and view the organization. + + + +*** + +## Next Steps + +Now that you've created or joined an organization, learn about [managing organizations](/products/organizations-and-teams/managing-organizations) to explore member management, billing, and settings, or check out the [Organization Overview](/products/organizations-and-teams/organization-overview) to learn how to navigate your organization dashboard. diff --git a/public/content/organizations-and-teams/inviting-members.md b/public/content/organizations-and-teams/inviting-members.md new file mode 100644 index 0000000..0454be1 --- /dev/null +++ b/public/content/organizations-and-teams/inviting-members.md @@ -0,0 +1,155 @@ +--- +title: Inviting Members +path: /desktop/organizations-and-teams/inviting-members +visibility: PUBLIC +status: PUBLISHED +description: Learn how to invite team members to your organization, assign roles, and use bulk invitation methods. +metaTitle: Inviting Members | Pieces Docs +metaDescription: Step-by-step guide to inviting members to your organization, including single invites, multiple invites, and CSV bulk uploads. +--- + +## Inviting Members + +Add team members to your organization by sending invitations. You can invite members individually, add multiple members at once, or bulk upload invitations via CSV file. Each member must have an available seat in your subscription. + + + +> Invite members modal showing email input, role selection, and CSV upload option + +## Understanding Member Roles + +Before inviting members, understand the different roles available and what each role can do within your organization. + + + +> Member roles overview showing Owner, Admin, Write, and Read role descriptions + +Each role has different permissions: + +* **Owner** - Full control including organization deletion +* **Admin** - Full access except organization deletion +* **Write** - Can create and edit resources +* **Read** - View-only access + +## Invitation Methods + +Invite team members using different methods depending on your needs and team size. + + +### Inviting a Single Member + +Invite one team member at a time with a specific role assignment. + + + + From the *organization overview* page, click the `Invite people` button in the top right corner. + + + + In the *Invite Organization Members* modal, enter the email address of the person you want to invite in the *email input* field. + + + + Click the `Select a role...` *dropdown* next to the email field and choose the appropriate role (Owner, Admin, Write, or Read). + + + + Click the `Send Invites & Finish` button (or `Send Invitations` if available) to send the invitation. The member will receive an email with instructions to join. + + + +### Inviting Multiple Members + +Add multiple members in a single invitation flow. + + + + Click the `Invite people` button from the *organization overview* page. + + + + Enter the email address and select a role for the first member. + + + + Click the `+ Add another member` link below the first member's information. + + + + Repeat the process to add email addresses and roles for each additional member you want to invite. + + + + Once all members are added, click `Send Invites & Finish` to send invitations to all members at once. + + + +### Bulk Inviting via CSV + +Upload a CSV file to invite multiple members at once, which is efficient for large teams. + + + + Click the `Invite people` button from the *organization overview* page. + + + + Create a CSV file with the format: `email,role` (one member per line). For example: + ``` + john@example.com,Admin + jane@example.com,Write + bob@example.com,Read + ``` + + + + In the *invite* modal, find the *Upload CSV* section. Click the `Upload CSV` button or drag and drop your CSV file into the *upload* area. + + + + Review the imported members and their roles, then click `Send Invites & Finish` to send all invitations. + + + +## Understanding Seat Limitations + +Your organization subscription includes a specific number of seats that determine how many active members you can have. Each active member uses one seat, and you cannot invite more members than you have available seats. + + + You can only invite members if you have available seats in your subscription. If you see a "No seats available" warning, you'll need to upgrade your subscription or remove inactive members before inviting new ones. + + +### Checking Seat Availability + +Before inviting members, check your current seat usage: + + + + From your *organization overview* page, click `Members` in the *sidebar* navigation. + + + At the top of the *Members* page, you'll see the *Seat Usage* card showing how many seats are used out of your total subscription (e.g., "1 of 1 seats used"). + + + If you need more seats, navigate to the *Billing* tab to increase your seat count. You can also remove inactive members to free up seats. + + + + + +> Members tab showing seat usage card with current usage and total seats + +### Seat Management + +Understanding how seats work helps you manage your organization effectively: + +* **Seat Usage** - View current seat usage in the *Members* tab +* **Upgrading Seats** - Increase seats from the *Billing* tab when you need to invite more members +* **Minimum Seats** - You must maintain at least one seat based on your number of active members +* **Available Seats** - Available seats = Total seats - Active members + +*** + +## Next Steps + +Now that you know how to invite members, learn about [managing members](/products/organizations-and-teams/managing-members) to update roles and handle member-related tasks, or explore [billing](/products/organizations-and-teams/billing) to manage your subscription and seat count. diff --git a/public/content/organizations-and-teams/managing-members.md b/public/content/organizations-and-teams/managing-members.md new file mode 100644 index 0000000..e17b3b0 --- /dev/null +++ b/public/content/organizations-and-teams/managing-members.md @@ -0,0 +1,116 @@ +--- +title: Managing Members +path: /desktop/organizations-and-teams/managing-members +visibility: PUBLIC +status: PUBLISHED +description: Learn how to manage organization members, view seat usage, handle pending invitations, and update member roles. +metaTitle: Managing Members | Pieces Docs +metaDescription: Comprehensive guide to managing organization members, roles, and seat allocation. +--- + +## Managing Members + +The Members tab provides a comprehensive view of all organization members, seat usage, pending invitations, and member management tools. Use this section to track membership, update roles, and manage access. + + + +> Members tab showing seat usage, current members list, and pending invites + +## Viewing Members and Seat Usage + +Access the Members tab to see current members, seat allocation, and pending invitations. + + + + From your *organization overview* page, click `Members` in the *sidebar* navigation. + + + + At the top of the Members page, you'll see the *Seat Usage* card showing how many seats are used out of your total subscription (e.g., "1 of 1 seats used") with a visual progress bar. + + + + Scroll down to the *Current Members* section to see a list of all active organization members, their email addresses, and their assigned roles (Owner, Admin, Write, or Read). + + + +### Viewing Pending Invitations + +Track invitations that have been sent but not yet accepted by members. + + + + In the *Members* page, click the `Pending Invites` tab at the top of the page. + + + + View all invitations that are waiting for acceptance. You'll see the email addresses and roles assigned to each pending invitation. + + + +## Managing Members + +Update member roles and remove members from your organization. + + + +### Managing Member Roles + +Update member roles to change their permissions and access levels within the organization. + + + + In the *Current Members* list, find the member whose role you want to change. Click the vertical ellipsis icon (three dots) next to their name to open the *member options* menu. + + + + Select the role dropdown and choose a new role: + * **Owner**: Full control including deletion rights + * **Admin**: Full access except organization deletion + * **Write**: Can create and edit resources + * **Read**: View-only access + + + + Click `Save` to apply the role change. The member's permissions will update immediately. + + + +### Removing Members + +Remove members from your organization when they no longer need access. + + + + In the *Current Members* list, click the vertical ellipsis icon next to the member you want to remove. + + + + Select `Remove from Organization` from the options menu. + + + + Confirm the removal action. The member will immediately lose access to the organization and their seat will become available. + + + +## Understanding Seat Management + +Seats are tied to your subscription and determine how many active members your organization can have. + + + +> Seat usage card showing current usage and total seats available + +Understanding how seats work helps you manage your organization effectively: + +* **Active Members** - Each active member uses one seat +* **Minimum Seats** - You must maintain at least one seat based on your number of active members +* **Seat Availability** - Available seats = Total seats - Active members +* **Upgrading** - Increase seats from the *Billing* tab when you need to invite more members + +*** + +## Next Steps + +Now that you understand member management, learn about [billing](/products/organizations-and-teams/billing) to manage your subscription and seat count, or explore [managing teams](/products/organizations-and-teams/managing-teams) to organize members into smaller groups. diff --git a/public/content/organizations-and-teams/managing-organizations.md b/public/content/organizations-and-teams/managing-organizations.md new file mode 100644 index 0000000..d0974af --- /dev/null +++ b/public/content/organizations-and-teams/managing-organizations.md @@ -0,0 +1,96 @@ +--- +title: Managing Organizations +path: /desktop/organizations-and-teams/managing-organizations +visibility: PUBLIC +status: PUBLISHED +description: Learn how to manage your organization as an owner or admin, including member management, billing, teams, and settings. +metaTitle: Managing Organizations | Pieces Docs +metaDescription: Comprehensive guide to managing organizations, members, teams, billing, and settings in Pieces. +--- + + + + + +*** + +## Organization Overview + +Access your organization dashboard to view updates, post content, invite members, and navigate to different sections of your organization. + + + +> Organization overview page showing recent updates, post update button, and sidebar navigation + + + Learn how to navigate your organization dashboard, post updates, and interact with team content. + + +## Inviting Members + +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 showing email input, role selection, and CSV upload option + + + Discover how to invite team members, assign roles, and use bulk invitation methods. + + +## Managing Members + +View and manage all organization members, track seat usage, handle pending invitations, and update member roles and permissions. + + + +> Members tab showing seat usage, current members list, and pending invites + + + Learn how to manage member roles, view seat usage, and handle member-related tasks. + + +## Managing Teams + +Create and manage teams within your organization to organize members into smaller groups. Teams can post updates and collaborate on specific projects. + + + +> Teams dropdown showing team list and create team option + + + Explore how to create teams, manage team members, and organize your organization into smaller groups. + + +## Billing + +Manage your organization's subscription, update seat counts, view billing information, and configure billing addresses. + + + +> Billing tab showing subscription details, seat count, and billing address options + + + Learn how to manage subscriptions, update seats, and configure billing information. + + +## Organization Settings + +Configure organization-wide settings that sync to team members' Pieces Desktop and PiecesOS installations. Control features, API keys, models, and LTM sources for your entire organization. + + + +> Settings page showing tabs for General, Teams, Features, API Keys, Models, LTM Sources, and LTM Websites + + + Discover how to configure organization settings, manage feature toggles, and control team-wide configurations. + + +*** + +## Next Steps + +Now that you understand organization management, learn about [Account Settings](/products/desktop/configuration/account) to manage your personal account, or explore how to [create and join organizations](/products/organizations-and-teams/creating-and-joining-organizations). diff --git a/public/content/organizations-and-teams/managing-teams.md b/public/content/organizations-and-teams/managing-teams.md new file mode 100644 index 0000000..61021ab --- /dev/null +++ b/public/content/organizations-and-teams/managing-teams.md @@ -0,0 +1,119 @@ +--- +title: Managing Teams +path: /desktop/organizations-and-teams/managing-teams +visibility: PUBLIC +status: PUBLISHED +description: Learn how to create and manage teams within your organization to organize members into smaller groups. +metaTitle: Managing Teams | Pieces Docs +metaDescription: Guide to creating teams, accessing team overviews, and managing team structure within your organization. +--- + +## Managing Teams + +Teams allow you to organize members within your organization into smaller groups. Teams can post updates and collaborate on specific projects, providing a way to segment work and communication. + + + +> Teams dropdown showing team list and create team option + +## Creating and Accessing Teams + +Set up new teams and navigate to existing teams within your organization. Teams help organize members into smaller groups for focused collaboration on specific projects. + + + +> Team creation modal showing name input field and create button + +### Creating a Team + +Set up a new team to organize members and facilitate focused collaboration. + + + + From your *organization overview* page, click `Teams` in the *sidebar* navigation. If no teams exist, you'll see a "No teams yet" message. + + + + Click the `Create team` link (with a plus icon) to open the team creation modal. + + + + In the *creation* modal, enter a name for your team that clearly identifies its purpose or project focus. + + + + Click the `Create Team` button to create the team. The team will be added to your organization and available in the Teams dropdown. + + + +### Accessing a Team + +View a team's overview page to see team-specific updates and activities. + + + + Click `Teams` in the *sidebar* navigation to expand the *teams dropdown*. + + + + Click on the team name you want to access from the list of available teams. + + + + The team overview page displays similar to the organization overview, showing recent updates posted to that team. You can post updates, view team activity, and see team members. + + + +## Working with Teams + +Post updates to teams and manage team structure. + + + +> Team overview page showing team-specific updates and activities + +### Posting Team Updates + +Share updates specific to a team by posting to the team's overview page. + + + + Navigate to the team you want to post an update to using the *Teams* dropdown. + + + + Click the `Post Update` button on the team overview page. + + + + Enter the title, content, and tags for your team update, then click `Post Update` to publish it to the team. + + + +### Deleting Teams + +Remove teams that are no longer needed from your organization. + + + + From your *organization overview*, click `Settings` in the *sidebar* navigation. + + + + In the *Settings* page, click the `Teams` tab to view all teams in your organization. + + + + Find the team you want to delete in the list. Click the red trash can icon next to the team name to delete it. + + + + Confirm the deletion. The team and all its updates will be permanently removed from your organization. + + + +*** + +## Next Steps + +Now that you understand team management, learn about [organization settings](/products/organizations-and-teams/organization-settings) to configure team-wide settings, or explore [managing members](/products/organizations-and-teams/managing-members) to understand how to assign members to teams. diff --git a/public/content/organizations-and-teams/member-overview.md b/public/content/organizations-and-teams/member-overview.md new file mode 100644 index 0000000..2c4414f --- /dev/null +++ b/public/content/organizations-and-teams/member-overview.md @@ -0,0 +1,153 @@ +--- +title: Member Overview +path: /desktop/organizations-and-teams/member-overview +visibility: PUBLIC +status: PUBLISHED +description: Learn how to navigate your organization dashboard, post updates, and interact with team content as a member. +metaTitle: Member Overview | Pieces Docs +metaDescription: Guide to using the organization overview page as a Read or Write member. +--- + +## Member Overview + +As a member of an organization, you can access the organization overview page to view updates, post content, and interact with your team. Your view is similar to owners and admins, but with some limitations on administrative features. + + + +> Organization overview page from a member's perspective showing available features + +## Accessing Your Organization + +Navigate to your organization from your Personal Workspace to access the overview page. + + + +> Personal Workspace showing organization dropdown and navigation options + + + + Click your `User Profile` in the top left, then click `Settings` and select `Account` to access your Personal Workspace. + + + + In the *sidebar*, click the *organization dropdown* at the top. Select the organization you want to access from the list of organizations you belong to. + + + + The organization overview page displays recent updates, team activity, and provides access to member-available features through the sidebar navigation. + + + +## Working with Updates + +Post, view, interact with, and manage content updates on your organization overview page. + + + +### Posting Content Updates + +Share updates, announcements, or information with your team by posting content updates to the organization. + + + + On the organization overview page, click the `Post Update` button in the top right (or the pencil icon next to "Recent Updates"). + + + + In the *Create Content Update* modal, fill in: + * **Title**: Enter a title describing what the update is about + * **Content**: Add the details of your update in the content field + * **Tags**: Add comma-separated tags (e.g., `# feature, bug-fix, announcement`) + + + + Click `Post Update` to publish your update. The update will appear in the *Recent Updates* section for all organization members to see. + + + +### Viewing and Interacting with Updates + +View team updates, add reactions, and comment on posts to engage with your team. + + + + Scroll through the *Recent Updates* section to see all posted updates. Each update shows the author, timestamp, tags, and content. + + + + Click the smiley face icon below an update to add a reaction. This helps team members quickly acknowledge updates. + + + + Click on the *comments* section (showing "X comments") to view existing comments on an update. + + + + Click the arrow down next to "comments" to expand the *comment* section. Type your comment in the text box and click the submit button (paper airplane icon) to post your comment. + + + +### Editing Your Updates + +Edit your own posted updates to update information or correct mistakes. Note that tags cannot be edited after posting. + + + + Find your update and click the pencil icon next to it. You can only edit updates you created. + + + + Update the title and *content* fields as needed. Tags cannot be modified after posting. + + + + Click the `Save` button (with checkmark icon) to save your changes. Click `Cancel` to discard changes. + + + +### Deleting Your Updates + +Remove your own updates that are no longer relevant or were posted by mistake. + + + + Find your update and click the trash can icon next to it. You can only delete updates you created. + + + + Confirm the deletion in the browser *popup*. This action cannot be undone. + + + +## Understanding Member Limitations + +As a member, you have access to collaboration features but cannot access administrative functions. Understanding these limitations helps you know what you can do and when you might need to contact an Owner or Admin. + + + Members cannot access: + * Member management (inviting, removing, or changing roles) + * Billing and subscription management + * Organization settings configuration + * Team creation or deletion (from settings) + + These features are reserved for Owners and Admins. If you need administrative access, contact your organization owner or admin. + + +## Available Sidebar Navigation + +As a member, you can access: + +The *sidebar* includes the following navigation options available to members: + +* **Overview** - Current page showing recent updates and team activity +* **Members** - View organization members (read-only access) +* **Teams** - View and access teams within the organization +* **Support** - Quick access to support resources + +Administrative sections like *Billing* and *Settings* are not visible to members and are reserved for Owners and Admins. + +*** + +## Next Steps + +Now that you understand the member overview, learn about [member permissions](/products/organizations-and-teams/member-permissions) to understand what you can do based on your role, or explore [managing organizations](/products/organizations-and-teams/managing-organizations) if you become an Owner or Admin. diff --git a/public/content/organizations-and-teams/member-permissions.md b/public/content/organizations-and-teams/member-permissions.md new file mode 100644 index 0000000..5220b61 --- /dev/null +++ b/public/content/organizations-and-teams/member-permissions.md @@ -0,0 +1,127 @@ +--- +title: Member Permissions +path: /desktop/organizations-and-teams/member-permissions +visibility: PUBLIC +status: PUBLISHED +description: Understand member roles, permissions, and how they affect what you can do in your organization. +metaTitle: Member Permissions | Pieces Docs +metaDescription: Comprehensive guide to organization member roles and permissions in Pieces. +--- + +## Member Permissions + +Understanding your role and permissions helps you know what you can do within your organization and what requires owner or admin access. Each role has specific capabilities and limitations. + +## Understanding Roles + +Organizations have four main roles with different permission levels. Each role determines what you can do within the organization. + +The four roles are: + +* **Owner** - Full control including organization deletion +* **Admin** - Full access except organization deletion +* **Write** - Can create and edit resources +* **Read** - View-only access + +## Role Permissions + +Each role has specific capabilities and limitations that determine what you can do within an organization. + + +### Read Role Permissions + +Members with the Read role have the most limited access. They can view content but cannot create or modify anything. + +**What Read members CAN do:** + +* View organization overview and recent updates +* View organization members list +* View teams and team updates +* Add reactions to updates +* View comments on updates +* Access support resources + +**What Read members CANNOT do:** + +* Post updates or create content +* Comment on updates +* Invite or manage members +* Access billing or settings +* Create or delete teams +* Edit or delete any content + +### Write Role Permissions + +Members with the Write role can create and edit content but cannot manage the organization. + +**What Write members CAN do:** +* Everything Read members can do, plus: +* Post content updates +* Comment on updates +* Edit their own updates +* Delete their own updates +* Create and manage their own content + +**What Write members CANNOT do:** +* Invite or manage members +* Change member roles +* Access billing or settings +* Create or delete teams (from settings) +* Edit or delete content created by others +* Manage organization-wide settings + +### Admin Role Permissions + +Admins have extensive access but cannot delete the organization. + +**What Admins CAN do:** +* Everything Write members can do, plus: +* Invite and manage members +* Change member roles +* Access billing and manage subscriptions +* Configure organization settings +* Create and delete teams +* Manage all organization content + +**What Admins CANNOT do:** +* Delete the organization (reserved for Owners) + +### Owner Role Permissions + +Owners have full control over the organization. + +**What Owners CAN do:** +* Everything Admins can do, plus: +* Delete the organization +* Full control over all organization resources + +## How Permissions Affect Daily Use + +Your role determines what you see and can do in the organization interface: + +* **Sidebar Navigation** - Read and Write members see fewer options than Admins and Owners +* **Action Buttons** - Some buttons (like `Invite people`) only appear for Admins and Owners +* **Settings Access** - Only Admins and Owners can access the *Settings* and *Billing* sections +* **Content Management** - Your ability to create, edit, and delete content depends on your role + +## Requesting Access Changes + +If you need different permissions to perform your work: + + + + Contact your organization Owner or Admin to request a role change. + + + Explain what you need to do and why you need different permissions. + + + If appropriate, the Owner or Admin can update your role. Role changes take effect immediately and affect what you can access in the organization. + + + +*** + +## Next Steps + +Now that you understand member permissions, learn about [member overview](/products/organizations-and-teams/member-overview) to see what features are available to you, or explore [managing organizations](/products/organizations-and-teams/managing-organizations) if you become an Owner or Admin. diff --git a/public/content/organizations-and-teams/organization-member-guide.md b/public/content/organizations-and-teams/organization-member-guide.md new file mode 100644 index 0000000..710ec1b --- /dev/null +++ b/public/content/organizations-and-teams/organization-member-guide.md @@ -0,0 +1,42 @@ +--- +title: Organization Member Guide +path: /desktop/organizations-and-teams/organization-member-guide +visibility: PUBLIC +status: PUBLISHED +description: Guide for Read and Write members on how to collaborate within organizations and understand member permissions. +metaTitle: Organization Member Guide | Pieces Docs +metaDescription: Learn about member features, permissions, and how to effectively collaborate within your organization. +--- + + +## Organization Member Guide + +As a member of an organization, you can collaborate with your team, post updates, view shared content, and participate in team activities. This guide explains what you can do as a member and how your role affects your access and permissions. + +## Organization Overview + +Access your organization dashboard to view updates, post content, and interact with your team. Members can participate in team collaboration while having limited administrative access. + + + +> Organization overview page from a member's perspective showing available features + + + Learn how to navigate your organization dashboard, post updates, and interact with team content as a member. + + +## Understanding Member Permissions + +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 + + + Understand member roles, permissions, and how they affect what you can do in your organization. + + +*** + +As a member, you have access to collaboration features while administrative functions are reserved for Owners and Admins. Learn more about [managing organizations](/products/organizations-and-teams/managing-organizations) if you become an Owner or Admin. diff --git a/public/content/organizations-and-teams/organization-overview.md b/public/content/organizations-and-teams/organization-overview.md new file mode 100644 index 0000000..cc7c942 --- /dev/null +++ b/public/content/organizations-and-teams/organization-overview.md @@ -0,0 +1,139 @@ +--- +title: Organization Overview +path: /desktop/organizations-and-teams/organization-overview +visibility: PUBLIC +status: PUBLISHED +description: Learn how to navigate your organization dashboard, post updates, and interact with team content as an owner or admin. +metaTitle: Organization Overview | Pieces Docs +metaDescription: Guide to using the organization overview page, posting updates, and managing organization content. +--- + +## Organization Overview + +The organization overview page is your main dashboard for managing and interacting with your organization. From here, you can post updates, view team activity, invite members, and navigate to different sections of your organization. + + + +> Organization overview page showing recent updates, post update button, and sidebar navigation + +## Accessing Your Organization + +Navigate to your organization from your Personal Workspace to access the overview page. + + + + Click your `User Profile` in the top left, then click `Settings` and select `Account` to access your Personal Workspace. + + + + In the *sidebar*, click the *organization dropdown* at the top. Select the organization you want to access from the list of organizations you belong to. + + + + The organization overview page displays recent updates, team activity, and provides access to all organization features through the sidebar navigation. + + + +## Working with Updates + +Post, view, interact with, and manage content updates on your organization overview page. + + + +### Posting Content Updates + +Share updates, announcements, or information with your team by posting content updates to the organization. + + + + On the organization overview page, click the `Post Update` button in the top right (or the pencil icon next to "Recent Updates"). + + + + In the *Create Content Update* modal, fill in: + * **Title**: Enter a title describing what the update is about + * **Content**: Add the details of your update in the content field + * **Tags**: Add comma-separated tags (e.g., `# feature, bug-fix, announcement`) + + + + Click `Post Update` to publish your update. The update will appear in the *Recent Updates* section for all organization members to see. + + + +### Viewing and Interacting with Updates + +View team updates, add reactions, and comment on posts to engage with your team. + + + + Scroll through the *Recent Updates* section to see all posted updates. Each update shows the author, timestamp, tags, and content. + + + + Click the smiley face icon below an update to add a reaction. This helps team members quickly acknowledge updates. + + + + Click on the *comments* section (showing "X comments") to view existing comments on an update. + + + + Click the arrow down next to "comments" to expand the *comment* section. Type your comment in the text box and click the submit button (paper airplane icon) to post your comment. + + + +### Editing Updates + +Edit your posted updates to update information or correct mistakes. Note that tags cannot be edited after posting. + + + + Find the update you want to edit and click the pencil icon next to the update. + + + + Update the title and *content* fields as needed. Tags cannot be modified after posting. + + + + Click the `Save` button (with checkmark icon) to save your changes. Click `Cancel` to discard changes. + + + +### Deleting Updates + +Remove updates that are no longer relevant or were posted by mistake. + + + + Find the update you want to delete and click the trash can icon next to the update. + + + + Confirm the deletion in the browser *popup*. This action cannot be undone. + + + +## Understanding Sidebar Navigation + +The *sidebar* provides quick access to all organization features. Use the *sidebar* to navigate between different sections of your organization. + + + +> Organization sidebar navigation showing Overview, Members, Teams, Billing, Settings, and Support options + +The sidebar includes the following navigation options: + +* **Overview** - Current page showing recent updates and team activity +* **Members** - View and manage organization members, track seat usage, and handle invitations +* **Teams** - Access and manage teams within the organization +* **Billing** - Manage subscription and billing information (Owners and Admins only) +* **Settings** - Configure organization settings that sync to team members (Owners and Admins only) +* **Support** - Quick access to support resources + +*** + +## Next Steps + +Now that you understand the organization overview, learn about [inviting members](/products/organizations-and-teams/inviting-members) to grow your team, or explore [managing members](/products/organizations-and-teams/managing-members) to understand member management features. diff --git a/public/content/organizations-and-teams/organization-settings.md b/public/content/organizations-and-teams/organization-settings.md new file mode 100644 index 0000000..e33a635 --- /dev/null +++ b/public/content/organizations-and-teams/organization-settings.md @@ -0,0 +1,110 @@ +--- +title: Organization Settings +path: /desktop/organizations-and-teams/organization-settings +visibility: PUBLIC +status: PUBLISHED +description: Configure organization-wide settings that sync to team members' Pieces Desktop and PiecesOS installations. +metaTitle: Organization Settings | Pieces Docs +metaDescription: Learn how to configure organization settings, manage feature toggles, API keys, models, and LTM sources for your team. +--- + + + + + +*** + +## General Settings + +Configure basic organization information, contact details, domains, and SSO integration settings. You can also delete your organization from this section. + + + +> General settings tab showing organization name, contact info, domains, and danger zone + + + Learn how to update organization details, configure domains, and manage organization deletion. + + +## Teams Settings + +View all teams in your organization, see member counts, and delete teams from the settings interface. + + + +> Teams settings tab showing list of teams with member counts and delete options + + + Discover how to manage teams from the settings interface and view team information. + + +## Features Settings + +Toggle organization-wide features that sync to team members' Pieces Desktop and PiecesOS. Control external cloud, analytics, processing capabilities, and workstream pattern engine settings. + + + +> Features settings tab showing various feature toggles and processing options + + + Learn how to enable and disable features that sync across your team's installations. + + +## API Keys Settings + +Configure API keys for AI services that sync to team members. Set up credentials for OpenAI, Gemini, Claude, Bedrock, and Azure OpenAI. + + + +> API Keys settings tab showing configuration options for different AI platforms + + + Explore how to configure API keys for various AI services that your team can use. + + +## Models Settings + +Control which AI models are available to your organization. Toggle model providers on or off and manage individual model access. + + + +> Models settings tab showing available model providers and individual models + + + Learn how to manage model access and control which AI models your team can use. + + +## LTM Sources Settings + +Manage which applications Pieces can access for the workstream pattern engine. Add, remove, and toggle application access for your organization. + + + +> LTM Sources settings tab showing available applications and access controls + + + Discover how to control which applications Pieces can access for LTM functionality. + + +## LTM Websites Settings + +Configure which websites Pieces is denied from accessing. Add individual URLs or bulk upload via CSV to control website access. + + + +> LTM Websites settings tab showing denied websites list and upload options + + + Learn how to manage denied websites and control Pieces' access to specific URLs. + + +*** + +All organization settings automatically sync to team members' Pieces Desktop and PiecesOS installations, ensuring consistent configuration across your team. + +## Next Steps + +Now that you understand organization settings, learn about [managing organizations](/products/organizations-and-teams/managing-organizations) to explore member management and billing, or check out [Account Settings](/products/desktop/configuration/account) to manage your personal account. diff --git a/public/content/organizations-and-teams/settings-api-keys.md b/public/content/organizations-and-teams/settings-api-keys.md new file mode 100644 index 0000000..03fe413 --- /dev/null +++ b/public/content/organizations-and-teams/settings-api-keys.md @@ -0,0 +1,181 @@ +--- +title: API Keys Settings +path: /desktop/organizations-and-teams/settings-api-keys +visibility: PUBLIC +status: PUBLISHED +description: Configure API keys for AI services that sync to team members' Pieces Desktop and PiecesOS installations. +metaTitle: API Keys Settings | Pieces Docs +metaDescription: Learn how to configure API keys for OpenAI, Gemini, Claude, Bedrock, and Azure OpenAI that your team can use. +--- + +## API Keys Settings + +The API Keys settings tab allows you to configure API credentials for various AI services. These API keys automatically sync to all team members' Pieces Desktop and PiecesOS installations, enabling your team to use these services without individual configuration. + + + +> API Keys settings tab showing configuration options for different AI platforms + + + All API keys configured here automatically sync to team members' Pieces Desktop and PiecesOS installations, allowing your entire team to use these AI services with organization-managed credentials. + + +## Accessing API Keys Settings + +Navigate to the API Keys settings tab to configure AI service credentials. These credentials enable your team to use various AI services without individual configuration. + + + + From your *organization overview* page, click `Settings` in the sidebar navigation. + + + + Click the `API Keys` tab at the top of the *Settings* page. + + + +## Configuring API Keys + +Set up API credentials for various AI services. Each service has its own configuration section. + + + +### Configuring OpenAI + +Set up OpenAI API credentials for your organization. + + + + Find the *OpenAI Configuration* section in the *API Keys settings* page. + + + + Click the `+ Add Credential` button next to the *OpenAI Configuration* section. + + + + Fill in the OpenAI-specific *credential* form with your API key and any required configuration details. + + + + Click `Save` to save your OpenAI credentials. The credentials will sync to all team members. + + + +### Configuring Gemini + +Set up Google Gemini API credentials for your organization. + + + + Find the *Gemini Configuration* section in the *API Keys settings* page. + + + + Click the `+ Add Credential` button next to the *Gemini Configuration* section. + + + + Fill in the Gemini-specific *credential* form with your API key and any required configuration details. + + + + Click `Save` to save your Gemini credentials. + + + +### Configuring Claude + +Set up Anthropic Claude API credentials for your organization. + + + + Find the *Claude Configuration* section in the *API Keys settings* page. + + + + Click the `+ Add Credential` button next to the *Claude Configuration* section. + + + + Fill in the Claude-specific *credential* form with your API key and any required configuration details. + + + + Click `Save` to save your Claude credentials. + + + +### Configuring Bedrock + +Set up AWS Bedrock access credentials and API keys for your organization. + + + + Find the *Bedrock Access Credentials* and *Bedrock API Keys* sections in the *API Keys settings* page. + + + + Click the `+ Add Credentials` button next to *Bedrock Access Credentials* to configure AWS access credentials for Bedrock service. + + + + Click the `+ Add API Key` button next to *Bedrock API Keys* to configure API keys for Bedrock service. + + + + Fill in the Bedrock-specific *credential* forms with your AWS access credentials and API keys. + + + + Click `Save` to save your Bedrock credentials. + + + +### Configuring Azure OpenAI + +Set up Azure OpenAI API configuration for your organization. + + + + Find the *Manage Azure OpenAI API configuration* section in the *API Keys settings* page. + + + + Click the `+ Add Configuration` button next to the *Azure OpenAI* section. + + + + Fill in the Azure OpenAI-specific *configuration* form with your Azure endpoint, API key, and deployment details. + + + + Click `Save` to save your Azure OpenAI configuration. + + + +## Managing API Keys + +View and manage existing API key configurations. + + + + + + Review all configured API keys in their respective *sections*. Each section shows "No credentials configured" or "No API keys configured" if none are set up. + + + + Use the options available for each configured credential to edit or remove API keys as needed. + + + + Click `Save` in the top right corner to save any changes made to API key configurations. + + + +*** + +## Next Steps + +Now that you understand API keys settings, explore [Models Settings](/products/organizations-and-teams/settings-models) to control which AI models are available to your organization, or check out [Features Settings](/products/organizations-and-teams/settings-features) to configure team-wide features. diff --git a/public/content/organizations-and-teams/settings-features.md b/public/content/organizations-and-teams/settings-features.md new file mode 100644 index 0000000..2a84e26 --- /dev/null +++ b/public/content/organizations-and-teams/settings-features.md @@ -0,0 +1,135 @@ +--- +title: Features Settings +path: /desktop/organizations-and-teams/settings-features +visibility: PUBLIC +status: PUBLISHED +description: Toggle organization-wide features that sync to team members' Pieces Desktop and PiecesOS installations. +metaTitle: Features Settings | Pieces Docs +metaDescription: Learn how to enable and disable features that sync across your team's Pieces installations. +--- + +## Features Settings + +The Features settings tab allows you to control organization-wide feature toggles that automatically sync to all team members' Pieces Desktop and PiecesOS installations. These settings ensure consistent feature availability across your team. + + + +> Features settings tab showing various feature toggles and processing options + + + All feature settings configured here automatically sync to team members' Pieces Desktop and PiecesOS installations, ensuring everyone has the same feature availability. + + +## Accessing Features Settings + +Navigate to the Features settings tab to configure organization-wide feature toggles. These settings control what features are available to your entire team. + + + + From your *organization overview* page, click `Settings` in the sidebar navigation. + + + + Click the `Features` tab at the top of the *Settings* page. + + + +## Feature Categories + +Configure organization-wide features organized by category. All feature settings automatically sync to team members' Pieces Desktop and PiecesOS installations. + +### External Cloud Features + +Control cloud-related operations and features for your organization. + + + + Find the *External Cloud* section in the *Features settings* page. + + + + Use the toggle switch next to *External Cloud* to enable or disable cloud connectivity, backup management (create, list, restore, delete), snippet sharing, and cloud allocation updates. + + + + Click `Save` in the top right corner to save your changes. The setting will sync to all team members. + + + +### Analytics Features + +Configure analytics and reporting features for your organization. + + + + Find the *Analytics* section in the *Features settings* page. + + + + Use the toggle switch next to *Telemetry* to enable or disable BigQuery and Segment analytics integrations. + + + + Use the toggle switch next to *Send Internal Summary Reports* to enable or disable sending internal summary reports to user team service. + + + + Click `Save` to apply your analytics settings. + + + +### External Provider Features + +Control external provider and processing features for your organization. + + + + Find the *External Provider* section in the *Features settings* page. + + + + Use the toggle switch next to *Customized Allowed Models* to enable or disable customizing allowed models with an allow-list. + + + + Use the toggle switch next to *Denied Workstream Pattern Engine Sources* to enable or disable denying specific workstream pattern engine sources. + + + + Use the toggle switch next to *Denied Workstream Pattern Engine Websites* to enable or disable denying specific websites for workstream pattern engine. + + + + Click `Save` to apply your external provider settings. + + + +### Processing Capabilities + +Configure processing capabilities for your organization. + + + + Find the *Processing* section in the *Features settings* page. + + + + Use the *dropdown* menu to select processing capabilities: + * **LOCAL**: Process everything locally + * **BLENDED**: Use a combination of local and cloud processing + + + + Use the toggle switch to enable or disable processing capabilities based on your selected mode. + + + + Click `Save` to apply your processing configuration. + + + +*** + +## Next Steps + +Now that you understand features settings, explore [API Keys Settings](/products/organizations-and-teams/settings-api-keys) to configure AI service credentials, or check out [Models Settings](/products/organizations-and-teams/settings-models) to control which AI models are available to your organization. diff --git a/public/content/organizations-and-teams/settings-general.md b/public/content/organizations-and-teams/settings-general.md new file mode 100644 index 0000000..aa0b7b6 --- /dev/null +++ b/public/content/organizations-and-teams/settings-general.md @@ -0,0 +1,135 @@ +--- +title: General Settings +path: /desktop/organizations-and-teams/settings-general +visibility: PUBLIC +status: PUBLISHED +description: Configure basic organization information, contact details, domains, and SSO integration settings. +metaTitle: General Settings | Pieces Docs +metaDescription: Learn how to update organization details, configure domains, set up SSO, and manage organization deletion. +--- + +## General Settings + +The General settings tab allows you to configure basic organization information, contact details, associated domains, SSO integration, and delete your organization. These settings control fundamental aspects of your organization's identity and access. + + + +> General settings tab showing organization name, contact info, domains, and danger zone + +## Accessing General Settings + +Navigate to the General settings tab to configure organization details. This is the default tab when you first open Settings. + + + + From your *organization overview* page, click `Settings` in the *sidebar* navigation. + + + + Click the `General` tab at the top of the *Settings* page. This is the default tab when you first open Settings. + + + +## Configuring Organization Details + +Update basic organization information, domains, and integration settings. + +### Updating Organization Information + +Modify your organization's basic details including name, contact information, and address. + + + + In the *Organization Name* field, update your organization's name as needed. + + + + Update the following contact fields: + * **Organization Contact**: Name of the primary contact person + * **Organization Email**: Primary email address for the organization + * **Organization Phone**: Contact phone number + + + + Fill in or modify the organization address fields: + * **Organization Country**: Select from the *dropdown* + * **Organization Street Address**: Enter street address + * **Organization City**: Enter city name + * **Organization State**: Select state from *dropdown* + * **Organization ZIP Code**: Enter ZIP/postal code + + + + Click the `Save` button in the top right corner to save all your changes. + + + +### Configuring Associated Domains + +Set up domains that are associated with your organization for automatic user assignment. + + + + In the *Associated Domains* section, enter a domain name (e.g., `example.com`) in the *input* field. + + + + Click the `+` button next to the *domain* field to add additional domains. You can add multiple domains to your organization. + + + + Click `Save` to save your domain configuration. Domains associated with this organization enable automatic user assignment for users with matching email domains. + + + +### Setting Up SSO Integration + +Configure SSO (Single Sign-On) integration using a tenant ID for *Descope* integration. + + + + In the *Tenant ID* field, enter your *Descope* tenant ID for SSO integration (e.g., `tenant-1234567890`). + + + + Click `Save` to save your SSO configuration. This is optional and only needed if you're using *Descope* for SSO integration. + + + +## Deleting an Organization + +Permanently delete your organization and all associated data. This action cannot be undone. + + + + + Deleting an organization is permanent and irreversible. This will permanently delete all organization data, team data, member associations, and billing information. Subscriptions will be cancelled. Make sure you have backups of any important data before proceeding. + + + + + Scroll down to the bottom of the General settings tab to find the *Danger Zone* section, which is highlighted in red. + + + + Review the warning message that explains what will be deleted: + * All organization data and settings + * All team data within this organization + * All member associations + * All billing and subscription information (subscriptions will be cancelled) + + + + Type your organization name exactly as it appears (e.g., "Pieces Test Organization") in the *confirmation* field to confirm deletion. + + + + Click the `Delete Organization` button. You'll be asked to confirm this action one more time before the organization is permanently deleted. + + + +*** + +## Next Steps + +Now that you understand general settings, explore other organization settings like [Features Settings](/products/organizations-and-teams/settings-features) to configure team-wide features, or check out [API Keys Settings](/products/organizations-and-teams/settings-api-keys) to configure AI service credentials. diff --git a/public/content/organizations-and-teams/settings-ltm-sources.md b/public/content/organizations-and-teams/settings-ltm-sources.md new file mode 100644 index 0000000..49305ff --- /dev/null +++ b/public/content/organizations-and-teams/settings-ltm-sources.md @@ -0,0 +1,117 @@ +--- +title: LTM Sources Settings +path: /desktop/organizations-and-teams/settings-ltm-sources +visibility: PUBLIC +status: PUBLISHED +description: Manage which applications Pieces can access for the workstream pattern engine. +metaTitle: LTM Sources Settings | Pieces Docs +metaDescription: Learn how to control which applications Pieces can access for LTM functionality. +--- + +## LTM Sources Settings + +The LTM Sources settings tab allows you to manage which applications Pieces can access for the workstream pattern engine. You can view available applications, add new applications, toggle access on or off, and these settings automatically sync to all team members' Pieces Desktop installations. + + + +> LTM Sources settings tab showing available applications and access controls + + + All LTM source settings configured here automatically sync to team members' Pieces Desktop installations, ensuring consistent application access control across your team. + + +## Accessing LTM Sources Settings + +Navigate to the LTM Sources settings tab to configure application access. These settings control which applications Pieces can access for the workstream pattern engine. + + + + From your *organization overview* page, click `Settings` in the sidebar navigation. + + + + Click the `LTM Sources` tab at the top of the *Settings* page. + + + +## Managing Application Access + +View, add, and control which applications Pieces can access for the workstream pattern engine. + + + +> Available applications list showing application names, bundle IDs, and toggle switches + +### Viewing Available Applications + +See all applications that Pieces can potentially access for the workstream pattern engine. + + + + The *LTM Sources* page displays all available applications in the *Available Applications* section. Each application shows: + * Application name + * Global tag (if applicable) + * Related bundle IDs and identifiers + + + + Use the search bar at the top with the placeholder "Search applications by name..." to quickly find specific applications. + + + + Each application has a toggle switch indicating whether Pieces has access to it (on) or is denied access (off). + + + +### Adding New Applications + +Add custom applications to control access for specific tools your team uses. + + + + Click the `+ Add Application` button at the top of the *LTM Sources* page. + + + + In the *Add New Application* modal, enter the application name in the *Application Name* field (e.g., "Chrome", "Safari", "Firefox"). + + + + In the *Bundle IDs* field, enter bundle identifiers to help identify specific applications (e.g., `com.example.app`). Click the `+` icon to add multiple bundle IDs. + + + + Click the `Create` button to add the application to your list. The application will appear in the *Available Applications* section. + + + +### Managing Application Access + +Toggle access on or off for specific applications to control what Pieces can access. + + + + Find the application you want to configure in the *Available Applications* list. + + + + Use the toggle switch next to the application name to grant (on) or deny (off) Pieces access to that application for the workstream pattern engine. + + + + Click `Save` in the top right corner to save your access changes. The settings will sync to all team members. + + + +## Understanding Global vs Organization Settings + +Some applications may have a *Global* tag, indicating they are system-wide applications. Organization-specific settings allow you to override or supplement global settings for your team. + +* **Global Applications** - System-wide applications that affect all users +* **Organization Settings** - Your organization's specific access controls that sync to team members + +*** + +## Next Steps + +Now that you understand LTM sources settings, explore [LTM Websites Settings](/products/organizations-and-teams/settings-ltm-websites) to configure which websites Pieces is denied from accessing, or check out [Features Settings](/products/organizations-and-teams/settings-features) to configure team-wide features. diff --git a/public/content/organizations-and-teams/settings-ltm-websites.md b/public/content/organizations-and-teams/settings-ltm-websites.md new file mode 100644 index 0000000..26607b0 --- /dev/null +++ b/public/content/organizations-and-teams/settings-ltm-websites.md @@ -0,0 +1,116 @@ +--- +title: LTM Websites Settings +path: /desktop/organizations-and-teams/settings-ltm-websites +visibility: PUBLIC +status: PUBLISHED +description: Configure which websites Pieces is denied from accessing for the workstream pattern engine. +metaTitle: LTM Websites Settings | Pieces Docs +metaDescription: Learn how to manage denied websites and control Pieces' access to specific URLs. +--- + +## LTM Websites Settings + +The LTM Websites settings tab allows you to configure which websites Pieces is denied from accessing for the workstream pattern engine. You can add individual URLs or bulk upload via CSV, and these settings automatically sync to all team members' Pieces Desktop installations. + + + +> LTM Websites settings tab showing denied websites list and upload options + + + All LTM website settings configured here automatically sync to team members' Pieces Desktop installations, ensuring consistent website access control across your team. + + +## Accessing LTM Websites Settings + +Navigate to the LTM Websites settings tab to configure denied websites. These settings control which websites Pieces is denied from accessing for the workstream pattern engine. + + + + From your *organization overview* page, click `Settings` in the sidebar navigation. + + + + Click the `LTM Websites` tab at the top of the *Settings* page. + + + +## Managing Denied Websites + +Add websites to the denied list to prevent Pieces from accessing them. You can add websites individually or upload multiple sites via CSV. + +### Adding Denied Websites Manually + +Add individual websites to the denied list to prevent Pieces from accessing them. + + + + In the *website input* field, enter the URL of the website you want to deny access to (e.g., `https://example.com` or `example.com`). + + + + Click the `add` button or press Enter to add the website to your *denied* list. + + + + Click `Save` in the top right corner to save your *denied websites* list. + + + +### Bulk Uploading Denied Websites + +Upload multiple websites at once using a CSV file for efficient management. + + + + Create a CSV file with one website URL per line. For example: + ``` + https://example.com + https://another-site.com + https://third-site.com + ``` + + + + Click the `Upload CSV` button or drag and drop your CSV file into the *upload* area on the *LTM Websites settings* page. + + + + Review the list of websites that were imported from your CSV file. + + + + Click `Save` to save all imported websites to your *denied* list. + + + +### Managing Denied Websites List + +View and manage your current list of denied websites. + + + + Review all websites currently in your *denied* list on the *LTM Websites settings* page. + + + + Use the remove option (typically an X icon or delete button) next to each website to remove it from the *denied* list if needed. + + + + Click `Save` to apply any changes to your *denied websites* list. + + + +## Understanding Website Denial + +When a website is added to the *denied* list, Pieces will not access data from that website for the workstream pattern engine. This helps you control what information Pieces can collect and use. + +* **Privacy Control** - Prevent Pieces from accessing sensitive or private websites +* **Team Consistency** - Ensure all team members have the same website access restrictions +* **Automatic Sync** - Settings automatically apply to all team members' installations + +*** + +## Next Steps + +Now that you understand LTM websites settings, explore [LTM Sources Settings](/products/organizations-and-teams/settings-ltm-sources) to control which applications Pieces can access, or check out [Features Settings](/products/organizations-and-teams/settings-features) to configure team-wide features. diff --git a/public/content/organizations-and-teams/settings-models.md b/public/content/organizations-and-teams/settings-models.md new file mode 100644 index 0000000..72f199a --- /dev/null +++ b/public/content/organizations-and-teams/settings-models.md @@ -0,0 +1,117 @@ +--- +title: Models Settings +path: /desktop/organizations-and-teams/settings-models +visibility: PUBLIC +status: PUBLISHED +description: Control which AI models are available to your organization and sync to team members' installations. +metaTitle: Models Settings | Pieces Docs +metaDescription: Learn how to manage model access and control which AI models your team can use in Pieces. +--- + +## Models Settings + +The Models settings tab allows you to control which AI models are available to your organization. You can toggle entire model providers on or off, manage individual models, and these settings automatically sync to all team members' Pieces Desktop and PiecesOS installations. + + + + + All model settings configured here automatically sync to team members' Pieces Desktop and PiecesOS installations, ensuring everyone has access to the same models. + + +## Accessing Models Settings + +Navigate to the Models settings tab to configure model access. + + + + From your *organization overview* page, click `Settings` in the sidebar navigation. + + + + Click the `Models` tab at the top of the *Settings* page. + + + +## Managing Model Access + +Control which AI models are available to your organization by toggling providers and managing individual models. + +### Toggling Model Providers + +Enable or disable entire model providers for your organization. + + + + Find the model provider you want to configure (e.g., ANTHROPIC, GOOGLE, OPENAI). + + + + Read the description that explains these models will use the Pieces default configurations. + + + + Use the toggle switch next to the provider name to turn the entire provider on or off. When off, none of that provider's models will be available to your organization. + + + + Click `Save` in the top right corner to save your changes. + + + +### Managing Individual Models + +View and understand individual models within each provider. + + + + Under each enabled provider, you'll see a list of available models with their descriptions and labels. + + + + Models are labeled with their characteristics: + * **Accurate** (green badge): Models optimized for accuracy and detailed analysis + * **Fast** (blue badge): Models optimized for speed and efficiency + + + + Each model includes a description explaining its capabilities, context window, and use cases. + + + +### Using Toggle All Functions + +Quickly enable or disable all models at once. + + + + Find the `Toggle All On` and `Toggle All Off` buttons at the top of the *Model Access* section. + + + + Click `Toggle All On` to enable all model providers and their models at once. + + + + Click `Toggle All Off` to disable all model providers and their models at once. + + + + Click `Save` to apply your changes after using the toggle all functions. + + + +## Example Model Providers + +Common model providers you may see include: + +* **ANTHROPIC**: Claude models (4.5 Opus, 4.5 Sonnet, 4.5 Haiku, 4 Sonnet, 3.7 Sonnet, 3.5 Sonnet, 3.5 Haiku) +* **GOOGLE**: Gemini models (3 Pro Preview, 3 Flash Preview, 2.5 Pro, 2.5 Flash, 2.5 Flash Lite, 2 Flash Lite) +* **OPENAI**: GPT models (5.2 Pro, 5.2, 5.1, GPT-5 Thinking, GPT-5, GPT-5 Fast, o4 Mini, o3 Pro, o3 Mini, o3, o1, GPT-4.1, GPT-4o, GPT-4o Mini) + +Each provider's models use the Pieces default configurations and sync to your team members' installations. + +*** + +## Next Steps + +Now that you understand models settings, explore [LTM Sources Settings](/products/organizations-and-teams/settings-ltm-sources) to control which applications Pieces can access, or check out [API Keys Settings](/products/organizations-and-teams/settings-api-keys) to configure AI service credentials. diff --git a/public/content/organizations-and-teams/settings-teams.md b/public/content/organizations-and-teams/settings-teams.md new file mode 100644 index 0000000..3e60018 --- /dev/null +++ b/public/content/organizations-and-teams/settings-teams.md @@ -0,0 +1,79 @@ +--- +title: Teams Settings +path: /desktop/organizations-and-teams/settings-teams +visibility: PUBLIC +status: PUBLISHED +description: View all teams in your organization, see member counts, and delete teams from the settings interface. +metaTitle: Teams Settings | Pieces Docs +metaDescription: Learn how to manage teams from the settings interface and view team information. +--- + +## Teams Settings + +The Teams settings tab provides a centralized view of all teams within your organization. From here, you can see team member counts and delete teams that are no longer needed. + + + +> Teams settings tab showing list of teams with member counts and delete options + +## Accessing Teams Settings + +Navigate to the Teams settings tab to view and manage all organization teams. This provides a centralized view of all teams in your organization. + + + + From your *organization overview* page, click `Settings` in the sidebar navigation. + + + + Click the `Teams` tab at the top of the *Settings* page. + + + +## Viewing Teams + +See all teams in your organization along with their member counts. + + + + The *Teams settings* page displays all teams in your organization. Each *team* card shows: + * Team name + * Number of members in the team + + + + Use the member count information to understand team sizes and organization structure at a glance. + + + +## Deleting Teams + +Remove teams that are no longer needed from your organization. + + + +> Team deletion interface showing delete button and confirmation + + + + Find the team you want to delete in the *teams* list on the *Teams settings* page. + + + + Click the red trash can icon on the right side of the *team* card to delete the team. + + + + Confirm the deletion. The team and all its associated data will be permanently removed from your organization. + + + + + Note: Deleting a team will remove all team updates and team-specific content. Team members will remain in the organization but will no longer be associated with the deleted team. + + +*** + +## Next Steps + +Now that you understand teams settings, learn about [managing teams](/products/organizations-and-teams/managing-teams) to create and organize teams, or explore [Features Settings](/products/organizations-and-teams/settings-features) to configure team-wide features. diff --git a/public/content/organizations-and-teams/troubleshooting.md b/public/content/organizations-and-teams/troubleshooting.md new file mode 100644 index 0000000..ba39abb --- /dev/null +++ b/public/content/organizations-and-teams/troubleshooting.md @@ -0,0 +1,169 @@ +--- +title: Troubleshooting Organizations & Teams +path: /desktop/organizations-and-teams/troubleshooting +visibility: PUBLIC +status: PUBLISHED +description: Resolve common issues when working with organizations, including authentication problems and workspace loading issues. +metaTitle: Troubleshooting Organizations & Teams | Pieces Docs +metaDescription: Find solutions to common organization access issues and authentication problems. +--- + +## Troubleshooting Organizations & Teams + +If you encounter issues when creating, accessing, or managing organizations, use this guide to resolve common problems. + + + +> Troubleshooting guide showing common issues and solutions + +### "Loading your workspace..." Stuck Issue + +If you get stuck on a "Loading your workspace..." screen when trying to access your organization, you can resolve this by forcing a logout and re-authenticating. + + + + + In your browser, navigate directly to [portal.pieces.app/auth/logout](https://portal.pieces.app/auth/logout). This will forcefully sign you out of your current session. + + + + Wait for the logout process to complete. You should be redirected to a sign-in page or see a confirmation that you've been logged out. + + + + Navigate to [portal.pieces.app/auth/login](https://portal.pieces.app/auth/login) and sign back in with your account credentials. + + + + After signing back in, you should be able to access your Personal Workspace and organizations without the loading issue. + + + +### Cannot Access Organization After Creation + +If you've created an organization but cannot access it: + + + + Verify that you received a success email confirming your organization creation. Check your spam folder if you don't see it. + + + + Ensure you're signed in to the correct account that was used to create the organization. + + + + Use the logout/login process described above to refresh your session. + + + + In your Personal Workspace, check the *organization dropdown* in the sidebar to see if your organization appears in the list. + + + +### Cannot Accept Organization Invitation + +If you're having trouble accepting an organization invitation: + + + + Make sure you're clicking the invitation link from the email sent by the organization owner or admin. + + + + Ensure you're signed in to the account that matches the email address the invitation was sent to. + + + + If the invitation link doesn't work, try logging in directly at [portal.pieces.app/auth/login](https://portal.pieces.app/auth/login), then check your Personal Workspace for the organization. + + + + If you still cannot accept the invitation, contact the organization owner or admin to verify the invitation status and resend if needed. + + + +### Cannot Use Pieces After Joining Organization + +If you've joined a new organization but cannot use Pieces until you configure models: + + + + In Pieces Desktop, navigate to *Settings* by clicking your profile picture in the top left and selecting `Settings`, or use the keyboard shortcut `⌘+,` (macOS) or `ctrl+,` (Windows/Linux). + + + + In the *Settings* sidebar, click on the `Models` tab or category. + + + + Toggle all models on, or select the specific models you want to use from the available options. + + + + Click the `Save` button to save your model selections. After saving, you should be able to use Pieces with your organization. + + + +### Organization Not Appearing in Dropdown + +If your organization doesn't appear in the organization dropdown: + + + + Try refreshing your browser page to reload the organization list. + + + + If you belong to multiple organizations, scroll through the *dropdown* list to find the one you're looking for. + + + + Confirm that you're still a member of the organization. Contact the organization owner or admin if you believe you should have access. + + + + Use the logout/login process to refresh your session and organization list. + + + +### Settings Not Syncing to Desktop + +If organization settings aren't appearing in your Pieces Desktop installation: + + + + Confirm that you're a member of the organization and that settings have been configured by an Owner or Admin. + + + + Ensure your Pieces Desktop is connected to your account and signed in. + + + + Try restarting your Pieces Desktop application to allow settings to sync. + + + + In Pieces Desktop, check if there's an *organization settings* section that shows synced settings. + + + + If settings still don't sync, contact support for assistance with organization settings synchronization. + + + +## Getting Additional Help + +If you continue to experience issues after trying the solutions above, here are additional resources: + +* **Account Settings Documentation** - Check the [Account Settings](/products/desktop/configuration/account) documentation for account-related issues +* **Setup Guide** - Review the [Creating and Joining Organizations](/products/organizations-and-teams/creating-and-joining-organizations) guide for setup issues +* **Support Team** - [Set up a call with our support team](https://calendar.app.google/WVUDtUfNy5Vst3sH7) to get personalized assistance +* **Organization Admin** - Reach out to your organization Owner or Admin for organization-specific issues + +*** + +## Next Steps + +If you've resolved your issue, learn about [managing organizations](/products/organizations-and-teams/managing-organizations) to explore admin features, or check out [creating and joining organizations](/products/organizations-and-teams/creating-and-joining-organizations) if you're setting up a new organization. diff --git a/public/content/paid-plans.md b/public/content/paid-plans.md index 7555dcd..ec10d25 100644 --- a/public/content/paid-plans.md +++ b/public/content/paid-plans.md @@ -17,6 +17,76 @@ Pieces Pro elevates your development workflow by providing access to premium AI Designed for teams and individuals who demand cutting-edge capabilities, Pieces Pro builds on the free core features of snippet management and AI assistance. +## Pricing + +Choose the plan that works best for you: + + + +
+ Free Forever +
+ +
+
Free
+
Perfect for getting started
+
+ +
+
Includes:
+
    +
  • ✓ Basic AI features
    • +
  • ✓ Local storage only
    • +
  • ✓ Community support
    • +
  • ✓ Limited cloud backup
    • +
+
+ + + +
+ Monthly Billing +
+ +
+
$18.99
+
per month
+
+ +
+
Includes:
+
    +
  • ✓ Full access to Pieces Pro features
    • +
  • ✓ AI-powered code generation
    • +
  • ✓ Advanced code search
    • +
  • ✓ Priority support
    • +
+
+ + + +
+ Most Popular +
+ +
+
$169.99
+
per year ($14.17/month)
+
Save 20% compared to monthly
+
+ +
+
Includes:
+
    +
  • ✓ Full access to Pieces Pro features
    • +
  • ✓ AI-powered code generation
    • +
  • ✓ Advanced code search
    • +
  • ✓ Priority support
    • +
+
+ + + ## Benefits 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. @@ -25,7 +95,7 @@ Unlimited access to *premium LLMs, infinite long-term memory,* and *priority sup Deep Study reports are a Pieces Pro feature. Activate them in the Copilot chat via the `Activate DeepStudy` button to generate comprehensive, sourced summaries of your recent work. - + ### Premium AI Models @@ -33,15 +103,20 @@ Experience faster, more accurate AI assistance with top-tier cloud LLMs from lea | **OpenAI** | **Anthropic** | **Google** | | ------------ | ------------------- | ---------------------- | -| GPT-5 | Claude 4.1 Opus | Gemini 2.5 Pro | -| GPT-5 Mini | Claude 4 Opus | Gemini 2.5 Flash | -| GPT-5 Nano | Claude 4 Sonnet | Gemini 2.5-Flash-Lite | -| o4 Mini | | | +| GPT-5.2 Pro | Claude 4.5 Opus | Gemini 3 Pro Preview | +| GPT-5.2 | Claude 4.5 Sonnet | Gemini 3 Flash Preview| +| GPT-5.1 | Claude 4.5 Haiku | Gemini 2.5 Pro | +| GPT-5 Thinking| Claude 4 Sonnet | Gemini 2.5 Flash | +| GPT-5 | Claude 3.7 Sonnet | Gemini 2.5 Flash Lite | +| GPT-5 Fast | Claude 3.5 Sonnet | Gemini 2 Flash Lite | +| o4 Mini | Claude 3.5 Haiku | | | o3 Pro | | | | o3 Mini | | | | o3 | | | | o1 | | | | GPT-4.1 | | | +| GPT-4o | | | +| GPT-4o Mini | | | Model availability may vary by plan and region. See the latest list on the Cloud Models page. @@ -54,14 +129,8 @@ Use the built-in controls in Pieces Desktop or PiecesOS to activate your Pro sub ### In Pieces Desktop - - Click your `profile icon` in the top bar. This is located on the right side of the search bar within the Pieces Desktop app. - - - - Tap `Unlock Pieces Pro` to open the upgrade modal, which highlights your new perks. - - + + Click the `Unlock Pieces Pro` button in the top bar, located to the right of your profile icon. This opens the upgrade modal, which highlights your new perks. @@ -149,17 +218,17 @@ Change or add your credit card directly in the *Payment methods* tab. - Click your profile icon and choose `All Settings`. + Click your `User Profile` in the top left, then hover over `Settings` in the dropdown menu. - - At the bottom of the Settings menu, select `Subscription` to view your active plan. + + Click `Account` from the settings hover menu to view your account settings, including your subscription. - + - Click the `user icon` next to your subscription entry to launch the *Billing Dashboard.* + Click the `Manage` next to your subscription entry to launch the *Billing Dashboard.* @@ -183,15 +252,15 @@ Click `Cancel subscription` in the *Subscription* tab. You’ll be redirected to - Click your profile icon and choose `All Settings`. + Click your `User Profile` in the top left, then hover over `Settings` in the dropdown menu. - - At the bottom of the Settings menu, select `Subscription` to view your active plan. + + Click `Account` from the settings hover menu to view your account settings, including your subscription. - Click the `user icon` next to your subscription entry to launch the billing dashboard. + Click the `Manage` next to your subscription entry to launch the billing dashboard. @@ -211,15 +280,15 @@ Browse your billing history in the *Payments* tab. Click `any entry` to view a c - Click your profile icon and choose `All Settings`. + Click your `User Profile` in the top left, then hover over `Settings` in the dropdown menu. - - At the bottom of the Settings menu, select `Subscription` to view your active plan. + + Click `Account` from the settings hover menu to view your account settings, including your subscription. - Click the `user icon` next to your subscription entry to launch the billing dashboard. + Click the `Manage` next to your subscription entry to launch the billing dashboard. diff --git a/public/content/paid-plans/manage-subscription.md b/public/content/paid-plans/manage-subscription.md new file mode 100644 index 0000000..9bae6ed --- /dev/null +++ b/public/content/paid-plans/manage-subscription.md @@ -0,0 +1,13 @@ +--- +title: Manage Subscription +path: /paid-plans/manage-subscription +visibility: PUBLIC +status: PUBLISHED +description: Manage your Pieces Pro subscription settings and billing information. +metaTitle: Manage Subscription | Pieces Pro +metaDescription: Manage your Pieces Pro subscription, update payment methods, and access billing information. +--- + +## Manage Subscription + +Manage your Pieces Pro subscription settings and billing information. diff --git a/public/content/privacy-security-your-data.md b/public/content/privacy-security-your-data.md index f9532df..196e89b 100644 --- a/public/content/privacy-security-your-data.md +++ b/public/content/privacy-security-your-data.md @@ -25,7 +25,7 @@ Designed for complete user control, all cloud features are opt-in only, telemetr 🛡️ *We are SOC 2 Certified & Enterprise-Ready!* - + *** @@ -132,12 +132,12 @@ Our Long-Term Memory (LTM-2.7) Engine is designed to protect your work through o * **On-device Processing:** All LTM functions run locally by default, keeping your sensitive data within your own environment. -* **Local LLM Options via** Ollama: You can integrate with local LLMs through the Pieces client’s usage of Ollama as a local model wrapper for added security. +* **Built-in Local Models:** You can download and use local LLMs directly through PiecesOS for complete on-device AI processing with added security. * **Complete Control Over Data Sharing:** Decide when and if your data is shared, so you can be confident that you maintain full ownership and control over your information. - For users concerned about privacy, we strongly recommend using a local LLM with Pieces products, so LTM-2.7, Pieces Copilot and Pieces Drive never send data through the cloud. + For users concerned about privacy, we strongly recommend using local models with Pieces products, so LTM-2.7, Pieces Copilot and Pieces Drive never send data through the cloud. ## Privacy Policy Updates diff --git a/public/content/quick-guides/ltm-context.md b/public/content/quick-guides/ltm-context.md index d8cc83d..851ffec 100644 --- a/public/content/quick-guides/ltm-context.md +++ b/public/content/quick-guides/ltm-context.md @@ -19,8 +19,6 @@ To complete this Quick Guide, you’ll need: To enable the LTM-2.7 Engine from PiecesOS, click the PiecesOS icon to open the [Quick Menu](/products/core-dependencies/pieces-os/quick-menu#ltm-2-engine) on Windows or macOS, then select `Enable Long-Term Memory Engine`. - - ## In This Quick Guide In this Quick Guide, you’ll use [Pieces Long-Term Memory](/products/core-dependencies/pieces-os#ltm-27) to save context from a website, then prompt the Pieces Copilot to tell you what it saw. diff --git a/public/content/quick-guides/ltm-prompting.md b/public/content/quick-guides/ltm-prompting.md index b9fc53a..9f51e60 100644 --- a/public/content/quick-guides/ltm-prompting.md +++ b/public/content/quick-guides/ltm-prompting.md @@ -34,8 +34,4 @@ Click one of the cards below to jump to that guide. A selection of popular use cases for the new Pieces Workstream Activity view. - - - - Some general prompting tips to help you get the most out of Pieces. - \ No newline at end of file + \ No newline at end of file diff --git a/public/content/quick-guides/ltm-prompting/examples.md b/public/content/quick-guides/ltm-prompting/examples.md index 013d76a..3100bc3 100644 --- a/public/content/quick-guides/ltm-prompting/examples.md +++ b/public/content/quick-guides/ltm-prompting/examples.md @@ -10,7 +10,7 @@ metaDescription: Explore use cases and example prompts for Pieces Long-Term Memo ## In This Guide -There are many ways to use and prompt LTM to find specific information, recall past fixes and solutions, refresh your memory from conversations and shared resources, and much more. +There are many ways to use and prompt the LTM to find specific information, recall past fixes and solutions, refresh your memory from conversations and shared resources, and much more. In this guide, you’ll find some carefully selected use cases and examples that our users commonly rely on—but this is just the beginning. diff --git a/public/content/quick-guides/overview.md b/public/content/quick-guides/overview.md index bb129f2..29c3b7f 100644 --- a/public/content/quick-guides/overview.md +++ b/public/content/quick-guides/overview.md @@ -3,7 +3,7 @@ title: Introduction to Pieces Quick Guides path: /quick-guides/overview visibility: PUBLIC status: PUBLISHED -description: Welcome to Pieces! 👋 Here, you can explore these curated Quick Guides to unlock full productivity potential through AI-driven context-aware development with Pieces. +description: Welcome to Pieces! 👋 Here, you can explore these curated Quick Guides to unlock full productivity potential through AI-driven context-aware workflows with Pieces. metaTitle: Quick Guides for Using Pieces | Pieces Docs metaDescription: Explore quick guides to get started with Pieces. Learn prompts, workflows and more to maximize your Pieces experience. ogImage: "https://storage.googleapis.com/hashnode_product_documentation_assets/og_images/quick_guides/quick_guides.png" @@ -15,7 +15,7 @@ ogImage: "https://storage.googleapis.com/hashnode_product_documentation_assets/o ## Why Use Quick Guides? -Pieces Quick Guides help you quickly understand and effectively utilize powerful features like the Long-Term (LTM-2.7) Memory Engine and Pieces Copilot. +Pieces Quick Guides help you quickly understand and use powerful features like the Long-Term (LTM-2.7) Memory Engine and Conversational Search. Capture context from your browser, summarize meetings with coworkers, find closed GitHub Issues from last month that were just mentioned in that Slack channel—*and that’s just the beginning.* @@ -30,24 +30,16 @@ Visit the links below to read Pieces Quick Guides on various topics, such as usi Capture and recall information from webpages with LTM to quickly retrieve important details. - - Reduce context switching and use Pieces Copilot to turn issues and tasks from your IDE or browser into actionable strategies. + + Reduce context switching and use Conversational Search to turn issues and tasks from your IDE or browser into actionable strategies. Unlock the potential of advanced prompting and access context from past activities through search filters for better results. - - Learn strategies to retrieve context, URLs, and detailed workflow memories accurately. - - - - Use the Pieces Workstream Activity View to capture, filter, and share workflow memories. - - - Browse typical user scenarios showcasing the versatility of LTM + Pieces Copilot in real-time. + Browse typical user scenarios showcasing the versatility of LTM + Conversational Search in real-time. @@ -55,10 +47,10 @@ Visit the links below to read Pieces Quick Guides on various topics, such as usi ## Ready to Explore? -Jump into any guide above by clicking its card and transform your daily development routine with Pieces! 🌟 +Jump into any guide above by clicking its card and transform your daily workflow with Pieces! 🌟 ## Additional Resources -If you're looking for more specific information, you can read comprehensive Pieces documentation on the [Pieces Desktop App](/products/desktop), the [Core Dependencies](/products/core-dependencies)—[PiecesOS](/products/core-dependencies/pieces-os) and [Ollama](/products/core-dependencies/ollama)—or any of our [plugins and extensions.](/products/extensions-plugins/visual-studio-code) +If you're looking for more specific information, you can read comprehensive Pieces documentation on the [Pieces Desktop App](/products/desktop), the [Core Dependency—PiecesOS](/products/core-dependencies/pieces-os)—or any of our [plugins and extensions.](/products/extensions-plugins/visual-studio-code) If you need help with a bug, [visit our Support page](/products/support) for links to our GitHub, links to our social media outlets, and for contacting our engineers. \ No newline at end of file diff --git a/public/content/raycast.md b/public/content/raycast.md index 9e77be9..ed48e91 100644 --- a/public/content/raycast.md +++ b/public/content/raycast.md @@ -80,11 +80,11 @@ These permissions are required for [PiecesOS](/products/core-dependencies/pieces PiecesOS will automatically open in your toolbar and pop up a *Notification preferences modal* in the upper right corner of your screen. -### Enabling the LTM-2 Engine +### Enabling the LTM-2.7 Engine To do this, open the PiecesOS Quick Menu and click `Enable Long-Term Memory Engine`. - + ## Install the Pieces for Raycast Extension diff --git a/public/content/web-extension/configuration.md b/public/content/web-extension/configuration.md index 451829c..694c9aa 100644 --- a/public/content/web-extension/configuration.md +++ b/public/content/web-extension/configuration.md @@ -64,7 +64,7 @@ Choose which language model powers Copilot in the extension (e.g. GPT‑4o Mini, Select the UI accent color used throughout the extension (Blue, Green, Purple, etc.). -### Use Long‑Term Memory (LTM-2) Context by Default +### Use Long‑Term Memory (LTM-2.7) Context by Default When checked, your saved long‑term memory is automatically included in every Pieces Copilot query without needing to re-enable LTM chat-by-chat. @@ -98,7 +98,7 @@ Choose how Pieces utilizes cloud and local LLMs to process context and power oth ### Long‑Term Memory Source Control -When generating context, choose which sources (chats, visited pages, etc.) the LTM-2 engine draws context from. +When generating context, choose which sources (chats, visited pages, etc.) the LTM-2.7 engine draws context from. This can also be done within the PiecesOS Quick Menu in the `Long-Term Memory Engine Access Control` panel.