@mseep/obsidian-agent-client 0.10.6

package/docs/usage/chat-export.md

@@ -0,0 +1,80 @@
+# Chat Export
+
+Save your conversations with AI agents for future reference.
+
+## Manual Export
+
+Click the **export button** in the chat header to export the current conversation.
+
+<p align="center">
+  <img src="/images/export.webp" alt="Export button in chat header" width="400" />
+</p>
+
+## Export Settings
+
+Configure export options in **Settings → Agent Client → Export**:
+
+| Setting | Description |
+|---------|-------------|
+| **Export folder** | Folder where chat exports will be saved (default: `Agent Client`) |
+| **Filename** | Template for filenames. Use `{date}` and `{time}` as placeholders |
+| **Frontmatter tag** | Tag added to exported notes (default: `agent-client`). Supports nested tags like `projects/agent-client` |
+| **Auto-export on new chat** | Automatically export when starting a new chat |
+| **Auto-export on close chat** | Automatically export when closing the chat view |
+| **Open note after export** | Automatically open the exported note |
+| **Include images** | Save images attached in messages (default: enabled) |
+| **Image location** | Where to save images: Obsidian's attachment folder, custom folder, or embed as Base64 |
+| **Custom image folder** | Folder path for images when using custom location |
+
+## Export Format
+
+Chats are exported as Markdown files with YAML frontmatter:
+
+```markdown
+---
+created: 2025-12-13T00:31:12
+agentDisplayName: Claude Code
+agentId: claude-agent-acp
+session_id: f95b4847-cb9c-441a-9f0b-08eb243ff5dd
+tags: [agent-client]  # Customizable in settings
+---
+
+# Claude Code
+
+## 0:31:12 - User
+
+@[[Agent Client Plugin]]
+Summarize this, please.
+
+
+---
+
+## 0:31:16 - Assistant
+
+### 🔧 Read File
+
+**Locations**: `/Users/rait09/Documents/dev_vault/Agent Client Plugin.md:0`
+
+**Status**: completed
+
+## Summary: Agent Client Plugin for Obsidian
+
+This is an Obsidian plugin that integrates AI coding agents (Claude Code, Codex, Gemini CLI) directly into your vault.
+...
+```
+
+## What Gets Exported
+
+- **Messages**: Full conversation history with timestamps
+- **Images**: Attached images (saved as files or embedded, based on settings)
+- **Tool calls**: Tool name, locations, status, and diffs
+- **Thinking**: Agent's reasoning (as collapsible callouts)
+- **Plans**: Task plans with status indicators
+- **Note mentions**: Auto-mention and manual mentions in `@[[note]]` format
+
+## Use Cases
+
+- **Documentation**: Keep records of conversations and decisions
+- **Learning**: Review agent explanations later
+- **Sharing**: Share solutions with others
+- **Debugging**: Reference what the agent did for troubleshooting

package/docs/usage/commands.md

@@ -0,0 +1,51 @@
+# Commands & Hotkeys
+
+All commands available in Agent Client. Open the command palette (`Cmd/Ctrl + P`) to access them, or assign keyboard shortcuts in **Settings → Hotkeys**.
+
+::: tip
+Commands operate on the **last focused chat view**. Click on a chat view to focus it before running a command.
+:::
+
+## Chat Commands
+
+| Command | Description |
+|---------|-------------|
+| **Open chat view** | Open the chat panel |
+| **Open new chat view** | Open an additional chat view |
+| **New chat** | Start a fresh conversation |
+| **Cancel current message** | Stop the agent's current response |
+| **Export chat** | Export the current conversation to a note |
+| **Toggle auto-mention** | Toggle auto-mention of the active note |
+| **Approve active permission** | Approve the current permission request |
+| **Reject active permission** | Reject the current permission request |
+| **Focus next chat view** | Move focus to the next chat view |
+| **Focus previous chat view** | Move focus to the previous chat view |
+
+## Broadcast Commands
+
+Control multiple chat views at once. See [Multi-Session Chat](/usage/multi-session) for details.
+
+| Command | Description |
+|---------|-------------|
+| **Broadcast prompt** | Copy the active view's input to all other views |
+| **Broadcast send** | Send messages in all views simultaneously |
+| **Broadcast cancel** | Cancel operations in all views |
+
+## Floating Chat Commands
+
+| Command | Description |
+|---------|-------------|
+| **Open floating chat view** | Open an existing floating window, or create one if none exist |
+| **Open new floating chat view** | Always create a new floating window |
+| **Minimize floating chat view** | Hide the focused floating window (session is preserved) |
+| **Close floating chat view** | Close the focused floating window and end the session |
+
+## Agent Commands
+
+| Command | Description |
+|---------|-------------|
+| **Switch agent to [Agent Name]** | Switch to a specific agent in the last active view |
+
+::: tip
+Agent-specific commands are generated automatically based on your configured agents.
+:::

