/install joplin-notes
Joplin Notes Skill
This skill provides programmatic access to a Joplin database synchronized via WebDAV.
How it Works
Joplin stores notes and notebooks as .md files in a flat directory. They are linked via metadata at the end of the file (id, parent_id, type_).
- Title: The first line of the file is the title of the note or notebook.
- Notebook: A special file type (
type_: 2) that serves as a container for notes. - Note: A standard file (
type_: 1) assigned to a notebook viaparent_id.
Available Scripts
The scripts are located in scripts/ and require the following environment variables:
JOPLIN_PASSWORD: The password for WebDAV access.JOPLIN_ACCOUNT: The username for Joplin (e.g.,openclaw).JOPLIN_WEBDAV_PATH: The full path to the Joplin directory on the WebDAV server.
1. List Notes (list_notes.py)
Outputs the entire structure of notebooks and their contained notes.
- Usage:
python3 scripts/list_notes.py
2. Get Note Content (get_note.py)
Reads the content of a specific note by its ID.
- Usage:
python3 scripts/get_note.py \x3Cnote_id>
3. Upsert Note/Notebook (upsert_note.py)
Updates an existing note or creates a new one. Supports notebooks via the type parameter.
- Usage:
python3 scripts/upsert_note.py \x3Cnote_id|new> \x3Cparent_id> \x3Ccontent_file> [type (1=note, 2=notebook)]
4. Create Notebook (create_notebook.py)
Creates a new notebook.
- Usage:
python3 scripts/create_notebook.py \x3Ctitle> [parent_notebook_id]
Workflow Examples
Query Structure
exec("python3 /home/openclaw/.openclaw/workspace/skills/joplin-notes/scripts/list_notes.py")- Analyze the output to find the desired
note_idornotebook_id.
Read Note Content
exec("python3 /home/openclaw/.openclaw/workspace/skills/joplin-notes/scripts/get_note.py \x3Cnote_id>")
Edit or Create Note
- Download the current content with
get_note.py(if editing). - Create a temporary file with the new content (include the title in the first line).
- Call
upsert_note.py.
- 确保已安装 OpenClaw(本地或 Docker 部署)
- 在对话框中输入安装命令:
/install joplin-notes - 安装完成后,直接呼叫该 Skill 的名称或使用
/joplin-notes触发 - 根据 Skill 的参数说明提供必要输入,即可获得结构化输出
Joplin Notes 是什么?
Interface for managing Joplin notes via WebDAV. Allows listing notebooks and notes, reading content (first line = title), and creating or updating notes and... 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件,目前累计下载 115 次。
如何安装 Joplin Notes?
在 OpenClaw 或 Claude Code 对话框中运行命令「/install joplin-notes」即可一键安装,无需额外配置。
Joplin Notes 是免费的吗?
是的,Joplin Notes 完全免费,采用 MIT-0 许可证,可自由下载、安装和使用。
Joplin Notes 支持哪些平台?
Joplin Notes 跨平台运行,可在任意部署了 OpenClaw / Claude Code 的环境中使用(cross-platform)。
谁开发了 Joplin Notes?
由 Martin004(@martin004)开发并维护,当前版本 v1.0.0。