Configuration

Read the guide below to configure the Pieces for Obsidian Plugin to work efficiently in your workflow and adapt to your preferences.

Supported LLMs

We constantly update and configure our plugins and extensions, like the Pieces for Obsidian Plugin, to work with the latest LLMs.

Currently, the Pieces for Obsidian Plugin supports 26 different models:

GPT-3.5-Turbo	GPT-4	GPT-4-Turbo
GPT-4o	GPT-4o-mini	Gemini Pro Chat
Gemini 1.5 Flash	Gemini 1.5 Pro	Claude 3 Haiku
Claude 3 Opus	Claude 3 Sonnet	Claude 3.5 Sonnet
Code Chat Bison	Chat Bison	Mistral 7B
Phi-2	Phi-3 Mini 128k	Phi-3 Mini 4k
Llama 2 7B	Llama 3 8B	Gemma 1.1 7B
Gemma 1.1 2B	Code Gemma 1.1 7B	Granite 3B & 8B

Read documentation on how to switch your Pieces Copilot Runtime (LLM) utilized by the Pieces for Obsidian Plugin within your editor.

Opening Pieces Settings

To open the Pieces Settings in the Pieces for Obsidian Plugin, follow these steps:

Open Obsidian Settings

Open Obsidian settings by clicking the gear icon in the lower-left corner of the application.

Access Community Plugins

Navigate to the "Community Plugins" tab in the settings menu to access installed plugins.

Find the Plugin

Scroll through the list of plugins or use the search bar to locate "Pieces for Developers."

Open Plugin Settings

Once found, click the settings icon next to "Pieces for Developers" to open its configuration options.

Overriding Commands in Obsidian

If you’d like to adjust the keyboard shortcuts for the Pieces for Obsidian Plugin, such as saving a snippet or previewing markdown, follow these steps:

Open Settings

Access the settings menu in Obsidian by clicking the gear icon in the lower-left corner.

Go to Hotkeys

Navigate to the "Hotkeys" tab in the settings menu to view or customize command shortcuts.

Find the Command

Use the search bar to locate the specific command you want to override, such as commands for the "Pieces for Developers" plugin.

Customize the Shortcut

Click on the current shortcut next to the command and input your preferred key combination to override it.

Save Changes

Ensure the new shortcut is displayed and test it to confirm the override is successful.

Settings Overview

Below is a breakdown of each adjustable setting (preferences, behaviors, views, etc.) you can find in the Pieces for Obsidian Plugin, updated based on available features.

Snippet Preferences

Adjustable settings specific to saved materials, like code and text snippets, and other material-related action behavior.

Show Plugin Usage Tutorials

Displays useful information about using the Pieces for Obsidian Plugin.

Snippet Enrichment Levels

Choose how much metadata should be added to snippets when saved. Options include:

None: No enrichment
Low: Adds basic metadata
Medium: Adds intermediate metadata (3-6 pieces of data)
High: Adds extensive metadata (6+ pieces of data)

Auto-Open Pieces List on Snippet Save

Automatically opens the Pieces snippet list view after saving a snippet.

Confirm Double Enrichment

Enables a confirmation prompt if you attempt to enrich a code block that has already been processed.

Auto-Discover Snippets from Your Vault

Automatically scans your vault to discover snippets when opening Pieces.

Use Note Page Title for Saved Snippets

Assigns the title of your note to snippets you save.

Maximum Number of Snippets to Discover

Adjusts the maximum number of snippets Pieces will detect and display.

Cloud Capabilities

Choose the type of ML models for Pieces Copilot:

Cloud-based models
Local models (on-device)
Blended (a mix of both)

Pieces Server Port

Displays the port that PiecesOS is running on (default: 39300).

Allows you to log into PiecesOS to start generating shareable links for your code snippets.

For additional support resources, check out our troubleshooting guide.