NoteFast

快速上手

桌面端下载、Docker 自托管、源码运行——三种方式在几分钟内跑起 NoteFast。

NoteFast 有三种使用形态：桌面应用（macOS / Windows，内嵌本地引擎）、Docker 自托管服务、以及从源码运行。三者共享同一套引擎与数据格式，知识库可以在形态之间自由迁移。

下载桌面应用（最简单）

从 GitHub Releases 获取最新安装包：

  • macOS — 签名并公证的 DMG，内嵌本地引擎，无运行时依赖
  • Windows — Tauri 构建的 NSIS 安装包，或免安装的便携 zip

应用会在 127.0.0.1 启动本地引擎，所有数据存放在用户数据目录下。无需账号，无需云端。

Windows 便携版

不想安装（例如 U 盘或只读目录）时，下载 NoteFast-<version>-portable-windows.zip，解压到任意位置运行 notefast.exe 即可。数据保存在同级 data/ 目录——整个文件夹就是你的便携知识库，复制、移动、备份都只是搬动文件夹。便携版不自动更新，需要升级时下载新 zip 即可。

其原理：zip 内含一个 notefast-portable 标记文件，程序启动时检测到标记便把用户数据路由到 <exe>/data/ 而非 %APPDATA%。同一个二进制，两种存储模式，由运行环境决定。

Docker 自托管

docker compose up -d

然后打开 http://localhost:3140。在把服务暴露到任何网络之前，请先设置 AUTH_PASSWORD 和 API_TOKEN——详见部署与安全。

从源码运行（开发）

bun install
bun --filter @notefast/server dev     # API + MCP，端口 3140
bun --filter @notefast/web dev        # Web UI，端口 5173

仓库是 bun workspace monorepo：

notefast/
├── packages/
│   ├── core/          # 共享类型、块模型、markdown↔block、AI 配置
│   ├── server/        # REST API（Hono）、MCP server、AI 引擎、同步与备份
│   └── web/           # React 读写界面
└── clients/
    ├── apple/         # macOS（SwiftUI + WKWebView，内嵌引擎）
    └── tauri/         # Windows（Tauri）

常用校验命令：

bun lint              # oxlint
bun run typecheck     # 严格 TypeScript
bun test              # 800+ 测试

下一步