ITADN
opennote-org/opennote
opennote-org/opennote · 文件 下载 ZIP
文件最后提交记录最后更新时间
README.md
以下内容由 AI 翻译,如有问题请点此提交 issue 反馈

OpenNote

一款基于块状结构、由 AI 驱动的笔记应用,支持语义搜索 —— 完全使用 Rust 构建。

状态:重度开发中 — API、架构和工作流正在快速演进。欢迎贡献、反馈和实验性使用。

App Screenshot

功能

  • 关键词与语义搜索 — 即时查找笔记,或让您的文档回答您的问题。
  • 完全本地化 — 所有操作均在您的机器上运行。您的数据保持私密。
  • 自托管服务器 — 您可以选择运行自托管服务器,通过加密通信在所有设备间同步数据。
  • 所见即所得 Markdown 编辑器 — 实时编辑和渲染您的 markdown。
  • 极速 — 从底层为性能而构建。

路线图

  • 用于通过加密通信在设备间同步文档的自托管服务器
  • 所见即所得 markdown 编辑器集成
  • 高级 NLP 功能以简化文档管理(例如,按语义相似度自动分类)
  • LLM 集成 — 始终本地优先
  • MCP 服务器支持
  • 导入网页、数据库和文件
  • 多模态支持

快速开始

  1. 访问 Releases 页面
  2. 下载适用于您的操作系统的压缩包。
  3. 解压压缩包。
  4. 双击启动应用程序。
  5. 享受吧!

对于 mac 用户:我还没有 Apple Developer Account,因此无法对 mac 应用进行代码签名。您可能需要在将应用文件粘贴到 Applications 文件夹后,在终端中运行以下命令:

对于首次安装:应用程序默认会尝试从 https://huggingface.co 下载 models--sentence-transformers--all-MiniLM-L6-v2。然而,如果官方网站失败,它将切换到使用镜像站点,即 https://hf-mirror.com

sudo xattr -r -d com.apple.quarantine /Applications/opennote.app

配置桌面应用

您可以通过其 configurations.json 来配置 OpenNote。它可以在以下位置找到:

# on macOS
"/Users/yourusername/Library/Application Support/opennote/configurations.json"

# on Linux
"/home/yourusername/.config/opennote/configurations.json"

# on Windows
"C:\Users\Alice\AppData\Roaming\opennote\configurations.json"

不过,你也可以通过按下 macOS 上的 CMD + ;,或 Windows 和 Linux 上的 Ctrl + ; 来打开配置编辑器。

设置远程服务器

你可以托管一个远程服务器,以安全地在不同计算机之间进行同步。为此,请参阅 opennote-server 的 README.md

贡献

OpenNote 正处于积极开发阶段,欢迎各种形式的贡献——错误报告、功能建议、代码、文档和设计。

  • 在 GitHub 上提交 issue 和 pull request
  • 探索源代码中的 crate 文档
  • 带着问题或想法联系我们

致谢

感谢本项目中使用的所有库。完整列表见 Cargo.toml 以及每个子 crate 的 Cargo.toml

感谢 appify 将可执行文件打包为 macOS 应用。

感谢 sqlite 实现关系型数据库的本地化。

感谢 sqlite-vector 实现向量存储的本地化。

感谢 velotype 提供所见即所得的 Markdown 编辑器。

许可证

MIT — 详见 LICENSE

本项目包含源自 Zed 的代码,遵循 Apache 2.0 许可证 — 详见 NOTICE.md