package/docs/usage/context-files.md

@@ -0,0 +1,57 @@
+# Context Files
+
+Provide additional context to your AI agent using context files.
+
+## What are Context Files?
+
+Context files are special Markdown files that contain instructions, preferences, or information that the agent should know about. These files are automatically read by the agent at the start of a session.
+
+::: tip
+Context files are an agent feature, not a plugin feature. Refer to your agent's documentation for details.
+:::
+
+## Supported Context Files
+
+Each agent uses its own context file:
+
+| Agent | Context File |
+|-------|--------------|
+| Claude Code | `CLAUDE.md` |
+| Codex | `AGENTS.md` |
+| Gemini CLI | `GEMINI.md` |
+
+Place the context file in your **vault root** to have the agent read it automatically.
+
+## Example
+
+```markdown
+# Vault Context
+
+## Overview
+This vault contains my personal notes and research.
+
+## Preferences
+- Write in a concise, clear style
+- Use bullet points for lists
+- Prefer Markdown formatting
+
+## Important Notes
+- `Templates/` - Note templates
+- `Daily/` - Daily notes
+
+## Conventions
+- Use YYYY-MM-DD format for dates
+- Tag notes with relevant topics
+```
+
+## Best Practices
+
+1. **Keep it focused**: Include only relevant information
+2. **Update regularly**: Keep context current with your vault
+3. **Be specific**: Provide concrete examples and preferences
+
+## What to Avoid
+
+- Sensitive information (API keys, passwords)
+- Very long files (agents have context limits)
+- Outdated information

package/docs/usage/editing.md

@@ -0,0 +1,69 @@
+# Editing
+
+Agent Client allows AI agents to edit files in your vault and working directory.
+
+## How Editing Works
+
+When you ask the agent to modify files:
+
+1. The agent proposes changes
+2. You see the proposed edits in the chat
+3. The agent may request permission to apply changes
+4. Changes are applied to your files
+
+<p align="center">
+  <img src="/images/editing.webp" alt="Editing files with agents" width="400" />
+</p>
+
+## Permission Controls
+
+Some agents request permission before performing certain actions. When a permission request appears:
+
+1. Review the proposed action
+2. Select one of the available options provided by the agent
+
+::: tip
+Permission options vary by agent. Some agents may not request permission at all and edit files directly.
+:::
+
+### Auto-Allow Permissions
+
+In **Settings → Agent Client → Permissions → Auto-allow permissions**, you can automatically allow all permission requests from agents.
+
+::: warning
+Use with caution—this gives agents full access to your system without confirmation prompts.
+:::
+
+## Viewing Changes
+
+The chat displays file changes with:
+
+- **File path**: Which file was modified
+- **Diff view**: What was added/removed (when available)
+- **Status**: Success or failure of the operation
+
+### Auto-Collapse Long Diffs
+
+Large diffs can be automatically collapsed to keep the chat readable. This feature is **disabled by default**.
+
+| Setting | Default | Description |
+|---------|---------|-------------|
+| **Auto-collapse long diffs** | Off | Enable automatic collapsing of large diffs |
+| **Collapse threshold** | 10 lines | Diffs exceeding this line count are collapsed |
+
+Configure these in **Settings → Agent Client → Display**.
+
+Collapsed diffs can be expanded by clicking on them.
+
+## Best Practices
+
+1. **Use version control**: Keep your vault in Git before letting agents edit
+2. **Review changes**: Check diffs before confirming major modifications
+3. **Start small**: Test with minor edits before complex changes
+
+## Undo Changes
+
+If an agent makes unwanted changes:
+
+- Use **Editor**: Cmd/Ctrl+Z in the affected file
+- Use **Git**: `git checkout -- <file>` or `git restore <file>` (if your vault is version-controlled)

package/docs/usage/floating-chat.md

