# NoteFerry Companion

**Bring your Obsidian notes and attachments straight into ChatGPT, Claude, or Gemini.**

<p align="center">
  <img src="assets/noteferry-demo.gif" width="800" alt="NoteFerry demo: add Obsidian notes and attachments to an AI chat">
</p>

`+` → **Add from Obsidian** → select → **Add to ChatGPT / Claude / Gemini**

Tired of manually copying and pasting your notes (and hunting down attachments) every time you want to ask AI a question? NoteFerry solves this. 

This plugin acts as a secure local bridge. When paired with the **NoteFerry browser extension**, it lets you directly select and pull your Obsidian notes right from the input box of ChatGPT, Claude, or Gemini. 

> ⚠️ **Important:** This plugin is only half of the magic! Enabling it won't add a new chat window or sidebar inside Obsidian. To use it, you must install the browser extension.

## 🚀 Getting Started (3 Quick Steps)

1. **Get the Extension**: Open [noteferry.dev](https://noteferry.dev) and install the NoteFerry browser extension.
2. **Connect**: Click the NoteFerry icon in your browser toolbar and select **Connect Obsidian**. (Click **Allow** when Obsidian prompts you).
3. **Start Chatting**: Open ChatGPT, Claude, or Gemini. Click the new **+** menu in the chat box and choose **Add from Obsidian**. 

## 🔒 Privacy & Security First

Your second brain is private. We keep it that way.
- **Read-only**: NoteFerry only reads the specific notes and attachments you manually choose to add. It **cannot** edit or delete your files.
- **No Cloud, No Telemetry**: The connection happens entirely locally on your computer between Obsidian and your browser. 
- **You are in control**: Your notes never leave your machine until the exact moment you add them to your active AI chat. You can disconnect at any time in **Settings → NoteFerry Companion**.

## 💬 Support & Links
- [Installation Guide](https://noteferry.dev/install)
- [Help Center](https://noteferry.dev/help)
- [Privacy Policy](https://noteferry.dev/privacy)
- [Contact Us](https://noteferry.dev/contact)

---

## 🇨🇳 简体中文说明

**将 Obsidian 笔记直接带入 AI 对话。**

每次想让 AI 帮你看篇笔记，都要在 Obsidian 和网页之间来回切换、复制正文、甚至还要一张张找图片附件？NoteFerry 就是为了解决这个痛点而生的。

本插件是一个安全的本地桥梁。搭配 **NoteFerry 浏览器扩展** 使用，你就能在 ChatGPT、Claude 或 Gemini 的输入框旁边，直接选定并提取你的 Obsidian 笔记。

> ⚠️ **请注意：** 这个插件只是 NoteFerry 的一半！仅仅在 Obsidian 里启用它，**不会**在你的库里额外生成对话框或侧边栏。你需要安装浏览器扩展才能体验完整功能。

### 🚀 快速开始（只需三步）

1. **安装扩展**：前往 [noteferry.dev/zh](https://noteferry.dev/zh) 安装 NoteFerry 浏览器扩展。
2. **建立连接**：点击浏览器工具栏的 NoteFerry 图标，选择「连接 Obsidian」，并在 Obsidian 弹窗中点击「允许」。
3. **开始使用**：打开 ChatGPT、Claude 或 Gemini。点击输入框旁的 **+** 菜单，选择「从 Obsidian 添加」，即可轻松调取笔记。

### 🔒 绝对的隐私与安全

你的数字花园属于你自己，我们绝不越界。
- **只读且克制**：插件只读取你主动选中的那篇笔记和附件。它**绝对不会**修改或删除你的任何文件。
- **不传云端，没有遥测**：所有的连接都在你自己的电脑本地完成（Obsidian ↔ 浏览器）。我们没有账号系统，也不收集你的使用数据。
- **完全可控**：只有当你确认将笔记加入对话框的那一刻，内容才会离开这台电脑。你随时可以在 **设置 → NoteFerry Companion** 中断开授权。

[查看安装页](https://noteferry.dev/zh/install) | [获取帮助](https://noteferry.dev/zh/help)

---

## 🇭🇰 繁體中文說明

**將 Obsidian 筆記直接帶入 AI 對話。**

每次想讓 AI 幫你看篇筆記，都要在 Obsidian 和網頁之間來回切換、複製正文、甚至還要一張張找圖片附件？NoteFerry 就是為解決這個痛點而生的。

本外掛是一個安全的本地橋樑。搭配 **NoteFerry 瀏覽器擴充功能** 使用，你就能在 ChatGPT、Claude 或 Gemini 的輸入框旁邊，直接選定並提取你的 Obsidian 筆記。

> ⚠️ **請注意：** 這個外掛只是 NoteFerry 的一半！僅僅在 Obsidian 裡啟用它，**不會**在你的庫裡額外產生對話框或側邊欄。你需要安裝瀏覽器擴充功能才能體驗完整功能。

### 🚀 快速開始（只需三步）

1. **安裝擴充功能**：前往 [noteferry.dev/zht](https://noteferry.dev/zht) 安裝 NoteFerry 瀏覽器擴充功能。
2. **建立連線**：點擊瀏覽器工具列的 NoteFerry 圖示，選擇「連線 Obsidian」，並在 Obsidian 彈跳視窗中點擊「允許」。
3. **開始使用**：打開 ChatGPT、Claude 或 Gemini。點擊輸入框旁的 **+** 選單，選擇「從 Obsidian 添加」，即可輕鬆調取筆記。

### 🔒 絕對的隱私與安全

你的數位花園屬於你自己，我們絕不越界。
- **唯讀且克制**：外掛只讀取你主動選中的那篇筆記和附件。它**絕對不會**修改或刪除你的任何檔案。
- **不傳雲端，沒有遙測**：所有的連線都在你自己的電腦本地完成（Obsidian ↔ 瀏覽器）。我們沒有帳號系統，也不收集你的使用數據。
- **完全可控**：只有當你確認將筆記加入對話框的那一刻，內容才會離開這台電腦。你隨時可以在 **設定 → NoteFerry Companion** 中斷開授權。

[查看安裝頁](https://noteferry.dev/zht/install) | [獲取說明](https://noteferry.dev/zht/help)

---

*This plugin is licensed under the [MIT License](LICENSE).*