Joplin CLI 技能

使用 joplin CLI 工具与 Joplin 笔记交互。

⚠️ 重要提示：请使用 CLI，不要直接操作 SQL

请使用 joplin CLI 编辑笔记。避免直接修改 SQLite 数据库——这可能导致同步冲突和数据丢失。

配置

若 Joplin 尚未配置 WebDAV，请按以下方式配置：

joplin config sync.target 6
joplin config sync.6.path "https://your-webdav-server/path"
joplin config sync.6.username "your-username"
joplin config sync.6.password "your-password"
joplin sync

常用命令

列出笔记本与笔记

joplin ls                          # 列出所有笔记本
joplin ls "Notebook Name"          # 列出指定笔记本中的笔记
joplin status                      # 显示同步状态及笔记数量
joplin ls -l                       # 以包含 ID 的格式列出

读取笔记

joplin cat                # 显示笔记内容
joplin cat "Note Title"            # 也可使用标题查找并显示
joplin note               # 在编辑器中打开该笔记

创建笔记

joplin mknote "Note Title"         # 在默认笔记本中创建笔记
joplin mknote "Note Title" --notebook "Notebook Name"
joplin mkbook "New Notebook"       # 创建新笔记本

提示：可向用户询问要使用的笔记本。可使用以下命令：

• joplin use — 查看当前选定的笔记本
• joplin use "Notebook Name" — 切换到指定笔记本
• joplin ls — 查看所有笔记本

编辑笔记

joplin edit --note        # 在编辑器中编辑笔记
joplin set  title "New title"  # 修改笔记标题

删除笔记

joplin rmnote             # 删除笔记
joplin rmbook "Notebook Name"      # 删除笔记本

在笔记本之间移动笔记

joplin mv "Note Title" "Target Notebook"

待办事项（Todos）

joplin todos                       # 列出所有待办事项
joplin todo               # 切换待办事项完成状态
joplin done               # 标记为已完成
joplin undone             # 标记为未完成

同步

joplin sync                        # 与 WebDAV 服务器同步

导出

joplin export  --format md
joplin export  --format html
joplin export  --format pdf

导入

joplin import /path/to/note.md --notebook "Notebook Name"

搜索

注意：joplin search 仅在 GUI 模式下可用。请改用 joplin ls 列出笔记本和笔记。

全部 Joplin 命令

attach, batch, cat, config, cp, done, e2ee, edit, export, geoloc, help, 
import, ls, mkbook, mknote, mktodo, mv, ren, restore, rmbook, rmnote, 
server, set, share, status, sync, tag, todo, undone, use, version

引用笔记与笔记本的方式

笔记或笔记本可通过以下方式引用：

• 标题："Note Title"
• ID：fe889（通过 joplin ls -l 获取）
• 快捷标识符：
  • $n — 当前选定的笔记
  • $b — 当前选定的笔记本
  • $c — 当前选定的项目

交互式 Shell 模式

Joplin 可以以交互式方式运行（类似 shell）。只需输入 joplin 即可启动：

joplin                          # 启动交互式模式

Shell 命令（需以 : 开头）

Shell 模式快捷键

• e — 编辑当前笔记
• i — 插入新笔记
• Space — 选择项目
• Enter — 打开笔记

示例工作流程

# 创建一个笔记本
joplin mkbook "My notebook"

# 切换至该笔记本
joplin use "My notebook"

# 创建一条笔记
joplin mknote "My note"

# 以含 ID 方式查看笔记列表
joplin ls -l

# 修改某条笔记的标题
joplin set  title "New title"

Kanban 笔记（YesYouKan 插件）

部分笔记本使用 YesYouKan kanban 插件实现可视化看板。此类笔记具有特定格式，在编辑时必须保留原格式：

Kanban 格式

# Notebook Name

# Backlog

## Task 1

Description here

## Task 2



# In progress

## Another Task

Details



# Done

## Completed Task

Result

```kanban-settings
# Do not remove this block

### ⚠️ Kanban 格式规范

YesYouKan 插件依赖特定格式。关键要点如下：

1. **kanban-settings 区块** — 笔记末尾的 `kanban-settings` 区块由插件使用，其格式必须严格保持，如上例所示。

2. **任务标题必须使用 `##`**（不可使用 `#`）

3. **列标题应使用 `# Backlog`、`# In progress`、`# Done`**

4. **任务之间需保留空行**，这些空行在 kanban 视图中可见

5. **编辑完 kanban 笔记后，必须执行 `joplin sync` 上传变更**

6. **使用 `joplin cat ` 验证变更结果**，确保格式正确

### 在不同列间移动任务

移动任务时，只需将对应的 `##` 任务区块整体从一列移至另一列即可。