Joplin Cli
/install joplin-notes-pro
Joplin CLI Skill
Comprehensive Joplin notes management with wrapper scripts, templates, and automation workflows.
Features
- Full Joplin CLI Integration – Direct access to all Joplin commands
- Wrapper Scripts – Pre-built scripts for common workflows
- Templates – Daily journals, meeting notes, project updates
- Error Handling – Robust installation and configuration checks
- Multi-language – German and English support
- Integration Ready – Works with Gmail, Calendar, Web Fetch skills
Prerequisites
-
Joplin CLI installed globally:
npm install -g joplin -
Joplin configured (optional but recommended for sync):
joplin config sync.target 10 # Joplin Cloud joplin config sync.10.username [email protected] joplin config sync.10.password your-password
Quick Start
1. Check Joplin Installation
./scripts/joplin-check.sh health
2. Create a Quick Note
./scripts/joplin-quick-note.sh "My First Note" "This is my first note."
3. Create Daily Journal
./scripts/joplin-daily-journal.sh
Available Scripts
| Script | Description | Usage |
|---|---|---|
joplin-check.sh |
Health check and installation verification | ./joplin-check.sh health |
joplin-quick-note.sh |
Create notes with tags and notebooks | ./joplin-quick-note.sh "Title" "Content" -t tag1,tag2 |
joplin-daily-journal.sh |
Daily journal with templates | ./joplin-daily-journal.sh --template daily |
joplin-search-notes.sh |
Advanced note search with filters | ./joplin-search-notes.sh "query" -t tag -f json |
joplin-meeting-notes.sh |
Meeting notes with templates | ./joplin-meeting-notes.sh "Meeting" -a "Alice,Bob" |
joplin-integration-starter.sh |
Setup integrations with other skills | ./joplin-integration-starter.sh --list |
joplin-export-backup.sh |
Backup all notes | In development |
joplin-meeting-notes.sh |
Meeting notes template | Coming soon |
Joplin CLI Quick Reference
Basic Commands
| Command | Description |
|---|---|
joplin |
Start interactive REPL |
ls |
List notes and notebooks |
ls \x3Cnotebook> |
List notes in a notebook |
cat \x3Cnote> |
Show note content |
mknote \x3Ctitle> |
Create new note |
mkbook \x3Cname> |
Create new notebook |
edit \x3Cnote> |
Open note in $EDITOR |
rmnote \x3Cnote> |
Delete a note |
rmbook \x3Cnotebook> |
Delete a notebook |
mv \x3Cnote> \x3Cnotebook> |
Move note to notebook |
cp \x3Cnote> \x3Cnotebook> |
Copy note to notebook |
ren \x3Citem> \x3Cnew-name> |
Rename note or notebook |
Tag Management
| Command | Description |
|---|---|
tag |
List all tags |
tag \x3Ctag> \x3Cnote> |
Add tag to note |
tag --remove \x3Ctag> \x3Cnote> |
Remove tag |
Sync & Status
| Command | Description |
|---|---|
sync |
Sync with Joplin Cloud/server |
todo |
List all to-dos |
mktodo \x3Ctitle> |
Create a to-do item |
done \x3Ctodo> |
Mark to-do as done |
undone \x3Ctodo> |
Mark to-do as not done |
status |
Show sync status |
config |
Show/change configuration |
Import/Export
| Command | Description |
|---|---|
export \x3Cpath> |
Export all notes |
import \x3Cpath> |
Import notes |
version |
Show Joplin version |
Workflow Examples
Daily Journal Routine
# Create today's journal
./scripts/joplin-daily-journal.sh
# Review yesterday's journal
joplin cat "Journal $(date -d 'yesterday' +'%Y-%m-%d')"
# Sync to cloud
joplin sync
Advanced Search
# Search notes with filters
./scripts/joplin-search-notes.sh "project meeting" -t work -n Projects
# Export search results to JSON
./scripts/joplin-search-notes.sh "important OR urgent" -f json -o results.json
# Search with date filters
./scripts/joplin-search-notes.sh "updated:2026-03" -s created -r
Automated Backups
# Daily backup with encryption
./scripts/joplin-export-backup.sh --sync-first --encrypt --password "secret"
# Test backup without actually exporting
./scripts/joplin-export-backup.sh --test
# Backup to specific directory
./scripts/joplin-export-backup.sh /mnt/backup/joplin --keep-days 7
Meeting Notes
# Create meeting notes with template
./scripts/joplin-daily-journal.sh --template meeting --title "Team Meeting"
# Add action items
joplin edit "Team Meeting"
Quick Capture
# Quick note with tags
./scripts/joplin-quick-note.sh "Project Idea" "Build a new dashboard" -t "ideas,projects"
# From stdin
echo "Remember to call client" | ./scripts/joplin-quick-note.sh "Reminder"
Integration with Other Skills
Gmail → Joplin
# Save important emails as notes
# (Combine with gog skill)
Calendar → Joplin
# Create notes from calendar events
# (Combine with gog calendar skill)
Web Fetch → Joplin
# Save web articles as notes
web_fetch --url https://example.com --extract-mode markdown | \
./scripts/joplin-quick-note.sh "Web Article" "$(cat -)" "web,research"
Configuration
Environment Variables
export JOPLIN_DEFAULT_NOTEBOOK="Inbox"
export JOPLIN_DEFAULT_TAGS="todo,important"
export JOPLIN_JOURNAL_NOTEBOOK="Journal"
export JOPLIN_JOURNAL_TAGS="journal,daily"
export JOPLIN_DATE_FORMAT="%Y-%m-%d"
export EDITOR="code --wait"
Joplin Configuration for Scripts
# Optimize for CLI usage
joplin config cli.disablePrompts true
joplin config cli.suppressTui true
joplin config editor "$EDITOR"
Troubleshooting
Joplin Not Found
Error: Joplin CLI not found
Solution:
npm install -g joplin
Sync Errors
Error: Sync failed
Solution:
joplin config --list | grep sync
joplin sync --test
Permission Issues
Error: Cannot write to Joplin data directory
Solution:
chmod 755 ~/.config/joplin/
Tips & Best Practices
- Always Sync – Run
joplin syncafter making changes - Use Tags – Tag notes for better organization
- Regular Backups – Export notes periodically
- Notebook Structure – Organize by project, area, or context
- Template Consistency – Use consistent templates for similar notes
References
references/joplin-config-example.md– Configuration examplesreferences/common-workflows.md– Common workflows- Joplin Documentation – Official docs
- ClawHub Skills – More skills
Development
Project Structure
joplin-cli/
├── SKILL.md # This file
├── README.md # ClawHub README
├── package.json # ClawHub metadata
├── scripts/ # Wrapper scripts
│ ├── joplin-check.sh # Health check
│ ├── joplin-quick-note.sh # Quick notes
│ └── joplin-daily-journal.sh # Daily journals
└── references/ # Examples & configuration
Adding New Scripts
- Create script in
scripts/directory - Include error handling with
joplin-check.sh - Document in README.md and SKILL.md
- Test with real Joplin installation
License
MIT License – See LICENSE file.
Happy Note-Taking! 📝
- 确保已安装 OpenClaw(本地或 Docker 部署)
- 在对话框中输入安装命令:
/install joplin-notes-pro - 安装完成后,直接呼叫该 Skill 的名称或使用
/joplin-notes-pro触发 - 根据 Skill 的参数说明提供必要输入,即可获得结构化输出
Joplin Cli 是什么?
Comprehensive Joplin notes management via CLI with wrapper scripts, templates, and automation. Use when creating, reading, editing, syncing, or organizing no... 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件,目前累计下载 135 次。
如何安装 Joplin Cli?
在 OpenClaw 或 Claude Code 对话框中运行命令「/install joplin-notes-pro」即可一键安装,无需额外配置。
Joplin Cli 是免费的吗?
是的,Joplin Cli 完全免费,采用 MIT-0 许可证,可自由下载、安装和使用。
Joplin Cli 支持哪些平台?
Joplin Cli 跨平台运行,可在任意部署了 OpenClaw / Claude Code 的环境中使用(cross-platform)。
谁开发了 Joplin Cli?
由 Waltraud by joerg - Human-AI Collaboration(@joergbot-cloud)开发并维护,当前版本 v1.0.1。