@@ -0,0 +1,84 @@
+# Floating Chat
+
+A persistent, draggable chat window that floats over your workspace. Perfect for quick conversations without leaving your current view.
+
+<p align="center">
+  <img src="/images/floating-chat-view.webp" alt="Floating chat window open over the editor" />
+</p>
+
+## Overview
+
+The Floating Chat provides a lightweight alternative to the sidebar chat view:
+
+- **Draggable window** — move it anywhere on screen
+- **Resizable** — drag the edges to adjust size
+- **Collapsible** — hide the window without losing your session
+- **Multi-window** — open multiple floating windows simultaneously
+- **Independent sessions** — each window runs its own agent session
+
+::: tip
+Enable the floating chat in **Settings → Agent Client → Floating chat → Enable floating chat**.
+:::
+
+## Getting Started
+
+1. Enable **Enable floating chat** in settings
+2. A floating button appears in the bottom-right corner
+3. Click the button to open a chat window
+4. Start chatting — the window works just like the sidebar chat
+
+<p align="center">
+  <img src="/images/floating-chat-button.webp" alt="Floating button in the bottom-right corner" width="200" />
+</p>
+
+## Moving and Resizing
+
+- **Drag** the header bar to move the window
+- **Resize** by dragging the bottom-right corner of the window
+- Position and size are saved automatically
+
+## Multiple Windows
+
+Open more than one floating chat window to run parallel conversations.
+
+### Opening Additional Windows
+
+- Click **"Open new view"** from the **⋮** (More) menu in the floating window header
+- Or use the command **"Open new floating chat view"** from the command palette
+
+### Switching Between Windows
+
+When multiple windows exist, clicking the floating button shows an instance menu:
+
+<p align="center">
+  <img src="/images/floating-chat-instance-menu.webp" alt="Instance menu with multiple sessions listed" width="300" />
+</p>
+
+- Click a session name to expand that window
+- Click **×** to close a session
+
+::: tip
+The focused floating window is always displayed in front of other floating windows.
+:::
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| **Open floating chat view** | Open an existing floating window, or create one if none exist |
+| **Open new floating chat view** | Always create a new floating window |
+| **Minimize floating chat view** | Hide the focused floating window (session is preserved) |
+| **Close floating chat view** | Close the focused floating window and end the session |
+
+::: tip
+Assign keyboard shortcuts to these commands in **Settings → Hotkeys** for quick access.
+:::
+
+## Configuration
+
+Customize the floating chat in **Settings → Agent Client → Floating chat**:
+
+| Setting | Default | Description |
+|---------|---------|-------------|
+| **Enable floating chat** | Off | Enable the floating chat button and draggable chat windows |
+| **Floating button image** | Default icon | URL or vault path to a custom button image |

package/docs/usage/index.md

@@ -0,0 +1,97 @@
+# Basic Usage
+
+## Opening the Chat Panel
+
+You can open the Agent Client chat panel in two ways:
+
+- **Ribbon Icon**: Click the robot icon in the left ribbon
+
+<p align="center">
+  <img src="/images/ribbon-icon.webp" alt="Ribbon Icon" />
+</p>
+
+- **Command Palette**: Open the command palette (`Cmd/Ctrl + P`) and search for **"Open chat view"**
+
+The chat panel opens in the right sidebar.
+
+## Sending Messages
+
+1. Type your message in the input field at the bottom
+2. Press `Enter` or click the send button
+3. Wait for the agent's response
+
+<p align="center">
+  <img src="/images/sending-messages.webp" alt="Sending Messages"  width="400" />
+</p>
+
+## Sending Images and Files
+
+You can attach images and files to your messages by pasting or dragging and dropping.
+
+1. **Paste**: Copy a file or image and paste (`Cmd/Ctrl + V`) in the input field
+2. **Drag and Drop**: Drag files directly onto the input area
+
+Attached files appear as thumbnails or file icons below the text area. Click the **×** to remove.
+
+<p align="center">
+  <img src="/images/sending-images.webp" alt="Sending Images and Files" width="400" />
+</p>
+
+::: tip
+Embedding images requires agent support. Non-image files are always sent as file path references.
+:::
+
+See [Sending Images and Files](/usage/sending-images) for more details.
+
+## Switching Agents
+
+To switch agents for the current view:
+
+1. Click the **⋮** (ellipsis) menu in the chat header
+2. Under **"Switch agent"**, select the agent you want to use
+
+This is a one-time change for that view only.
+
+<p align="center">
+  <img src="/images/switch-agent.webp" alt="Switch agent menu" width="400" />
+</p>
+
+::: tip
+To change the default agent for new chat views, go to **Settings → Agent Client → Default agent**.
+
+<img src="/images/switch-default-agent.webp" alt="Default agent setting" />
+:::
+
+## Multiple Chat Views
+
+You can open multiple chat views to run independent conversations simultaneously. Each view has its own agent process and session.
+
+See [Multi-Session Chat](/usage/multi-session) for details on:
+- Opening multiple views
+- Broadcast commands
+- Focus navigation
+
+## Floating Chat
+
+A draggable, resizable chat window that floats over your workspace. Enable it in **Settings → Agent Client → Floating chat**.
+
+See [Floating Chat](/usage/floating-chat) for details.
+
+## Changing Models and Modes
+
+Below the input field, you'll find dropdowns to:
+
+- **Change Model**: Switch between different AI models (e.g., Sonnet, Haiku for Claude)
+- **Change Mode**: Switch agent modes (e.g., Plan Mode)
+
+::: tip
+Available models and modes depend on the active agent.
+:::
+
+## Starting a New Chat
+
+Click the **New Chat** button in the header to start a fresh conversation. The previous chat can optionally be exported (see Settings).
+
+## Stopping Generation
+
+If the agent is generating a response and you want to stop it, click the **Stop** button that appears during generation.

