joplin

open-source note-taking application supporting Markdown

TLDR

Start Joplin terminal app

$ joplin

Create a new note

$ joplin mknote "[Note Title]"

Create a new notebook

$ joplin mkbook "[Notebook Name]"

List all notebooks

$ joplin ls /

List notes in a notebook

$ joplin ls [notebook]

Edit a note in your text editor

$ joplin edit "[note title]"

Search for notes

$ joplin search "[query]"

Sync with cloud storage

$ joplin sync

Add a tag to a note

$ joplin tag add "[tag]" "[note title]"

Joplin is an open-source note-taking application supporting Markdown. The terminal version provides command-line access to notes, complementing the desktop and mobile apps.Joplin supports end-to-end encryption, sync via Nextcloud/Dropbox/OneDrive/Joplin Cloud, and import from Evernote. Notes are stored in Markdown format and can be tagged and organized into notebooks.

PARAMETERS

mknote title

Create new note.

mkbook name

Create new notebook.

ls [path]

List notebooks or notes.

edit note

Edit note in editor.

cat note

Display note content.

rmnote note

Delete note.

mv note notebook

Move note.

sync

Synchronize with cloud.

tag command [tag] [note]

Manage tags (add, remove, list, notetags).

search query

Search notes.

import path [notebook]

Import data (supports md, jex, enex formats).

export path

Export data (supports jex, md, raw, md_frontmatter formats).

ren item name

Rename a note or notebook.

cp note [notebook]

Duplicate a note to a notebook.

mktodo title

Create a new to-do item.

done note

Mark a to-do as done.

undone note

Mark a to-do as not done.

config key [value]

Get/set configuration.

status

Display summary of notes and notebooks.

use notebook

Select default notebook.

SYNC CONFIGURATION

$ joplin config sync.target 2 # Nextcloud
joplin config sync.2.path "https://..."
joplin config sync.2.username "user"

CAVEATS

Terminal version lacks some GUI features. Sync requires configuration. First sync may take time. Conflicts possible with simultaneous edits.

HISTORY

Joplin was created by Laurent Cozic in 2017 as an open-source Evernote alternative. It emphasizes privacy with end-to-end encryption and local-first storage.