# 灵犀忆记

**Repository Path**: work-ai/htools

## Basic Information

- **Project Name**: 灵犀忆记
- **Description**: **灵犀忆记**（MemoLeaf）是一款开源的 AI 记忆助手：帮你快速记录笔记、密码与待办，本地 AES 加密，可选 Git 私有仓库多设备同步，AI 智能整理与创作。
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-04-30
- **Last Updated**: 2026-08-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 灵犀忆记 MemoLeaf 🌿

> 心有灵犀 · AI 助忆 — 本地加密笔记 · 密码管理 · 待办 · Git 多设备同步

<p align="center">
  <img src="public/logo.png" alt="灵犀忆记" width="96" />
</p>

**灵犀忆记**是一款开源的桌面记忆助手。笔记、密码、待办全部 **AES-256 本地加密**，支持同步到 **私有 Git 仓库** 实现多设备备份；内置 **AI 助手**，可智能选取相关笔记与待办，帮你整理周报、摘要与创作。

| | |
|---|---|
| 🔒 **隐私优先** | 数据仅存本机，加密后再进 Git |
| ☁️ **Git 同步** | GitHub / Gitee / GitLab 私有仓库 |
| ✨ **AI 加持** | 自动检索相关笔记，一键生成内容 |
| 🖥️ **跨平台** | macOS · Windows（Electron） |

---

## 📸 界面预览

<p align="center">
  <img src="docs/screenshots/02-notes.png" alt="笔记编辑" width="720" />
  <br />
  <em>加密笔记 — Markdown 编辑，侧栏快速切换</em>
</p>

<table>
  <tr>
    <td width="50%">
      <img src="docs/screenshots/01-lock.png" alt="主密码解锁" />
      <br />
      <sub>主密码解锁，一钥保护全部数据</sub>
    </td>
    <td width="50%">
      <img src="docs/screenshots/03-todos.png" alt="待办任务" />
      <br />
      <sub>待办管理 — 优先级、日历热力图</sub>
    </td>
  </tr>
  <tr>
    <td>
      <img src="docs/screenshots/04-ai.png" alt="AI 创作" />
      <br />
      <sub>AI 创作 — 智能选取笔记/待办生成内容</sub>
    </td>
    <td>
      <img src="docs/screenshots/05-settings.png" alt="设置" />
      <br />
      <sub>Git 同步与 AI 配置</sub>
    </td>
  </tr>
</table>

> 重新生成截图：`npm run screenshots`

---

## ✨ 功能特性

- **📝 加密笔记** — 每条笔记独立加密文件，多设备编辑不冲突
- **🔑 密码管理** — 每个账号独立加密，支持一键复制
- **✅ 待办任务** — 任务管理 + 活动日历热力图 + 完成统计
- **✨ AI 创作** — 智能选取相关笔记/待办，生成内容并保存或导出
- **☁️ Git 同步** — 加密数据同步到私有 Git 仓库，智能合并
- **🔒 主密码保护** — 单一主密码解锁所有数据
- **🖥️ 系统托盘** — 菜单栏快捷访问，快速添加待办

## 🚀 快速开始

### 环境要求

- Node.js >= 18
- npm >= 9

### 开发模式

```bash
git clone https://gitee.com/work-ai/htools.git
cd htools
npm install
npm run dev
```

会自动打开 **灵犀忆记** 桌面窗口（请使用 Electron 窗口，不要用浏览器访问 localhost）。

### 打包安装

```bash
npm run build
```

| 平台 | 输出文件 |
|------|----------|
| macOS | `dist-electron/灵犀忆记-1.0.0-arm64.dmg` |
| Windows | `dist-electron/灵犀忆记 Setup 1.0.0.exe`（需在 Windows 上打包） |

> 安装包体积主要来自 Electron 运行时（约 200MB+）。重新打包前可运行 `npm run icons` 生成图标。

### 启动失败排查

若 `npm run dev` 报错 `spawn Electron ENOENT`：

```bash
node node_modules/electron/install.js
npm run dev
```

---

## 📱 新设备恢复数据

1. 安装并打开 **灵犀忆记**
2. 首次启动选择 **「从 Git 恢复」**
3. 填入 Git 仓库地址（与旧设备相同）
4. 输入**旧设备的主密码**
5. 点击 **「拉取并解锁」**

> 主密码必须与旧设备一致，Git 地址指向同一仓库。

---

## ☁️ Git 同步

解锁后进入 **设置**：

- **Git 仓库地址** — GitHub / GitLab / Gitee 私有仓库
- **分支名** — 默认 `main`
- **自动同步** — 默认定时 3 分钟推送

HTTPS 建议使用 Personal Access Token。

---

## ✨ AI 配置

在 **设置 → AI 配置** 填写 API Key、地址与模型，点击 **测试 AI 连接** 验证。

侧栏 **AI** 标签：输入指令后，系统会先分析意图、自动选取相关笔记与待办，再生成内容。可存为笔记或导出 Markdown / PDF。

> ⚠️ AI 请求会发送选中的笔记/待办内容到 API 服务商，请勿将密码库用于 AI。

---

## 📁 数据存储

```
~/.memoleaf/
├── vault/
│   ├── notes/{id}.enc
│   ├── passwords/{id}.enc
│   └── todos.enc
├── config.json    # 本地配置（含 AI Key，不进 Git）
└── .git/
```

> ⚠️ 主密码丢失后无法恢复数据。

---

## 🖥️ 技术栈

- React 18 + TailwindCSS + Vite
- Electron 29
- AES-256-GCM + PBKDF2
- simple-git

---

## 🤝 开源与贡献

本项目采用 [MIT License](LICENSE) 开源，欢迎 Fork、Issue 和 Pull Request。

### 参与贡献

1. Fork 本仓库
2. 创建分支：`git checkout -b feature/your-feature`
3. 提交改动：`git commit -m "描述你的改动"`
4. 推送并发起 Pull Request

### 仓库地址

- Gitee：https://gitee.com/work-ai/htools

### 安全说明

- 请勿提交 `.env`、`config.json` 或任何 API Key
- 加密实现见 `electron/main.js`，欢迎安全相关 Issue

---

## 📄 License

MIT © [李德胜](LICENSE)