# Hadesr AI · Obsidian 插件

在 Obsidian 里写作时，选中文字就浮出胶囊「✦ AI ▾」；停手就在光标后猜下一句。
不用打开侧边栏，也不打断你打字。

**English:** Hadesr AI is an Obsidian plugin for AI-assisted writing. Select text to rewrite, get inline completions, and run 16 built-in actions with OpenAI, Anthropic, or Google.

## 功能

| 功能 | 说明 |
|---|---|
| **选中即胶囊** | 选中文字，浮出 `✦ AI ▾`。用过一次之后，按钮直接变成你上次用的动作（仅内存记忆，关闭文档即清空） |
| **16 个动作** | 润色 / 纠错 / 精简 / 扩写 / 简化语言 / 专业 / 口语 / 解释 / 总结 / 续写 / 转表格 / 转列表 / 转代码块 / 提取待办 / 翻译成中文 / 翻译成英文 |
| **AI 划范围** | 「让 AI 找出并标记…」→ 说「所有提到 U 盘的段落」→ 自动标记，**只标记不改正文**，你确认后再执行。大文档走两段式：先发章节目录让 AI 挑相关节，再只送这几节正文定位，token 少 5~10 倍、首字更快 |
| **标记多段** | 选中一段点「标记此段」，重复标记多段（关掉 Obsidian 即清空）；之后在 **AI 对话**里直接发指令即可作用到全部标记段，失败项可单独重试 |
| **快速改写** | 选中一段 → 说一句「改得更简洁」→ 直接出结果，可先「对比原文」再决定替换 |
| **行内补全** | 停手 0.4 秒后光标处出「AI 思考中」，接着逐字吐灰字。`Tab` 采纳、`Esc` 忽略、继续打字自动消失 |
| **AI 对话** | 可拖动浮动面板，支持引用笔记、提示词模板、多轮追问 |
| **引用回链** | 结果底部列出「参考了哪几篇」，点一下直接跳过去 |
| **差异预览** | 点「替换」之前逐行看清改了哪几行；可「复制改动行」只取变化部分 |
| **对话历史** | 自动记录「提问 + 回答」（不含正文），可在对话框「历史」里回看并继续 |
| **存为笔记** | 结果卡片一键把生成内容存成一篇新笔记（放当前笔记同目录） |
| **提示词可改** | 16 个内置动作的提示词都能改（带搜索框），随时恢复默认 |
| **转 Canvas** | 把当前笔记整理成 `.canvas`，自动分层排布 |
| **添加笔记属性** | 自动生成 title / summary / tags 写进 frontmatter |
| **三种接口格式** | OpenAI / Anthropic / Google，可自由添加多个，可为每个动作单独指定 |

## 界面预览

选中文字后浮出胶囊，`▾` 展开动作菜单：

![选中文字后的动作菜单](docs/bubble-menu.png)

## Installation

### From the community directory
1. Open **Settings → Community plugins**.
2. Turn off Restricted mode, choose **Browse**, search **Hadesr AI**, install, and enable.

### Manual installation
Copy `main.js`, `manifest.json`, and `styles.css` into `.obsidian/plugins/hadesr-obai/`, then enable **Hadesr AI**.

### 方式一：社区插件市场

`设置` → `第三方插件` → 关闭安全模式 → `浏览` → 搜索 **Hadesr AI** → 安装 → 启用。

### 方式二：Git / 手动安装

```bash
git clone https://github.com/Hadesls/Hadesr-obai.git
```

把仓库里的 `main.js`、`manifest.json`、`styles.css` 放进：

```
<你的笔记库>/.obsidian/plugins/hadesr-obai/
```

然后在 Obsidian → `设置` → `第三方插件` → 关闭安全模式 → 启用 **Hadesr AI**。

> 也可以直接在 GitHub 仓库页点 **Code → Download ZIP**，解压后取那三个文件。
>
> 目录名必须是 `hadesr-obai`，与 `manifest.json` 里的 `id` 一致，否则加载不了。

## 第一次配置

设置 → Hadesr AI → **接口与模型**：

1. 填 API 地址（例如 `https://api.deepseek.com/v1`）、模型名、Key
2. 点「获取模型」拉列表，或选「✑ 手动输入…」
3. 点「测试连接」验证

支持本地服务（Ollama / vLLM / LM Studio 等），Key 可留空。

## Usage

**English:** Select text to open the action bubble. Pick an action or ask in AI chat. Press `Tab` to accept an inline completion.

最短路径：

1. **选中文字** → 浮出 `✦ AI ▾`；
2. 点主按钮 = 上次用过的动作；点 `▾` 换动作（润色 / 纠错 / 精简 / 扩写…）；
3. 想自由指令：`▾` → **快速改写…** → 输入要求；
4. 行内补全：停手 0.4 秒出灰字，`Tab` 采纳、`Esc` 忽略；
5. AI 对话：文档右上角 ✨。

### 常用入口

| 想做什么 | 怎么做 |
|---|---|
| 改一段文字 | 选中 → 胶囊主按钮，或 `▾` 换动作 |
| 自由指令改写 | 选中 → `▾` → **快速改写…** |
| 打开 AI 对话 | 文档右上角 ✨（编辑/阅读按钮左边） |
| 开/关行内补全 | 命令面板「行内补全：开 / 关」 |
| 手动补一次 | 命令面板「行内补全：现在补一次」 |

所有命令都可在「设置 → 快捷键」里自行绑定。

## 隐私

- **API Key 只存在你本机的 `data.json`**，用 RC4 + base64 做了**混淆**（防随手一看，不是加密）。
- 除调用你自己的接口外，不向任何第三方发送数据；无统计、无上报。
- 唯一的网络行为就是把你选中的文本/上下文发给你配置的那个 API。

## 移动端

核心逻辑与平台无关，已做触摸适配（点外面关闭、加大点击区域）。
行内补全使用 Obsidian 编辑器提供的能力；移动端如果该能力不可用，补全会自动关闭，其余功能正常。

## 已知限制

- 行内补全使用 Obsidian 编辑器提供的能力；当前环境不支持时会自动关闭补全，其余功能不受影响。
- 推理模型（会输出 thinking 的）在**非流式**下可能把 `max_tokens` 全用在思考上、正文为空 —— 补全会自动关思考（`reasoning_effort: none` 等三种写法依次尝试）。

## License

MIT © 2026 Hadesr