1. 安装 Android App

从下载页获取 APK,打开文件并按 Android 系统提示安装。已安装的用户更新前请保留原 App 与本地数据。

2. 准备自己的 Server

需要一台可运行 Sprout Server 的服务器和可访问的 HTTPS 地址。官网域名与个人 Server 地址是两个入口:请勿把这个官网地址当作你的笔记 Server。

完整部署步骤已公开在 Sprout 仓库 README,包括 Go 构建、配置文件、数据目录、systemd、DNS 和 Caddy HTTPS。

3. 连接手机

在实际 Server 项目根目录执行:

./sprout-server -connection-qr https://app.example.com

把示例地址替换成自己的 HTTPS Server 地址。使用 App 扫描连接二维码,验证连接后保存;也可以手动填写 Server URL 与 API Key。

Server URL 使用服务根地址,例如 https://app.example.com,不要追加 /api/v1。二维码携带连接信息,请勿公开分享。

4. 验证第一次同步

在手机记录一句测试内容并保存,再下拉同步,确认“未同步”状态消失。用移动网络验证文字、图片、编辑与删除,不能只凭“Server 已连接”判断记录已上传。

切换到新 Server 不会自动搬迁旧服务的数据;修改旧记录可能遇到 note_not_found。保留原服务与本地数据,再确认迁移方案。

5. 可选:让 CLI 接入你的工作目录

CLI 当前支持 macOS / Linux,需要 Node.js ≥ 22.14.0。安装不需要 npm 账号:

npm install -g @sprout-native/cli@0.6.0
sprout describe --json

授权、标签与同步示例见从 #读书 到 AI 工作流。CLI 不要求输入 App API Key,通过手机审批授权。

常见问题

已连接,但还有“未同步”

先检查网络与同步错误。连接检测只验证当前 Server 是否可访问,记录和附件仍需完成同步。保留数据并通过微信反馈,附上错误信息与复现步骤。

App 删除后,CLI 本地副本会消失吗?

App 删除同步到 Server 后,未同步过的笔记不会被 CLI 新下载;之前已经下载的笔记会停止更新,但本地文本和附件会保留。回收站恢复后,符合订阅标签的记录可以重新同步。

没有自己的 Server 可以用吗?

App 可以本地记录;把数据上传到自己的服务或通过 CLI 同步,需要先完成个人 Server 部署与连接。当前不提供默认公共云账户。