J Joplin中文站

第 9 章 · 命令行与自动化

适用版本:Joplin 3.x

本章介绍命令行、API、外部编辑器与 Docker 自托管 Joplin Server 的进阶用法。

1. Joplin 命令行工具

Joplin CLI 是文本界面客户端,可在服务器或终端使用:

joplin ls          # 列出所有笔记本
joplin mknote "示例笔记"
joplin sync

CLI 支持创建、编辑、搜索、同步与导出,脚本环境适合自动化任务;通过 joplin config 可以修改配置项。命令行还支持导入导出、批量标签操作与笔记归档,是脚本化备份的首选工具。配合脚本可以实现笔记的自动归档与定期清理;通过脚本定时执行备份,可以进一步降低数据丢失风险。更多命令见 命令行教程 与 进阶玩法。

2. 外部编辑器

在「设置 → 通用」指定外部编辑器(如 VS Code、Typora),在笔记上右键「在外部编辑器中打开」,保存后 Joplin 自动同步更新。外部编辑器适合长文写作,配合 Git 版本管理可以进一步追踪每次修改。外部编辑器保存后,Joplin 会检测文件变化并自动导入,无需手动刷新。

3. Joplin API

本地 HTTP API 默认端口 41184,需在「设置 → 网络」启用并设置访问令牌。可用来实现自动化导入(如 RSS 转笔记)、与其他工具联动及开发插件。通过 API 可以读取笔记列表、创建笔记、上传附件,几乎所有图形界面操作都有对应的 API 方法。API 令牌应保存在环境变量或密钥管理器中,不要写入代码仓库。API 支持 REST 风格接口,官方提供了 Python 与 JavaScript 客户端库,详情见 API 文档。

4. Docker 自托管 Joplin Server

自托管让数据完全自控,但需要准备域名、HTTPS 证书与 Docker 环境。完整的部署步骤(Docker Compose 编排、反向代理、PostgreSQL 备份)见 自托管 Server 部署教程,这里只做概览:Joplin Server 支持 PostgreSQL 与 SQLite 两种数据库,部署后在客户端「设置 → 同步」选「Joplin Server」,填入服务器地址、邮箱与密码即可。数据卷建议挂载到独立磁盘,方便备份迁移;定期检查自托管服务的磁盘占用与备份状态,确保数据安全。

5. 自动化与批处理

用脚本批量转换 Markdown 并调用 API 导入 Joplin;配合 cron 或任务计划程序定时执行同步、导出备份等任务。常用自动化包括 cron 定时导出 JEX、API 导入 RSS、脚本批量整理标签等,建议先在测试环境验证脚本再接入正式数据。定期执行可降低数据风险。

自托管 Joplin Server 需要什么配置?

官方推荐 1 核 1GB 内存,需要 Docker 环境与一个 HTTPS 域名,数据库可用 PostgreSQL 或 SQLite。

API 令牌泄露了怎么办?

在「设置 → 网络」中重新生成访问令牌,旧令牌会立即失效;同时检查是否有异常写入。

自动化脚本建议先在测试笔记上运行,确认输出符合预期后再批量执行,避免误操作影响数据。