joplin(1)
Joplin is a free, open-source note-taking and to-do application with synchronization and encryption capabilities.
Synopsis
joplin [COMMAND] [OPTIONS]Description
Joplin is a note-taking application that stores notes in markdown format. It supports synchronization across devices via cloud services (Nextcloud, OneDrive, Dropbox, etc.), end-to-end encryption, tagging, and nested notebooks. The command-line interface allows creating, managing, and synchronizing notes from the terminal.
Notes and notebooks are organized hierarchically and can be searched by title or content. Joplin supports plugins, themes, and multiple export formats including HTML and PDF. Synchronization can be configured with various backend services for secure cloud storage.
Common options
| Flag | What it does |
|---|---|
--help | Display help information and available commands |
--version | Show Joplin version number |
--profile | Specify profile directory for configuration and data storage |
--log-level | Set logging level (debug, info, warn, error) |
--update-plugins | Update all installed plugins to latest versions |
Examples
Start Joplin in interactive command-line mode with a menu interface
joplinDisplay all notes with their IDs and titles in the current notebook
joplin note listCreate a new note titled 'My Shopping List' and open it in the editor
joplin note create 'My Shopping List'Show all available notebooks with their hierarchical structure
joplin notebook listSynchronize all notes with the configured cloud service
joplin syncConfigure Nextcloud as the synchronization backend (target 5)
joplin config set sync.target 5Open the note with ID 'abc123def456' in your default text editor
joplin note edit abc123def456Search for all notes containing the word 'budget'
joplin search 'budget'