citeMind

KO | EN

gitlite — search

#python #javascript #php #c #ruby #hacktoberfest #java #blog #shell #css #c-plus-plus #arduino

★ 36 Open GitHub ↗

桌面端 RAG 知识库助手，支持文档导入、混合检索和带引用依据的可信问答。模型支持使用Seed API

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h1 align="center">CiteMind</h1>

> citeMind 是一个桌面端个人知识库助手。首版面向 macOS Apple Silicon，用户使用自己的火山方舟 Ark API Key，将 PDF、DOCX、图片和网页导入为可检索、可追踪来源的本地知识库。

![MainScreen](https://raw.githubusercontent.com/SanJin-09/citeMind/main/images/main_screen.png)

## 技术架构

## 本地数据

应用默认使用系统应用数据目录

```text
app.getPath("userData")
+-- credentials/
|   +-- seed-api-key.json
+-- originals/
+-- snapshots/
+-- parse-artifacts/
+-- backups/
+-- indexes/
|   +-- lancedb/
+-- metadata.sqlite3
```

## 快速开始

### 1. 准备环境

- macOS Apple Silicon
- Node.js 与 pnpm
- Python 3.12
- uv
- 可用的火山方舟 Ark API Key

### 2. 安装依赖

```bash
pnpm setup
```

### 3. 启动开发版

```bash
pnpm dev
```

### 4. 配置 Ark API

在应用右上角进入：

```text
设置 -> 配置火山方舟 Ark API -> 填写 Ark API Key -> 保存并验证
```

验证通过后，应用会展示默认对话、高质量对话和 Embedding 模型的权限状态。

### 5. 导入并索引资料

对于不同格式的文件，当前支持：

- PDF：页码 + bounding box 高亮信息
- DOCX：标题路径 + 段落锚点
- 网页：标题路径 + 快照文本块
- 图片：图片预览 + OCR 区域高亮信息

资料新增、替换或版本更新解析成功后会自动构建索引，无需手动触发；索引完成后通过后台任务事件自动刷新资料可用状态。

### 6. 对话与执行追踪

用户发送问题后，消息会立即显示在对话区右侧，左侧同步出现 `思考回复中...`。当前轮 AgentRun 会在回答上方实时追加执行阶段、Skill、命令和输出摘要；回答完成后自动折叠为 `已执行 [执行用时] >`，点击可重新查看完整记录。

包含证据的回答在相关句尾显示数字引用。点击编号后，右侧 `来源与证据` 栏会切换到对应文档、位置和原文片段，不再在回答底部堆叠来源卡片。

## 你可能会用到的命令

| 命令                   | 作用                                            |
| ---------------------- | ----------------------------------------------- |
| `pnpm setup`           | 安装 JS 依赖、同步 Python Worker、安装 Electron |
| `pnpm dev`             | 启动 Electron 开发环境                          |
| `pnpm build`           | 构建桌面端                                      |
| `pnpm build:mac`       | 生成 macOS arm64 安装包                         |
| `pnpm verify:delivery` | 验证安装、异常退出、升级、卸载和数据保留        |
| `pnpm format`          | 格式化 TypeScript 与 Python 代码                |
| `pnpm lint`            | 运行 ESLint 与 Ruff                             |
| `pnpm typecheck`       | 运行 TypeScript 与 mypy 类型检查                |
| `pnpm test`            | 运行 Vitest 与 pytest                           |
| `pnpm check`           | 运行格式检查、lint、类型检查、测试和构建        |

## 开发目录

```text
.
+-- apps/
|   +-- desktop/                 # Electron + React 桌面端
|       +-- src/main/            # Electron Main，密钥与 Worker 管理
|       +-- src/preload/         # 受限 IPC 暴露
|       +-- src/renderer/        # React UI
|       +-- src/shared/          # 前后端共享契约
+-- worker/
|   +-- src/citemind_worker/     # Python Worker
|   +-- tests/                   # Worker 单元与集成测试
+-- TODO.md                      # 阶段任务清单
+-- rag-personal-knowledge-base-product-and-architecture.md
```

## 安全边界

- [x] `contextIsolation` 开启。
- [x] `nodeIntegration` 关闭。
- [x] Renderer 只能访问白名单 IPC。
- [x] Renderer 无法直接读取 Ark API Key。
- [x] Ark API Key 使用 Electron `safeStorage` 加密保存。
- [x] 日志脱敏 Ark/API Key。
- [x] 本地数据默认保存在系统应用数据目录。

## 测试覆盖

当前测试覆盖方向：

- JSON-RPC 请求、响应、错误与超时
- Worker 健康检查
- SQLite 迁移与快照
- FTS5 与 LanceDB 最小读写
- Seed 模型目录、Key 隔离与能力验证状态
- 知识库管理
- BackgroundJob 状态机、恢复与 `jobs.updated` 通知
- AgentRun 持久化、Trace 事件与执行快照
- PDF / DOCX / 图片 / 网页导入解析
- 解析成功后的自动索引与失败反馈
- 对话即时消息、引用编号与来源证据映射
- 分块、Embedding、FTS5、LanceDB 索引写入

citeMind

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README