package/docs/usage/mcp-tools.md

@@ -0,0 +1,33 @@
+# MCP Tools
+
+AI agents can use Model Context Protocol (MCP) tools to interact with external services and perform specialized tasks.
+
+## What is MCP?
+
+The [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) is an open standard that allows AI agents to connect to external tools and data sources.
+
+::: tip
+MCP support and configuration depend on the agent. Refer to your agent's documentation for details.
+:::
+
+## How MCP Works
+
+When an agent uses an MCP tool:
+
+1. The agent decides which tool to use
+2. The tool call appears in the chat
+3. The tool executes and returns results
+4. The agent uses the results to continue
+
+## Viewing Tool Calls
+
+Tool calls are displayed in the chat with:
+
+- **Tool name**: What tool was used
+- **Status**: Running, completed, or failed
+
+## Permissions
+
+Some MCP tool calls may require your permission before executing. When a permission request appears, select one of the available options provided by the agent.
+
+See [Editing](/usage/editing#permission-controls) for permission settings.

package/docs/usage/mentions.md

@@ -0,0 +1,70 @@
+# Note Mentions
+
+Reference your Obsidian notes directly in conversations with AI agents.
+
+## Auto-Mention Active Note
+
+When enabled, the plugin automatically includes the currently active note in your message. This is useful when you want to discuss or work on the note you're viewing.
+
+Enable this in **Settings → Agent Client → Mentions → Auto-mention active note**.
+
+### How Auto-Mention Works
+
+Unlike manual mentions, auto-mention only passes the **note's file path** to the agent—not its full content. The agent can then use its Read tool to examine the file if needed.
+
+When auto-mention is active, a badge appears above the input field showing the current note name (e.g., `@My Note`).
+
+### Temporary Disable
+
+You can temporarily disable auto-mention for a single message by clicking the **×** button next to the badge. Click the **+** button to re-enable it. This toggle only affects the current message—auto-mention will be active again for subsequent messages.
+
+<p align="center">
+  <img src="/images/temporary-disable.gif" alt="Temporarily disabling auto-mention" />
+</p>
+
+### Selection Context
+
+If you select text in your note, the selected lines are passed as context to the agent. The badge will show the line range (e.g., `@My Note:5-10`), and the agent receives both the file path and the selected content.
+
+<p align="center">
+  <img src="/images/selection-context.gif" alt="Selection context feature" />
+</p>
+
+## Manual Mentions
+
+Use the `@` syntax to reference specific notes:
+
+```
+@[[My Note]]
+```
+
+As you type `@`, a dropdown appears with matching notes from your vault. Select a note to insert the mention.
+
+### How Manual Mentions Work
+
+When you send a message with manual mentions:
+
+1. The plugin reads the content of the mentioned notes
+2. The note content is included in the message sent to the agent
+3. The agent can then reference, analyze, or modify the note content
+
+## Length Limits
+
+To prevent excessively large messages, the plugin limits the amount of content included:
+
+| Setting | Default | Description |
+|---------|---------|-------------|
+| **Max note length** | 10,000 characters | Maximum characters per mentioned note |
+| **Max selection length** | 10,000 characters | Maximum characters for text selection in auto-mention |
+
+Configure these in **Settings → Agent Client → Mentions**.
+
+::: tip
+Content exceeding the limit is truncated with a note indicating the original length.
+:::
+
+## Tips
+
+- Use manual mentions to include specific notes as context
+- Mention multiple notes to give the agent a broader understanding
+- For large notes, consider selecting the relevant portion and using auto-mention instead

package/docs/usage/mode-selection.md

@@ -0,0 +1,28 @@
+# Mode Selection
+
+Some agents support different operational modes that change how the agent behaves.
+
+## What are Modes?
+
+Modes are predefined configurations that alter the agent's behavior for specific tasks. For example:
+
+- **Default Mode**: General-purpose assistance
+- **Plan Mode**: Focus on planning and architecture before implementation
+
+## Changing Modes
+
+1. Open the chat panel
+2. Look for the **mode dropdown** below the input field
+3. Select the desired mode from the available options
+
+<p align="center">
+  <img src="/images/mode-selection.webp" alt="Mode selection dropdown" width="400" />
+</p>
+
+::: tip
+Available modes depend on the active agent. Not all agents support multiple modes.
+:::
+
+## Mode Persistence
+
+The selected mode persists for the current session. Your preference is remembered across sessions.

package/docs/usage/model-selection.md

@@ -0,0 +1,32 @@
+# Model Selection
+
+Switch between different AI models to optimize for speed, capability, or cost.
+
+## What are Models?
+
+Models are different versions of the AI with varying capabilities:
+
+- **Larger models**: More capable, better reasoning, slower, higher cost
+- **Smaller models**: Faster responses, lower cost, good for simpler tasks
+
+## Changing Models
+
+1. Open the chat panel
+2. Look for the **model dropdown** below the input field
+3. Select the desired model from the available options
+
+<p align="center">
+  <img src="/images/model-selection.webp" alt="Model selection dropdown" width="400" />
+</p>
+
+::: tip
+Available models depend on the active agent and your subscription/API plan.
+:::
+
+## Model Persistence
+
+The selected model persists for the current session. Your preference is remembered across sessions.
+
+## Cost Considerations
+
+When using API keys, different models have different pricing. Check your provider's pricing page for current rates.

package/docs/usage/multi-session.md

@@ -0,0 +1,68 @@
+# Multi-Session Chat
+
+Run multiple independent agent conversations simultaneously.
+
+<p align="center">
+  <img src="/images/multi-session.webp" alt="Multiple chat views running simultaneously" />
+</p>
+
+## Overview
+
+Agent Client supports opening multiple chat views, each with its own:
+- Independent agent process
+- Separate session and message history
+- Individual agent selection
+
+::: tip
+This is useful when you want to work with different agents side-by-side, or run parallel conversations for different tasks.
+:::
+
+## Opening Multiple Views
+
+### Via Command Palette
+
+1. Open command palette (`Cmd/Ctrl + P`)
+2. Search for **"Open new chat view"**
+3. A new chat view opens in your configured location
+
+### Via Header Menu
+
+1. Click the **⋮** (ellipsis) menu in the chat header
+2. Select **"Open new view"**
+
+## Chat View Location
+
+Configure where new chat views open in **Settings → Agent Client → Display → Chat view location**:
+
+| Location | Description |
+|----------|-------------|
+| **Right pane (tabs)** (default) | Opens in the right sidebar |
+| **Editor area (tabs)** | Opens as a tab in the editor area |
+| **Editor area (split)** | Opens in a new split pane |
+
+## Broadcast Commands
+
+Control multiple chat views at once from the command palette:
+
+| Command | Description |
+|---------|-------------|
+| **Broadcast prompt** | Copy the active view's input text and images to all other views |
+| **Broadcast send** | Send messages in all views simultaneously |
+| **Broadcast cancel** | Cancel ongoing operations in all views |
+
+::: tip
+Broadcast commands are useful for comparing how different agents respond to the same prompt.
+:::
+
+## Focus Navigation
+
+Quickly switch between chat views:
+
+| Command | Description |
+|---------|-------------|
+| **Focus next chat view** | Move focus to the next chat view |
+| **Focus previous chat view** | Move focus to the previous chat view |
+
+::: tip
+Assign keyboard shortcuts to these commands in **Settings → Hotkeys** for faster navigation.
+:::