# obsidian-agent

**Repository Path**: LXP-Never/obsidian-agent

## Basic Information

- **Project Name**: obsidian-agent
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-04-20
- **Last Updated**: 2026-04-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Obsidian Agent

> Obsidian 的 AI 写作助手 — 智能补全、指令续写、选中改写，不打断你的写作流。

---

## 功能

### ① 智能补全（Ghost Text）

按 `Alt`，光标后方出现灰色续写建议，`Tab` 接受，`Esc` 取消。

```
你正在写：AI 技术正在深刻改变教育行业，
                             ↑ 按 Alt
AI 技术正在深刻改变教育行业，通过个性化学习路径和实时反馈...
                             ↑ 灰色建议，Tab 接受
```

### ② 指令续写（`@` 触发）

输入 `@`，弹出对话框，描述你想写的内容，AI 生成后插入光标位置。

```
## 结论@
     ↑ 输入 @，弹出对话框
     → 输入"写一段总结性的结论"
     → 生成内容替换 @
```

### ③ 选中改写

选中文字 + `Alt`，告诉 AI 怎么改，确认后替换原文。内置快捷指令：润色、缩写、扩写、翻译、学术化。

---

## 支持的 AI 服务商

| 服务商 | 说明 |
|--------|------|
| LongCat | 默认，推荐新手使用 |
| 智谱 GLM | GLM-4-Flash 免费可用 |
| 通义千问 | 阿里云 Qwen 系列 |
| Kimi | 月之暗面，长上下文 |
| DeepSeek | 深度推理模型 |
| 豆包 | 字节跳动 |
| 文心一言 | 百度，需要 AppID + API Secret |
| 讯飞星火 | 需要 AppID |
| MiniMax | 通用对话 |

也支持任何兼容 **OpenAI 格式**的自定义接口。

---

## 安装

### 方式一：BRAT（推荐，获取最新版本）

1. 安装 [BRAT 插件](https://github.com/TfTHacker/obsidian42-brat)
2. BRAT → `Add Beta Plugin` → 填入本仓库地址
3. 启用 Obsidian Agent

### 方式二：手动安装

1. 从 [Releases](../../releases) 下载最新 `main.js`、`manifest.json`、`styles.css`
2. 复制到 `<你的 Vault>/.obsidian/plugins/obsidian-agent/`
3. 重启 Obsidian，在设置 → 社区插件中启用

---

## 快速开始

1. 打开 **设置 → Obsidian Agent**
2. 选择 AI 服务商，填入 API Key
3. 点击「测试连接」验证配置
4. 开始写作，按 `Alt` 触发补全

---

## 快捷键

| 操作 | 方式 |
|------|------|
| 触发智能补全 | `Alt`（可改为 `Ctrl` / `Cmd`）|
| 接受补全 | `Tab` |
| 取消补全 | `Esc` |
| 指令续写 | 输入 `@` |
| 选中改写 | 选中文字 + `Alt` |
| 开关补全功能 | 命令面板 → `Toggle autocomplete` |
| 改写选中文字 | 命令面板 → `Rewrite selected text` |

---

## 设置项

| 设置 | 说明 |
|------|------|
| AI 服务商 | 切换后自动填入默认接口地址 |
| API Key | base64 混淆存储，不明文写入配置文件 |
| 模型 | 手动输入或从预设选择 |
| API 地址 | 可覆盖默认接口，支持代理/私有部署 |
| 触发快捷键 | Alt / Ctrl / Cmd |
| 上下文深度 | 快速（当前行）/ 智能（推荐）/ 深度（更多上下文）|
| 最大 Token 数 | 每次生成的输出长度上限（50–500）|
| System Prompt | 补全、续写、改写三个功能各自可自定义提示词 |

---

## 隐私说明

- 插件**不收集任何数据**，不连接除你配置的 AI 服务外的任何服务器
- API Key 以 base64 混淆后存储在本地 Obsidian 配置文件，不做加密，请勿在他人设备上使用
- 请求内容（编辑器上下文）直接发送给你选择的 AI 服务商，受对方隐私政策约束

---

## 开发

```bash
# 克隆仓库
git clone https://gitee.com/LXP-Never/obsidian-agent.git
cd obsidian-agent

# 安装依赖
npm install

# 开发模式（监听文件变化）
npm run dev

# 构建生产版本
npm run build

# 运行测试
npm run test
```

**技术栈：** TypeScript · Obsidian Plugin API · CodeMirror 6 · Vitest

---

## 许可证

MIT