joplin-cli

name: joplin-cli description: Joplin CLI operations (shell mode). Create, view, edit, and sync notes via CLI, suitable for scripting and automation. allowed-tools: Bash(joplin:) Bash(~/.local/bin/joplin:) homepage: https://joplinapp.org/help/apps/terminal/#shell-mode metadata: openclaw: requires: bins: [joplin]

Joplin CLI Skill

Operate Joplin directly from the command line, no API server needed.

Common Commands

# Notebook operations
joplin mkbook "Notebook Name"        # Create notebook
joplin use "Notebook Name"           # Switch current notebook
joplin ls /                          # List all notebooks
joplin ls -l                         # List notes in current notebook (with IDs)

# Note operations
joplin mknote "Title"                # Create note
joplin cat <id|title>                # View note content
joplin set <id> title "New Title"    # Modify title
joplin set <id> body "Content"       # Modify body
joplin edit <id>                     # Open in editor

# Sync
joplin sync                          # Sync to remote

Referencing Notes

By ID: joplin cat fe889
By title: joplin cat "My Note"
By $n for the currently selected note (TUI mode)

Notebook Commands

use - Switch Notebook

joplin use "Notebook Name"

Subsequent operations will be performed within this notebook.

ls - List Contents

joplin ls /              # List all notebooks
joplin ls                # List notes in current notebook
joplin ls -l             # Long format (ID, date, title)
joplin ls -t n           # Notes only
joplin ls -t t           # Todos only
joplin ls -n 10          # Limit count
joplin ls -s title       # Sort by title

rmbook - Delete Notebook

joplin rmbook "Notebook Name"
joplin rmbook -f "Notebook Name"  # Force delete without confirmation

Note Commands

mktodo - Create Todo

joplin mktodo "Todo Item"

cat - View Note

joplin cat <id|title>
joplin cat -v <id>       # Full info (including metadata)

set - Set Properties

joplin set <id> title "New Title"
joplin set <id> body "Content"
joplin set <id> is_todo 1            # Convert to todo
joplin set <id> todo_due 1640000000  # Set due date (Unix timestamp)

Common properties:

title - Title
body - Body text
parent_id - Parent notebook ID
is_todo - Whether it is a todo (0/1)
todo_due - Todo due date
todo_completed - Completion time

edit - Edit Note

joplin edit <id>

Opens with the configured editor (auto-detected by default).

rmnote - Delete Note

joplin rmnote <id|title>
joplin rmnote -f <id>    # Force delete

Move and Copy

mv - Move Note

joplin mv <note> <target_notebook>
joplin mv "My Note" "Work"

cp - Copy Note

joplin cp <note> <target_notebook>

ren - Rename

joplin ren <note_or_notebook> "New Name"

Todo Operations

done / undone

joplin done <id>         # Mark as completed
joplin undone <id>       # Mark as not completed

toggle / clear

joplin toggle <id>       # Toggle completion status
joplin clear <id>        # Convert to regular note

Miscellaneous

status - Status

joplin status              # Show note and notebook statistics

attach - Attachments

joplin attach <note> /path/to/file

geoloc - Geolocation

joplin geoloc <note>       # Show map link for a note